From 1d21e63c666460cdce99c48b03ae6f253e329077 Mon Sep 17 00:00:00 2001 From: Hector Date: Sun, 19 Jun 2022 08:13:19 +0100 Subject: [PATCH] update readme Update the README file with the new configuration CLI flag and env variable. --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b55199d..954cd44 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ There are no configuration files. **CLI flags** ``` -usage: fail2ban_exporter [] +usage: exporter [] Flags: -h, --help Show context-sensitive help (also try --help-long and --help-man). @@ -127,6 +127,8 @@ Flags: username to use to protect endpoints with basic auth --web.basic-auth.password="" password to use to protect endpoints with basic auth + --collector.f2b.exit-on-socket-connection-error + when set to true the exporter will immediately exit on a fail2ban socket connection error ``` **Environment variables** @@ -134,13 +136,14 @@ Flags: Each environment variable corresponds to a CLI flag. If both are specified, the CLI flag takes precedence. -| Environment variable | Corresponding CLI flag | -|---------------------------|----------------------------------| -| `F2B_COLLECTOR_SOCKET` | `--collector.f2b.socket` | -| `F2B_COLLECTOR_TEXT_PATH` | `--collector.textfile.directory` | -| `F2B_WEB_LISTEN_ADDRESS` | `--web.listen-address` | -| `F2B_WEB_BASICAUTH_USER` | `--web.basic-auth.username` | -| `F2B_WEB_BASICAUTH_PASS` | `--web.basic-auth.password` | +| Environment variable | Corresponding CLI flag | +|----------------------------|---------------------------------------------------| +| `F2B_COLLECTOR_SOCKET` | `--collector.f2b.socket` | +| `F2B_COLLECTOR_TEXT_PATH` | `--collector.textfile.directory` | +| `F2B_WEB_LISTEN_ADDRESS` | `--web.listen-address` | +| `F2B_WEB_BASICAUTH_USER` | `--web.basic-auth.username` | +| `F2B_WEB_BASICAUTH_PASS` | `--web.basic-auth.password` | +| `F2B_EXIT_ON_SOCKET_ERROR` | `--collector.f2b.exit-on-socket-connection-error` | ## 4. Building from source