updated readme

main
"Riku" 2024-05-26 17:52:53 +03:00
parent 4ecc83f7ea
commit 936dcde75c
1 changed files with 10 additions and 2 deletions

View File

@ -1,7 +1,15 @@
# Grafana exporter for ZTE 5G modems
Howto? To just run, either run with docker run or use the provided compose.yml for docker composing.
## Getting started
One can just run the provided python script by `python3 zte_exporter <port> <router ip> <admin username> <admin password>`
A docker file is provided to compile this and example compose.yml to use in compose tools. To use with docker run, just create .env with the correct values. dockerhub vvkvvk/zte-exporter has the latest version of this available.
## Tested devices
Probably works with other ZTE models, only tested with ZTE MC7010. A simple Grafana dashboard included with the grafana.json.
Based on work by https://github.com/Kajkac/ZTE-MC-Home-assistant
## Thanks
Largely based on https://github.com/Kajkac/ZTE-MC-Home-assistant