update readme with environment variables

This commit is contained in:
Hector 2022-01-30 21:27:29 +00:00
parent 94db2ec3de
commit 0c054f9c2c

View File

@ -35,7 +35,7 @@ No additional runtime dependencies are required.
Compiled binaries for various platforms are provided in each release. Compiled binaries for various platforms are provided in each release.
See the [releases page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/releases) for more information. See the [releases page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/releases) for more information.
**Usage** **CLI Usage**
``` ```
$ fail2ban-prometheus-exporter -h $ fail2ban-prometheus-exporter -h
usage: exporter [<flags>] usage: exporter [<flags>]
@ -56,6 +56,20 @@ Flags:
password to use to protect endpoints with basic auth password to use to protect endpoints with basic auth
``` ```
**Environment variables**
The tool can also be configured using environment variables. Each CLI parameter has a corresponding environment variable.
```
F2B_COLLECTOR_SOCKET
F2B_COLLECTOR_TEXT
F2B_COLLECTOR_TEXT_PATH
F2B_WEB_PORT
F2B_WEB_LISTEN_ADDRESS
F2B_WEB_BASICAUTH_USER
F2B_WEB_BASICAUTH_PASS
```
**Example** **Example**
``` ```