Skip to content

Commit

Permalink
updated documentation for pi-hole
Browse files Browse the repository at this point in the history
  • Loading branch information
emilywotruba committed May 22, 2024
1 parent 449308b commit a82947c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/customservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,18 @@ The following configuration is available for the PiHole service.
# subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
url: "http://192.168.0.151/admin"
apikey: "<---insert-api-key-here--->" # optional, needed if web interface is password protected
items: ["ads_percentage_today"] # optional, which items to show (and in which order) in the subtitle. Possible values are all fields of the status api (see below)
format: "{0} % blocked" # the format of the subtitle, required only if items are given
type: "PiHole"
```
**Items:**
The fields of the status api are outlined [here](https://docs.pi-hole.net/ftldns/telnet-api/?h=api#stats). Another example of `items` and `format`:
```yaml
items: ["queries_forwarded", "dns_queries_today"]
format: "{0} of {1} queries forwarded"
```

**Remarks:**
If PiHole web interface is password protected, obtain the `apikey` from Settings > API/Web interface > Show API token.

Expand Down

0 comments on commit a82947c

Please sign in to comment.