Skip to content

pihole

Pihole

Displays information about a running Pi-hole server.

Configuration

pihole:
  apiUrl: http://192.168.1.100:1010/admin/api.php
  enabled: true
  maxClientWidth: 20
  maxDomainWidth: 20
  position:
    top: 5
    left: 0
    height: 2
    width: 2
  refreshInterval: 1m
  showSummary: true
  showTopItems: 5
  showTopClients: 5
  token: atvvedmpyat8140rnhodrok3qr58d8ph85wl6wk1rpb9upiwx1tl6eittz403pqaj

Screenshots

Pi-hole screenshot

Attributes

Name Value
apiUrl
The Pi-Hole API Server URL. Typically: http:///admin/api.php
maxClientWidth
Optional Number of characters to display when outputting query and ad domain names. Default: 20 		Any positive integer.
maxDomainWidth
Optional Number of characters to display when outputting client name and IP. Default: 20. 		Any positive integer.
showSummary
Show summary. Default: true. 		true, false
showTopItems
Optional Number of Top Queries and Top Ads to display. 0 disables the output. Default: 5. 		Any positive integer.
showTopClients
Optional Number of Top Sources and Query Types to display. 0 disables the output. Default: 5. 		Any positive integer.
token
Navigate to http:///admin/settings.php?tab=api and choose 'Show API Token'

Source Code

https://github.com/wtfutil/wtf/tree/master/modules/pihole