66 lines
1.8 KiB
Markdown
66 lines
1.8 KiB
Markdown
# 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 [the go programming language](https://go.dev)
|
|
|
|
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:
|
|
-fr duration
|
|
update frequency (default 1m0s)
|
|
-min string
|
|
minimum version we care for (default "0.9.3")
|
|
-num int
|
|
number of issues to retrieve at once (default 250)
|
|
-port string
|
|
[ip]:port to serve (default ":8080")
|
|
-project int
|
|
project id to use (default 23)
|
|
-token string
|
|
API-Token (default "")
|
|
-url string
|
|
URL to the issues (default "https://bugs.gnunet.org/api/rest")
|
|
```
|
|
|
|
**Note**: We assume that this service runs behind a reverse-proxy which deals
|
|
and terminates TLS.
|
|
|
|
## License
|
|
|
|
taler-dashboard is free software: you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option) any later
|
|
version.
|
|
|
|
taler-dashboard is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You can receive a copy of the GNU General Public License from
|
|
<https://www.gnu.org/licenses/>.
|