add docs for prometheus env variables

This commit is contained in:
Jonas Leder 2024-12-06 22:01:22 +01:00
commit b49cc6f729
2 changed files with 6 additions and 0 deletions

View file

@ -34,6 +34,9 @@ PVE_IGNORE_SSL=true
GIN_MODE=release
TLS_CERT=
TLS_KEY=
PROMETHEUS_METRICS=false
PROMETHEUS_AUTH_USERNAME=prometheus
PROMETHEUS_AUTH_PASSWORD=password
```
When using systemd you can cop the example `vncproxy.service` file from this repo and place it in `/etc/systemd/system`. After setting the correct environment variables and the path to the binary you can enable the service using the following commands:

View file

@ -8,6 +8,9 @@ services:
JWT_SIGN_KEY: "" # The secret key from Hostware
TLS_CERT: "" # Path to the SSL certificate ( optional, otherwise http will be used, path needs to be mapped in the container)
TLS_KEY: ""
PROMETHEUS_METRICS: false # Optional variable to enable prometheus metrics at /metrics
PROMETHEUS_AUTH_USERNAME: prometheus # Optional basic auth for prometheus endpoint
PROMETHEUS_AUTH_PASSWORD: password
restart: alwys
ports:
- 8080:8080