xsteadfastx/iperf3exporter
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(readme): add installation instructions
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Marvin Preuss 2021-10-20 17:30:08 +02:00
parent 3b4b62c0db
commit 822b2c94ee
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,6 +9,22 @@ A iperf3 speedtest exporter for prometheus
It runs the `iperf3` command as client. Once as server sends/client receives and once as client sends/server receives. It parses the JSON output and exports them as prometheus metrics. It runs the `iperf3` command as client. Once as server sends/client receives and once as client sends/server receives. It parses the JSON output and exports them as prometheus metrics.
## Installation
### via docker
```shell
docker run -d --name iperf3exporter ghcr.io/xsteadfastx/iperf3exporter:0.1.1
```
### via package
You can get `apt`, `rpm` and `apk` packages on the [release page](https://github.com/xsteadfastx/iperf3exporter/releases). They also include an init file.
### via archive
For easy testing you can download the `tar.gz`-archive from the [release page](https://github.com/xsteadfastx/iperf3exporter/releases), extract it and run it.
## Usage ## Usage
```shell ```shell