Cleaned up README.md
This commit is contained in:
10
README.md
10
README.md
@@ -1,13 +1,15 @@
|
|||||||
# fritzbox_exporter
|
# fritzbox_exporter
|
||||||
|
|
||||||
|
(C)2022 M. Konstapel https://www.meezenest.nl/mees
|
||||||
|
|
||||||
Collects data from FRITZ!Box via its SOAP api and exports it to Prometheus via http.
|
Collects data from FRITZ!Box via its SOAP api and exports it to Prometheus via http.
|
||||||
|
|
||||||
The program is split up into two parts:
|
The program is split up into two parts:
|
||||||
|
|
||||||
## Bash script
|
## Bash script
|
||||||
Collects various information from your FRITZ!Box via its SOAP api. It outputs the data to stdout in JSON format.
|
Collects various information from a FRITZ!Box via its SOAP api. It outputs the data to stdout in JSON format.
|
||||||
|
|
||||||
It can also be used from the command line. Script can output:
|
It can also be used from the command line to get the following data:
|
||||||
|
|
||||||
- link uptime
|
- link uptime
|
||||||
- connection status
|
- connection status
|
||||||
@@ -54,7 +56,7 @@ functions:
|
|||||||
Example: fritz-api.sh -f downstream -h 192.168.100.1 -b m
|
Example: fritz-api.sh -f downstream -h 192.168.100.1 -b m
|
||||||
```
|
```
|
||||||
|
|
||||||
### Dependancies
|
### Dependencies
|
||||||
|
|
||||||
- curl
|
- curl
|
||||||
- bc
|
- bc
|
||||||
@@ -93,7 +95,7 @@ port: 9001
|
|||||||
scrape_frequency: 60
|
scrape_frequency: 60
|
||||||
```
|
```
|
||||||
|
|
||||||
### Dependancies
|
### Dependencies
|
||||||
|
|
||||||
- Python 3
|
- Python 3
|
||||||
- subprocess
|
- subprocess
|
||||||
|
Reference in New Issue
Block a user