From f738cd2726f55560cc8553b1f8fed4254c86019d Mon Sep 17 00:00:00 2001 From: casmbu Date: Sat, 2 Aug 2025 16:43:05 -0400 Subject: [PATCH] chore: add pi-hole-queries-v6 widget docs --- docs/widgets.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/widgets.md b/docs/widgets.md index c3e4ea73..50e71028 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -49,7 +49,9 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Memory History](#memory-history-netdata) - [System Load History](#load-history-netdata) - [Pi Hole Stats](#pi-hole-stats) + - [Pi Hole Stats v6](#pi-hole-stats-v6) - [Pi Hole Queries](#pi-hole-queries) + - [Pi Hole Queries v6](#pi-hole-queries-v6) - [Pi Hole Recent Traffic](#pi-hole-recent-traffic) - [Stat Ping Statuses](#stat-ping-statuses) - [Synology Download Station](#synology-download-station) @@ -1848,6 +1850,39 @@ Shows top queries that were blocked and allowed by [Pi-Hole](https://pi-hole.net --- +### Pi Hole Queries v6 + +Shows top queries that were blocked and allowed by [Pi-Hole](https://pi-hole.net/). + +

+ +#### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your Pi-Hole instance +**`apiKey`** | `string` | Required | Your Pi-Hole web password or application password. It **IS** your Pi-Hole admin interface password **UNLESS** you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password. +**`count`** | `number` | _Optional_ | The number of queries to display. Defaults to `10` + +#### Example + +```yaml +- type: pi-hole-top-queries-v6 + options: + hostname: https://pi-hole.local + apiKey: xxxxxxxxxxxxxxxxxxxxxxx +``` + +#### Info + +- **CORS**: 🟢 Enabled +- **Auth**: 🔴 Required +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [GitHub - Pi-hole](https://github.com/pi-hole/pi-hole)) +- **Privacy**: _See [Pi-Hole Privacy Guide](https://pi-hole.net/privacy/)_ + +--- + ### Pi Hole Recent Traffic Shows number of recent traffic, using allowed and blocked queries from [Pi-Hole](https://pi-hole.net/)