simono41/fail2ban-prometheus-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update readme with latest changes (!86)

Browse source 
Update `README` to reflect recent changes in the project build process.

https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/merge_requests/86
This commit is contained in:
Hector 2023-06-20 16:34:25 +00:00
parent 30b92d61da
commit f1e69fc4da
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -22,7 +22,7 @@ The following command will start collecting metrics from the `/var/run/fail2ban/
``` ```
$ fail2ban_exporter --collector.f2b.socket=/var/run/fail2ban/fail2ban.sock --web.listen-address=":9191" $ fail2ban_exporter --collector.f2b.socket=/var/run/fail2ban/fail2ban.sock --web.listen-address=":9191"
2022/02/20 09:54:06 fail2ban exporter version 0.5.0 2022/02/20 09:54:06 fail2ban exporter version 0.8.1
2022/02/20 09:54:06 starting server at :9191 2022/02/20 09:54:06 starting server at :9191
2022/02/20 09:54:06 reading metrics from fail2ban socket: /var/run/fail2ban/fail2ban.sock 2022/02/20 09:54:06 reading metrics from fail2ban socket: /var/run/fail2ban/fail2ban.sock
2022/02/20 09:54:06 metrics available at '/metrics' 2022/02/20 09:54:06 metrics available at '/metrics'
@ -55,7 +55,7 @@ services:
- "9191:9191" - "9191:9191"
``` ```
Use the `:latest` tag to get the latest stable release. Or use the `:nightly` tag for the latest (unstable) version. Use the `:latest` tag to get the latest stable release.
See the [registry page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/container_registry) for all available tags. See the [registry page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/container_registry) for all available tags.
**NOTE:** While it is possible to mount the `fail2ban.sock` file directly, it is recommended to mount the parent folder instead. **NOTE:** While it is possible to mount the `fail2ban.sock` file directly, it is recommended to mount the parent folder instead.
@ -149,12 +149,13 @@ If both are specified, the CLI flag takes precedence.
## 4. Building from source ## 4. Building from source
The simplest way to build the project is to run the `build/snapshot` make command. Building from source has the following dependencies:
This will use `goreleaser` to build out binaries and archives for the project. - Go v1.20
Binaries are stored in the `dist/` folder. - Make
Alternatively, `go mod download` and `go build` can be used from the `src/` folder to build out the project. From there, simply run `make build`
This will download dependencies and build the project.
This will download the necessary dependencies and build a `fail2ban_exporter` binary in the root of the project.
## 5. Textfile metrics ## 5. Textfile metrics