jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update pi_hole docs for 0.99 (#10415)

Browse Source 
* Update pi_hole docs for 0.99

* Code review changes

* Update source/_components/pi_hole.markdown

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
John Luetke 2019-09-22 11:31:05 -07:00 committed by Franck Nijhof
parent f2b8ace4fa
commit 2bb2d475c9
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/_components/pi_hole.markdown
View File

@ -10,11 +10,11 @@ redirect_from:
- /components/sensor.pi_hole/ - /components/sensor.pi_hole/
--- ---
The `pi_hole` integration allows you to retrieve and display statistics from a [Pi-hole](https://pi-hole.net/) system. The `pi_hole` integration allows you to retrieve and display statistics from a single [Pi-hole](https://pi-hole.net/) system.
## Configuration ## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: To enable this integration with the default configuration, add the following lines to your `configuration.yaml` file
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -23,10 +23,15 @@ pi_hole:
{% configuration %} {% configuration %}
host: host:
description: IP address of the host where Pi-hole is running. description: >
The hostname (and port), e.g. '192.168.0.3:4685' of the host where Pi-hole is running.
**Note:** If your Pi-Hole instance is the Hass.io add-on, you *must* specify port `4685`.
required: false required: false
type: string type: string
default: pi.hole default: pi.hole
location: location:
description: The installation location of the Pi-hole API. description: The installation location of the Pi-hole API.
required: false required: false
@ -49,7 +54,9 @@ verify_ssl:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
pi_hole: pi_hole:
host: IP_ADDRESS host: 'localhost:4685'
ssl: false
verify_ssl: false
``` ```
This integration was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC. This integration was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC.