From 1cb85d4764a1faec42cc78f8142dd7d9026cd2df Mon Sep 17 00:00:00 2001 From: Riku Date: Tue, 21 Jan 2025 13:55:23 +0200 Subject: [PATCH] Update readme.md --- readme.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 38dbf08..07a66df 100644 --- a/readme.md +++ b/readme.md @@ -5,13 +5,10 @@ One can just run the provided python script by `python3 zte_exporter.py ` The script accepts following options -- --port -- --username -- --device -- --reset yes/anything - -Port tells on what port the HTTP server will serve the metrics. Path to the metrics is just / -Username is the username used with the device. This defaults to admin. If device type is set to MC7010 which doesn't use username, it'll be ignored. On MC889A just use default (generic) +- `--port ` port whereupon the HTTP service serves the metrics +- `--username ` username used for MULTI login (username/password login instead of just password) +- `--device ` device type, valid choices are mc7010, dictates the RD key hash and login method (MULTI vs SINGLE) +- `--reset yes/anything` TR069 reset, see below ## TR069 reset? @@ -19,11 +16,11 @@ You can safely ignore everything else, and just use the script with --reset to c ## Docker? -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 outdated version of this available and should not be used. A compose.yml file is provided as example. +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. A compose.yml file is provided as example. There's no current version image available on docker hub as I'm lazy and use systemd jobbie instead. ## Prometheus configuration -A simple scrape config will suffice. Scrape interval will dicatete how often data is fetch. +A simple scrape config will suffice. Scrape interval will dicatete how often data is fetch. The path to metrics is root /. ``` - job_name: 'zte'