Skip to content

themarkwilliams/streamdeck-pihole-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Pi-hole Controller

Control and monitor your Pi-hole v6 directly from your Elgato Stream Deck.


Features

Button Description
Enable Blocking Re-enable Pi-hole DNS blocking
Disable Blocking Disable Pi-hole DNS blocking
Disable for X Disable blocking for a set duration with a live countdown
Status Indicator Shows blocking state with color-coded icons — green (active), red (disabled), yellow (unreachable)
Stats Display Displays a single live metric — configured per button in the Property Inspector. Available metrics: Total Queries, Queries Blocked, % Blocked, Domains on List, Q/min, Load (1/5/15m), Memory, Active Clients, Total Clients
Version Info Shows current Pi-hole version; highlights when an update is available. Press the button to refresh immediately
Open Pi-hole UI Opens the Pi-hole admin interface in your browser

Requirements

  • Elgato Stream Deck software 6.9 or later
  • Windows 10+ or macOS 13+
  • Pi-hole v6 or later
  • A Pi-hole App Password (Settings → API → App Passwords in the Pi-hole admin UI)

Installation

Install from the Elgato Marketplace.


Setup

  1. Install Pi-hole Controller from the Elgato Marketplace.
  2. In your Pi-hole admin UI, go to Settings → API → App Passwords and create a new App Password.
  3. Add any Pi-hole Controller button to your Stream Deck profile.
  4. In the Property Inspector (right panel), enter:
    • Host — your Pi-hole's IP address or hostname (e.g. pi.hole or 192.168.1.2)
    • Port — typically 80, or 443 if using HTTPS
    • App Password — the password you just created
  5. Click Test Connection to confirm everything is working.
  6. All buttons share the same connection — you only need to configure it once.

Using HTTPS? Check the HTTPS box and the port will update to 443 automatically. Works with reverse proxies (Nginx, Caddy, etc.).

Self-signed certificate? Check Ignore SSL Errors to bypass certificate validation — useful for home lab setups with a local CA or self-signed cert.


Reporting Issues

Found a bug or have a feature request? Please open an issue and fill out the relevant template.

Before submitting:

  • Check the existing issues to avoid duplicates.
  • Include your Pi-hole version and Stream Deck software version.