Skip to content

Commit ca1d533

Browse files
committed
set doc for bitwarden and Prometheus Auth
1 parent e095984 commit ca1d533

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,38 @@ metrics are fetched from your existing Prometheus backend and displayed on the c
55

66
configure your relevant metrics in [metrics.json](metrics.json), download the binary from the [Release page](https://github.com/eumel8/cluster-app/releases) and start the program in the same directory where the metric.json exists.
77

8-
point `PROMETHEUS_URL` env to your Prometheus backend, i.e. `http://prometheus.example.com:9090`
8+
point `PROMETHEUS_URL` env to your Prometheus backend, i.e.
9+
10+
```
11+
export PROMETHEUS_URL=http://prometheus.example.com:9090
12+
```
13+
14+
optional set `PULL_DURATION` to another value in seconds to pull new metrics (default: 60), i.e.
15+
16+
```
17+
export PULL_DURATION=10
18+
```
919

1020
start the program and enjoy
1121

12-
## Vulkan driver in WSL
22+
## Vulkan driver in WSL (optional)
1323

1424
```
1525
sudo apt install vulkan-tools
1626
```
1727

18-
## Bitwarden version
28+
## Prometheus Auth
29+
30+
If you protect your Prometheus endpoint with authentication, you can set env var for username and password:
31+
32+
```
33+
export PROM_USER=xxxx
34+
export PROM_PASS=xxxx
35+
```
36+
37+
## Bitwarden feature
38+
39+
Start the programm with `-bw`.
1940

2041
In this version the programm expect an item on a Bitwarden service containing username/password for HTTP Basic Auth on
2142
Prometheus API

0 commit comments

Comments
 (0)