{"id":15148168,"url":"https://github.com/dudecalledbro/pihole","last_synced_at":"2026-02-04T21:34:59.257Z","repository":{"id":234759210,"uuid":"789460519","full_name":"DudeCalledBro/pihole","owner":"DudeCalledBro","description":"Ansible Pi-hole deployment ","archived":false,"fork":false,"pushed_at":"2024-11-03T22:35:47.000Z","size":21,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T02:47:18.239Z","etag":null,"topics":["ansible","docker-compose","pihole"],"latest_commit_sha":null,"homepage":"","language":"Jinja","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/DudeCalledBro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"DudeCalledBro"}},"created_at":"2024-04-20T16:01:34.000Z","updated_at":"2024-11-03T22:35:51.000Z","dependencies_parsed_at":"2024-08-03T12:26:24.113Z","dependency_job_id":"739b396c-46b7-446c-8694-26c03fe7f564","html_url":"https://github.com/DudeCalledBro/pihole","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"cf6a6b32e7ece20406f4b650c21a3f3cb20d0f1f"},"previous_names":["dudecalledbro/pihole"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DudeCalledBro/pihole","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fpihole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fpihole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fpihole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fpihole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DudeCalledBro","download_url":"https://codeload.github.com/DudeCalledBro/pihole/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fpihole/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266026162,"owners_count":23866030,"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":["ansible","docker-compose","pihole"],"created_at":"2024-09-26T13:01:36.971Z","updated_at":"2026-02-04T21:34:59.186Z","avatar_url":"https://github.com/DudeCalledBro.png","language":"Jinja","funding_links":["https://github.com/sponsors/DudeCalledBro"],"categories":[],"sub_categories":[],"readme":"# Pi-hole\n\n[![CI](https://github.com/DudeCalledBro/pihole/actions/workflows/ci.yml/badge.svg)](https://github.com/DudeCalledBro/pihole/actions/workflows/ci.yml)\n\nThis repository contains my ansible deployment for Pi-hole. I am using Pi-hole on a Raspberry Pi 4 with Docker and it's been running rock-solid. The ansible deployment is designed to run on any platform with supported docker.\n\n## Prerequisites\n\n- Ensure you have Ansible installed (e.g. `pip3 install ansible`)\n- Ensure Docker is installed on the Pi-hole server (you may want to checkout my [ansible-docker-role](https://github.com/DudeCalledBro/ansible-role-docker))\n\n## Installation\n\n1. Copy the `example.inventory.yml` file to `inventory.yml`. You also have to setup a variables file for your configuration. Therefore you have to copy `example.config.yml` to `config.yml`. Also have a look into the roles default's.\n\n2. Run the Ansible playbook to deploy Pi-hole\n\n    ```bash\n    ansible-playbook play-pihole.yml\n    ```\n\n    \u003e Notice: Checkout the possible environment variables for Pi-hole (e.g. `TZ` or `WEBPASSWORD`). Check it out [here](https://github.com/pi-hole/docker-pi-hole?tab=readme-ov-file#environment-variables).\n\n3. (**Optional**) Run the Ansible resolvconf playbook to update the Pi-hole server's resolvconf to use the local service\n\n    ```bash\n    ansible-playbook play-resolvconf.yml\n    ```\n\n4. (**Optional**) Run the Ansible Pi-hole exporter playbook to setup a metrics exporter for Prometheus. That's an awsome project! [Check it out!](https://github.com/eko/pihole-exporter)\n\n    ```bash\n    ansible-playbook play-pihole_exporter.yml\n    ```\n\n    You can configure the Prometheus scrape configuration like to following:\n\n    ```yaml\n    scrape_configs:\n      - job_name: 'pihole'\n        static_configs:\n          - targets: ['localhost:9617']\n    ```\n\n## Backup and Restore\n\n1. Login into the Pi-hole admin web gui\n\n2. Change to `Settings` \u003e `Teleporter`\n\n3. There you either want to backup your data or restore it from an existing TAR file\n\n\u003e **Notice!** The Pi-hole ansible role creates an cronjob that backups all required data. You may want to mount the backup directory `{{ pihole_docker_path }}/backups` on to a NAS or dedicated hard drive.\n\n## Further\n\n- The Pi-hole web gui is reachable at `http://pihole.local/admin/login.php`\n\n## License\n\nCopyright © 2024 Niclas Spreng\n\nLicensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdudecalledbro%2Fpihole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdudecalledbro%2Fpihole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdudecalledbro%2Fpihole/lists"}