Skip to content

Commit 2bb2d47

Browse files
johnluetkefrenck
andcommitted
Update pi_hole docs for 0.99 (home-assistant#10415)
* Update pi_hole docs for 0.99 * Code review changes * Update source/_components/pi_hole.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl>
1 parent f2b8ace commit 2bb2d47

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

source/_components/pi_hole.markdown

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ redirect_from:
1010
- /components/sensor.pi_hole/
1111
---
1212

13-
The `pi_hole` integration allows you to retrieve and display statistics from a [Pi-hole](https://pi-hole.net/) system.
13+
The `pi_hole` integration allows you to retrieve and display statistics from a single [Pi-hole](https://pi-hole.net/) system.
1414

1515
## Configuration
1616

17-
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
17+
To enable this integration with the default configuration, add the following lines to your `configuration.yaml` file
1818

1919
```yaml
2020
# Example configuration.yaml entry
@@ -23,10 +23,15 @@ pi_hole:
2323
2424
{% configuration %}
2525
host:
26-
description: IP address of the host where Pi-hole is running.
26+
description: >
27+
The hostname (and port), e.g. '192.168.0.3:4685' of the host where Pi-hole is running.
28+
29+
30+
**Note:** If your Pi-Hole instance is the Hass.io add-on, you *must* specify port `4685`.
2731
required: false
2832
type: string
2933
default: pi.hole
34+
3035
location:
3136
description: The installation location of the Pi-hole API.
3237
required: false
@@ -49,7 +54,9 @@ verify_ssl:
4954
```yaml
5055
# Example configuration.yaml entry
5156
pi_hole:
52-
host: IP_ADDRESS
57+
host: 'localhost:4685'
58+
ssl: false
59+
verify_ssl: false
5360
```
5461

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

0 commit comments

Comments
 (0)