Browse Source

Added section on Authentication

Christopher Nethercott 3 years ago
parent
commit
4a3bf58b84
1 changed files with 8 additions and 2 deletions
  1. 8 2
      README.md

+ 8 - 2
README.md

@@ -3,7 +3,6 @@
 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.
 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).
 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
 ## Setup
 ### Configuring the script
 ### Configuring the script
 The InfluxDB connection settings can be configured as followed:
 The InfluxDB connection settings can be configured as followed:
@@ -15,6 +14,13 @@ The InfluxDB connection settings can be configured as followed:
 The PiHole settings can be configured as followed:
 The PiHole settings can be configured as followed:
 - PIHOLE_HOSTNAME=192.168.xxx.xxx
 - PIHOLE_HOSTNAME=192.168.xxx.xxx
 - PIHOLE_INTERVAL=15 *Interval in seconds*
 - PIHOLE_INTERVAL=15 *Interval in seconds*
+### Authentication
+Certain parts of the API require you to be authenticated, this can be achieved by supplying the `PIHOLE_AUTHENTICATION` token with the password you use to login to the web interface.  
+By doing this you'll gain access to two new measurements (tables): 
+- authenticated_query_types
+- authenticated_forward_destinations
+#### Sidenote
+This does mean that your password is stored in plaintext as an envronmental variable and as such as malicious actor could find it and access your PiHole instance. You are use this at your own risk.
 ### Docker Command
 ### Docker Command
 ```
 ```
     docker run -d --name pihole-to-influx \
     docker run -d --name pihole-to-influx \
@@ -29,7 +35,7 @@ The PiHole settings can be configured as followed:
 ```
 ```
 ### docker-compose
 ### docker-compose
 ```yaml
 ```yaml
-version: "3"
+version: '3'
 services:
 services:
     pihole-to-influxdb:
     pihole-to-influxdb:
         image: chriscn/pihole-to-influxdb
         image: chriscn/pihole-to-influxdb