volker.raschek/prometheus-fail2ban-exporter
1
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

tweak readme file

Browse Source
This commit is contained in:
Hector 2022-02-20 16:18:02 +00:00
parent 7899e4db25
commit 8cb2b1fe50
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,7 +6,7 @@ Collect metrics from a running fail2ban instance.
1. Quick Start 1. Quick Start
2. Metrics 2. Metrics
3. Configuration 3. Configuration
4. Building 4. Building from source
5. Textfile metrics 5. Textfile metrics
## 1. Quick Start ## 1. Quick Start
@ -126,7 +126,7 @@ Flags:
Each environment variable corresponds to a CLI flag. Each environment variable corresponds to a CLI flag.
If both are specified, the CLI flag takes precedence. 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_SOCKET` | `--collector.f2b.socket` |
| `F2B_COLLECTOR_TEXT_PATH` | `--collector.textfile.directory` | | `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_USER` | `--web.basic-auth.username` |
| `F2B_WEB_BASICAUTH_PASS` | `--web.basic-auth.password` | | `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. The simplest way to build the project is to run the `build/snapshot` make command.
Go version `1.15` or greater is required. 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 ## 5. Textfile metrics