From 0c054f9c2c897b7e2eaf0a353539b800ffdcc315 Mon Sep 17 00:00:00 2001 From: Hector Date: Sun, 30 Jan 2022 21:27:29 +0000 Subject: [PATCH] update readme with environment variables --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b0d806d..2a2cc8a 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ No additional runtime dependencies are required. 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. -**Usage** +**CLI Usage** ``` $ fail2ban-prometheus-exporter -h usage: exporter [] @@ -56,6 +56,20 @@ Flags: 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** ```