feat: added README

Signed-off-by: Louis Vallat <louis@louis-vallat.xyz>
This commit is contained in:
Louis Vallat 2022-07-02 16:17:36 +02:00
parent fff9233d81
commit 11bd6e3858
No known key found for this signature in database
GPG Key ID: 0C87282F76E61283

33
README.md Normal file
View File

@ -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.