Pi-hole

Displays information about a running Pi-hole server.

Configuration

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

Screenshots

Pi-hole screenshot

Attributes

Name Description Value
border Optional Whether or not to draw this widget with a border. Default: true. true, false
enabled Optional Whether or not this module is executed and if its data displayed onscreen. Default: false. true, false
position Defines where in the grid this module’s widget will be displayed.
refreshInterval Optional How often, in seconds, this module will update its data. Default: 300. Any positive integer.
apiUrl The Pi-Hole API Server URL. Typically: http://<ip:port>/admin/api.php
token Navigate to http://<ip:port>/admin/settings.php?tab=api and choose "Show API Token".
showSummary Show summary. Default: true. true, false
showTopItems Optional Number of Top Queries and Top Ads to display. 0 disables the output. Default: 5. Integer
showTopClients Optional Number of Top Sources and Query Types to display. 0 disables the output. Default: 5. Integer
maxClientWidth Optional Number of characters to display when outputting query and ad domain names. Default: 20. Integer
maxDomainWidth Optional Number of characters to display when outputting client name and IP. Default: 20. Integer

Keyboard Controls

Key Action
/ Open/close the widget’s help modal
d Disable Pi-hole ad blocking
e Enable Pi-hole ad blocking
r Refresh the data

Source Code

wtf/modules/pihole/