From a82947c8fd2f81e3468fd7e34d90aa43c588ebb3 Mon Sep 17 00:00:00 2001 From: Emily Wotruba Date: Wed, 22 May 2024 15:12:08 +0200 Subject: [PATCH] updated documentation for pi-hole --- docs/customservices.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/customservices.md b/docs/customservices.md index cc089a57b..577ef661b 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -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.