Cleaned up README.md

This commit is contained in:
2022-06-24 10:45:57 +02:00
parent b2de356334
commit 6bc3c807b7

View File

@@ -1,13 +1,15 @@
# 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.
The program is split up into two parts:
## 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
- connection status
@@ -54,7 +56,7 @@ functions:
Example: fritz-api.sh -f downstream -h 192.168.100.1 -b m
```
### Dependancies
### Dependencies
- curl
- bc
@@ -93,7 +95,7 @@ port: 9001
scrape_frequency: 60
```
### Dependancies
### Dependencies
- Python 3
- subprocess