README.md

Pi-hole Card

Complete Pi-hole monitoring and control for Home Assistant

Overview

A dashboard card for managing and monitoring your Pi-hole DNS ad blocker from Home Assistant: statistics, controls, diagnostics, and optional system metrics.

Documentation

Full documentation is available at: homeassistant-extras.github.io/pi-hole-card

Quick Start

type: custom:pi-hole
device_id: your_pihole_device_id

The card discovers Pi-hole entities from your configured device(s). For multiple instances, use a list under device_id; see the configuration guide.

Installation

Warning

You need a working Pi-hole integration in Home Assistant (recommended: Pi-hole v6 integration). Details: docs/INSTALLATION.md.

HACS (Recommended)

1. Open HACS in your Home Assistant instance
2. Click the menu icon and select "Custom repositories"
3. Add: https://github.com/homeassistant-extras/pi-hole-card
4. Select "Dashboard" as the category
5. Click "Install"

Manual Installation

1. Download pi-hole-card.js from the latest release
2. Copy to www/community/pi-hole-card/
3. Add to your configuration.yaml:

lovelace:
  resources:
    - url: /local/community/pi-hole-card/pi-hole-card.js
      type: module

Contributing

• Join the Discussions - Share your insights, provide feedback, or ask questions
• Report Issues - Submit bugs or feature requests
• Submit Pull Requests - Review open PRs and submit your own
• Check out Discord - Need further help, have ideas, want to chat?
• Check out my other cards!

Translations

Want to contribute a language? See TRANSLATIONS.md.

License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

Acknowledgments

• Built using LitElement
• Inspired by Pi-hole's own dashboard design
• Thanks to all contributors!
• Maintained by Patrick Masters / Curious Cat Consulting

Project roadmap and community appreciation

• Initial design: create initial card design
• Auto-discovery: automatic detection of Pi-hole entities
• Dashboard statistics: visual representation of key metrics
• Control buttons: quick actions for common Pi-hole tasks
• Version info: display component versions and updates - thanks @IIIdefconIII!
• Custom actions: tap/hold/double-tap actions for all elements - thanks @dunxd
• Card customization: custom title and icon options
• Performance optimizations: improved code structure and efficiency
• Enhanced entity mapping: ⭐ First contributor ⭐ better entity identification with translation keys - thanks @bastgau
• Translations: ability to add translations - thanks @ajavibp
• Multi-Pi-hole support: manage and monitor multiple Pi-hole instances - thanks @Drudoo, @heylers, @mtwhitley
• Collapsible sections: collapse/expand card sections to save space - thanks @Teleportist
• Additional visualization options: using HA native more-info, etc. - thanks @dunxd
• Pause ad-blocking: temporarily disable filtering for specified durations - thanks @StuartHaire, @VVRud, @ccpk1
• Entity ordering: customize the order of displayed entities - thanks @Teleportist
• Section hiding: ability to disable sections or entities - thanks @pcnate, @bastgau, @Anto79-ops
• Visual separators: add dividers for switches - thanks @Teleportist
• Diagnostics info indicator: show diagnostic messages count - thanks @WalterPepeka
• Greek translation: ⭐ Second contributor ⭐ added Greek language support - thanks @ChriZathens
• Customizable badge actions: configurable tap/hold/double-tap actions for card badge - thanks @moshoari
• Enhanced pause durations: flexible time formats and human-readable display for pause buttons - thanks @moshoari
• Backwards compatibility: maintained Home Assistant integration backwards compatibility - thanks @ccheath, @ejpenney
• Group pause feature: enhanced pause functionality with group support - thanks @bastgau
• System metrics chart: visualize CPU and memory usage over time with customizable line styles - thanks me!