From 8cb2b1fe5085ec16d7216f75221ce764e19f5c03 Mon Sep 17 00:00:00 2001 From: Hector Date: Sun, 20 Feb 2022 16:18:02 +0000 Subject: [PATCH] tweak readme file --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c195e1f..89871d4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Collect metrics from a running fail2ban instance. 1. Quick Start 2. Metrics 3. Configuration -4. Building +4. Building from source 5. Textfile metrics ## 1. Quick Start @@ -126,7 +126,7 @@ Flags: Each environment variable corresponds to a CLI flag. If both are specified, the CLI flag takes precedence. -| Environment variable | CLI flag | +| Environment variable | Corresponding CLI flag | |---------------------------|----------------------------------| | `F2B_COLLECTOR_SOCKET` | `--collector.f2b.socket` | | `F2B_COLLECTOR_TEXT_PATH` | `--collector.textfile.directory` | @@ -134,12 +134,14 @@ If both are specified, the CLI flag takes precedence. | `F2B_WEB_BASICAUTH_USER` | `--web.basic-auth.username` | | `F2B_WEB_BASICAUTH_PASS` | `--web.basic-auth.password` | -## 4. Building +## 4. Building from source -The code can be compiled from source by running `go build` inside the `src/` folder. -Go version `1.15` or greater is required. +The simplest way to build the project is to run the `build/snapshot` make command. +This will use `goreleaser` to build out binaries and archives for the project. +Binaries are stored in the `dist/` folder. -Run `go mod download` to download all necessary dependencies before running the build. +Alternatively, `go mod download` and `go build` can be used from the `src/` folder to build out the project. +This will download dependencies and build the project. ## 5. Textfile metrics