{"id":13587938,"url":"https://github.com/hassio-addons/addon-pi-hole","last_synced_at":"2025-09-29T17:31:43.357Z","repository":{"id":54182092,"uuid":"109603381","full_name":"hassio-addons/addon-pi-hole","owner":"hassio-addons","description":"Pi-hole - Home Assistant Community Add-ons","archived":true,"fork":false,"pushed_at":"2020-03-30T13:20:57.000Z","size":513,"stargazers_count":123,"open_issues_count":0,"forks_count":40,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-09-22T19:32:32.007Z","etag":null,"topics":["adblock","adblocker","addon","addons","home-assistant","homeassistant","pi-hole","pihole"],"latest_commit_sha":null,"homepage":"https://addons.community","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hassio-addons.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null},"funding":{"github":"frenck","patreon":"frenck","custom":"https://frenck.dev/donate/"}},"created_at":"2017-11-05T18:08:06.000Z","updated_at":"2024-08-20T16:19:55.000Z","dependencies_parsed_at":"2022-08-13T08:31:27.503Z","dependency_job_id":null,"html_url":"https://github.com/hassio-addons/addon-pi-hole","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-pi-hole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-pi-hole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-pi-hole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-pi-hole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hassio-addons","download_url":"https://codeload.github.com/hassio-addons/addon-pi-hole/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219874649,"owners_count":16554606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adblock","adblocker","addon","addons","home-assistant","homeassistant","pi-hole","pihole"],"created_at":"2024-08-01T15:06:25.993Z","updated_at":"2025-09-29T17:31:38.033Z","avatar_url":"https://github.com/hassio-addons.png","language":"Shell","funding_links":["https://github.com/sponsors/frenck","https://patreon.com/frenck","https://frenck.dev/donate/","https://www.patreon.com/frenck"],"categories":["Hass.io","Shell","home-assistant"],"sub_categories":["Third Party Add-ons"],"readme":"# Home Assistant Community Add-on: Pi-hole\n\n[![GitHub Release][releases-shield]][releases]\n![Project Stage][project-stage-shield]\n[![License][license-shield]](LICENSE.md)\n\n![Supports aarch64 Architecture][aarch64-shield]\n![Supports amd64 Architecture][amd64-shield]\n![Supports armhf Architecture][armhf-shield]\n![Supports armv7 Architecture][armv7-shield]\n![Supports i386 Architecture][i386-shield]\n\n[![GitLab CI][gitlabci-shield]][gitlabci]\n![Project Maintenance][maintenance-shield]\n[![GitHub Activity][commits-shield]][commits]\n\n[![Discord][discord-shield]][discord]\n[![Community Forum][forum-shield]][forum]\n\n[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]\n\n[![Support Frenck on Patreon][patreon-shield]][patreon]\n\nNetwork-wide ad blocking\n\n## Deprecation warning\n\n**This add-on is in a deprecated state!**\n\nThe Pi-hole add-on is now deprecated and will no longer be supported, maintained\nand will not receive future updates or fixes.\n\nPi-hole used to be a great solution to filter network traffic, but it has been\na challenge to keep/get it in a working state as an add-on.\n\nMeanwhile, the AdGuard team published an alternative:\n[AdGuard Home](https://github.com/hassio-addons/addon-adguard-home).\n\nAdGuard Home as surpassed Pi-hole in terms of capabilities, features,\nand stability, and Home Assistant provides a good integration with AdGuard.\nAbove all, the AdGuard Home team has been supportive in developing the add-on.\n\nFor those reasons, it is no longer viable to keep maintaining the Pi-hole\nadd-on, which has been problematic at best.\n\nWe strongly recommend migrating to the AdGuard Home add-on, which is available\nin the add-on store.\n\n## About\n\n[Pi-hole][pi-hole] is an advertising-aware DNS- and web server, meant to be run\non a dedicated Raspberry Pi connected to your home network. Pi-hole lets you\nblock advertisements for every device that connects to your network without the\nneed for any client-side software.\n\nThis add-on is a port of Pi-hole to be able to run on Home Assistant and is\nbased on Alpine Linux and is using Docker.\n\n## Installation\n\nThe installation of this add-on is pretty straightforward and not different in\ncomparison to installing any other Home Assistant add-on.\n\n1. **Ensure your Home Assistant device has a\n   [static IP and static external DNS servers!](https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md#static-ip)**\n1. Search for the \"Pi-hole\" add-on in the Supervisor add-on store\n   and install it.\n1. Start the \"Pi-hole\" add-on\n1. Check the logs of the \"Pi-hole\" add-on to see it in action.\n\n## Configuration\n\n**Note**: _Remember to restart the add-on when the configuration is changed._\n\nExample add-on configuration:\n\n```yaml\nlog_level: info\nupdate_lists_on_start: true\nssl: false\ncertfile: fullchain.pem\nkeyfile: privkey.pem\ninterface: eth0\nipv6: true\nipv4_address: ''\nipv6_address: ''\nhosts:\n  - name: printer.local\n    ip: 192.168.1.5\n  - name: router.local\n    ip: 192.168.1.1\n  - name: router.local\n    ip: \"FE80:0000:0000:0000:0202:B3FF:FE1E:8329\"\n```\n\n**Note**: _This is just an example, don't copy and paste it! Create your own!_\n\n### Option: `log_level`\n\nThe `log_level` option controls the level of log output by the addon and can\nbe changed to be more or less verbose, which might be useful when you are\ndealing with an unknown issue. Possible values are:\n\n- `trace`: Show every detail, like all called internal functions.\n- `debug`: Shows detailed debug information.\n- `info`: Normal (usually) interesting events.\n- `warning`: Exceptional occurrences that are not errors.\n- `error`:  Runtime errors that do not require immediate action.\n- `fatal`: Something went terribly wrong. Add-on becomes unusable.\n\nPlease note that each level automatically includes log messages from a\nmore severe level, e.g., `debug` also shows `info` messages. By default,\nthe `log_level` is set to `info`, which is the recommended setting unless\nyou are troubleshooting.\n\nUsing `trace` or `debug` log levels puts the dnsmasq daemon into debug mode,\nallowing you to see all DNS requests in the add-on log.\n\n### Option: `update_lists_on_start`\n\nDownload and process all configured ad block lists on add-on startup by setting\nthis option to `true`. This will add startup time to your add-on but will give\nyou the most recent versions of the ad block lists on start.\n\nWhen this option is set to `false` you will still get updated lists once in a\nwhile. A scheduled task will take care of that.\n\n**Note**: _When starting the add-on for the very first time, the lists will be\nupdated, regardless of the value of this option._\n\n### Option: `ssl`\n\nEnables/Disables SSL (HTTPS) on the web interface of Pi-hole. Set it `true` to\nenable it, `false` otherwise.\n\n### Option: `certfile`\n\nThe certificate file to use for SSL.\n\n**Note**: _The file MUST be stored in `/ssl/`, which is the default_\n\n### Option: `keyfile`\n\nThe private key file to use for SSL.\n\n**Note**: _The file MUST be stored in `/ssl/`, which is the default_\n\n### Option: `interface`\n\nConfigures the interface the Pi-hole DNS server should be listening to. By\nleaving it empty, the add-on will try to auto-detect the interface to use.\n\n**Note**: _This option is in place in case auto-detection fails on your setup._\n\n### Option: `ipv6`\n\nSet this option to `false` to disable IPv6 support.\n\n### Option: `ipv4_address`\n\nManually set the IPv4 address for Pi-hole to use. By leaving it empty, the\nadd-on will try to auto-detect the interface to use.\n\n**Note**: _This option is in place in case auto-detection fails on your setup._\n\n### Option: `ipv6_address`\n\nManually set the IPv6 address for Pi-hole to use. By leaving it empty, the\nadd-on will try to auto-detect the interface to use.\n\n**Note**: _This option is in place in case auto-detection fails on your setup._\n\n### Option: `hosts`\n\nThis option allows you create your own DNS entries for your LAN. This\ncapability can be handy for pointing easy to remember hostnames to an IP\n(e.g., point `printer.local` to the IP address of your printer).\n\nAdd a list of hosts you want to add. Some hosts can have both IPv4 and IPv6\naddresses. In that case, simply add the host twice (with both addresses).\n\nSee the example above this chapter for a more visual representation.\n\n#### Sub-option: `name`\n\nThis option specifies the DNS name of the host you are adding. Its value could\nbe a short style hostname like: `printer` or a longer one `printer.local`.\n\n#### Sub-option: `ip`\n\nThe IP address this specified host must point to. Its value must be an IPv6 or\nIPv4 IP address.\n\n### Option: `leave_front_door_open`\n\nAdding this option to the add-on configuration allows you to disable\nauthentication on the admin interface by setting it to `true` and leaving the\npassword empty.\n\n**Note**: _We STRONGLY suggest, not to use this, even if this add-on is\nonly exposed to your internal network. USE AT YOUR OWN RISK!_\n\n## Using the Pi-hole integration in Home Assistant\n\nHome Assistant offers a [Pi-hole integration][pi-hole-integration] that allows\nyou to retrieve statistics and interact with your Pi-hole installation.\n\nTo enable this integration, add the following lines to your `configuration.yaml`\nfile:\n\n```yaml\n# Example configuration.yaml entry\npi_hole:\n  host: localhost:4865\n  api_key: \"\"\n```\n\nFor more information and documentation about configuring this sensor, please\ncheck the [documentation of Home Assistant][pi-hole-integration].\n\n## Changelog \u0026 Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented\nbased on the following:\n\n- ``MAJOR``: Incompatible or major changes.\n- ``MINOR``: Backwards-compatible new features and enhancements.\n- ``PATCH``: Backwards-compatible bugfixes and package updates.\n\n## Support\n\nGot questions?\n\nYou have several options to get them answered:\n\n- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on\n  support and feature requests.\n- The [Home Assistant Discord chat server][discord-ha] for general Home\n  Assistant discussions and questions.\n- The Home Assistant [Community Forum][forum].\n- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]\n\nYou could also [open an issue here][issue] GitHub.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe have set up a separate document containing our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Authors \u0026 contributors\n\nThe original setup of this repository is by [Franck Nijhof][frenck].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## We have got some Home Assistant add-ons for you\n\nWant some more functionality to your Home Assistant instance?\n\nWe have created multiple add-ons for Home Assistant. For a full list, check out\nour [GitHub Repository][repository].\n\n## Trademark legal notice\n\nThis add-on is not created, developed, affiliated, supported, maintained\nor endorsed by Pi-hole LLC.\n\nAll product names, logos, brands, trademarks and registered trademarks are\nproperty of their respective owners. All company, product, and service names\nused are for identification purposes only.\n\nUse of these names, logos, trademarks, and brands does not imply endorsement.\n\n## License\n\nMIT License\n\nCopyright (c) 2017-2020 Franck Nijhof\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg\n[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg\n[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg\n[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg\n[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-pi-hole.svg\n[commits]: https://github.com/hassio-addons/addon-pi-hole/commits/master\n[contributors]: https://github.com/hassio-addons/addon-pi-hole/graphs/contributors\n[discord-ha]: https://discord.gg/c5DvZ4e\n[discord-shield]: https://img.shields.io/discord/478094546522079232.svg\n[discord]: https://discord.me/hassioaddons\n[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg\n[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-pi-hole/33817?u=frenck\n[frenck]: https://github.com/frenck\n[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png\n[github-sponsors]: https://github.com/sponsors/frenck\n[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-pi-hole/badges/master/pipeline.svg\n[gitlabci]: https://gitlab.com/hassio-addons/addon-pi-hole/pipelines\n[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg\n[issue]: https://github.com/hassio-addons/addon-pi-hole/issues\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-pi-hole.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg\n[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png\n[patreon]: https://www.patreon.com/frenck\n[pi-hole-integration]: https://www.home-assistant.io/components/pi_hole/\n[pi-hole]: https://pi-hole.net/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg\n[reddit]: https://reddit.com/r/homeassistant\n[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-pi-hole.svg\n[releases]: https://github.com/hassio-addons/addon-pi-hole/releases\n[repository]: https://github.com/hassio-addons/repository\n[semver]: http://semver.org/spec/v2.0.0.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Faddon-pi-hole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhassio-addons%2Faddon-pi-hole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Faddon-pi-hole/lists"}