aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a8cf50f91eaba4a66a8b8e97ffc29811b01a9008 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# taler-dashboard

A dashboard for the GNU Taler project, giving an overview about the state of the
development.

This is **alpha** software.

It is written in go and compiles into a standalone program with all templates as embedded
components.

## Compilation

To compile, you need the latest version of [https://go.dev](the go programming language)

Then, simple download the code from this repository and compile it:

```
git clone https://git.kesim.org/taler/taler-dashboard
cd taler-dashboard
go build
```

## Mantis API-Token

You need an API-token to be able to access the REST-API of https://bugs.taler.net.
The token can be provided via the environment variable `MANTIS_API_TOKEN` or at
the commandline.

## Execution


```
Usage of ./taler-dashboard:
  -min string
    	minimum version we care for (default "0.9.3")
  -num int
    	number of issues to retrieve at once (default 100)
  -port string
    	[ip]:port to serve (default ":8080")
  -token string
    	API-Token (default "")
  -url string
    	URL to the issues (default "https://bugs.gnunet.org/api/rest/issues")
```

**Note**: We assume that this service runs behind a reverse-proxy which deals
and terminates TLS.