From 11bd6e38586ba296654278ab798942664d58dace Mon Sep 17 00:00:00 2001 From: Louis Vallat Date: Sat, 2 Jul 2022 16:17:36 +0200 Subject: [PATCH] feat: added README Signed-off-by: Louis Vallat --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5dc0718 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Livebox to InfluxDB connector + +> A Rust program to send data gathered using the Livebox API to a time series +> database: InfluxDB. + +To use this connector, just launch it using: + +```bash +cargo run --release +``` + +## Environment variable + +The different environment variables used to configure this program are: + +- `INFLUXDB_HOST`: the InfluxDB host +- `INFLUXDB_ORG`: the InfluxDB organization +- `INFLUXDB_TOKEN`: the InfluxDB access token +- `INFLUXDB_BUCKET`: the InfluxDB bucket +- `ROUTER_PASSWORD`: the password for the `admin` account +- `HOSTNAME`: used to differentiate one Livebox from another +- `LOOP_DELAY`: the time to wait between each data collection (default `60`) + +## Legal + +`Livebox` is a trademark owned by France Telecom and Orange, and is their +property. This software uses only the name as it is also the name of the internet +AP lent to Orange customers (at least in France). No intellectual property +infrigement intended. + +If there's any issue with the use of this name here, please don't hesitate to +contact me at my email address. +