Parcourir la source

Updated README.md

Christopher Nethercott il y a 3 ans
Parent
commit
190f9c4f46
1 fichiers modifiés avec 39 ajouts et 1 suppressions
  1. 39 1
      README.md

+ 39 - 1
README.md

@@ -1,7 +1,45 @@
 # pihole-to-influxdb
+## Introduction
 Based slightly on my other project, [speedtest-to-influxdb](https://github.com/chriscn/speedtest-to-influxdb). This project leverages the [Pi-Hole](https://pi-hole.net/) API to gather data about your PiHole instance and store it inside of InfluxDB for your future projects.
 
 This project is automatically built through GitHub actions and the DockerHub file can be found [here](https://hub.docker.com/r/chriscn/pihole-to-influxdb).
 
 ## Setup
-TODO Write.
+### Configuring the script
+The InfluxDB connection settings can be configured as followed:
+- INFLUX_DB_ADDRESS=192.168.xxx.xxx
+- INFLUX_DB_PORT=8086
+- INFLUX_DB_USER=user
+- INFLUX_DB_PASSWORD=pass
+- INFLUX_DB_DATABASE=pihole
+The PiHole settings can be configured as followed:
+- PIHOLE_HOSTNAME=192.168.xxx.xxx
+- PIHOLE_INTERVAL=15 *Interval in seconds*
+### Docker Command
+```
+    docker run -d --name pihole-to-influx \
+    -e 'INFLUX_DB_ADDRESS'='_influxdb_host_' \
+    -e 'INFLUX_DB_PORT'='8086' \
+    -e 'INFLUX_DB_USER'='_influx_user_' \
+    -e 'INFLUX_DB_PASSWORD'='_influx_pass_' \
+    -e 'INFLUX_DB_DATABASE'='pihole' \
+    -e 'PIHOLE_INTERVAL'='1800' \
+    -e 'PIHOLE_HOSTNAME'='192.168.xxx.xxx'  \
+    chriscn/pihole-to-influxdb
+```
+### docker-compose
+```yaml
+version: "3"
+services:
+    pihole-to-influxdb:
+        image: chriscn/pihole-to-influxdb
+        container_name: pihole-to-influxdb
+        environment:
+        - INFLUX_DB_ADDRESS=192.168.xxx.xxx
+        - INFLUX_DB_PORT=8086
+        - INFLUX_DB_USER=user
+        - INFLUX_DB_PASSWORD=pass
+        - INFLUX_DB_DATABASE=pihole
+        - PIHOLE_HOSTNAME=192.168.xxx.xxx
+        - PIHOLE_INTERVAL=15
+```