Skip to content

Commit

Permalink
Updates pi_hole component documentation per home-assistant/core#25837
Browse files Browse the repository at this point in the history
  • Loading branch information
johnluetke committed Aug 10, 2019
1 parent 10c3af1 commit 65e69cb
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions source/_components/pi_hole.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,23 @@ redirect_from:
- /components/sensor.pi_hole/
---

The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system.
The `pi_hole` integration allows you to retrieve and display statistics from a [Pi-hole](https://pi-hole.net/) system.

## Configuration

To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:

```yaml
# Example configuration.yaml entry
sensor:
- platform: pi_hole
pi_hole:
```
{% configuration %}
host:
description: IP address of the host where Pi-hole is running.
required: false
type: string
default: localhost
default: pi.hole
location:
description: The installation location of the Pi-hole API.
required: false
Expand Down Expand Up @@ -73,9 +72,11 @@ monitored_conditions:

```yaml
# Example configuration.yaml entry
pi_hole:
host: IP_ADDRESS
sensor:
- platform: pi_hole
host: IP_ADDRESS
monitored_conditions:
- ads_blocked_today
- ads_percentage_today
Expand All @@ -87,4 +88,4 @@ sensor:
- unique_domains
```

This sensor platform 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.

0 comments on commit 65e69cb

Please sign in to comment.