mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-04 10:56:23 +00:00
codeandClaude Fable 5
340866f9f4
Existing content preserved and reordered to the canonical section order; missing sections generated from each stack's compose data (ports, volumes, env vars, image links). Fixes copy-paste errors in Dockhand sections (qbittorrent pointed at archivebox; invokeai/thunderbird said SERVICENAME) and persistant->persistent typos in gatus. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
83 lines
3.1 KiB
Markdown
83 lines
3.1 KiB
Markdown
# PiHole
|
||
|
||
## Overview
|
||
|
||
This Docker Compose project deploys a Pi-hole DNS sinkhole and network-wide ad blocker. It centralizes DNS filtering, logging, and management behind a lightweight containerized service.
|
||
|
||
## Project Details
|
||
|
||
- **Project Repository:** [Link](https://pi-hole.net/)
|
||
- **Container Image:** [Docker Hub](https://hub.docker.com/r/pihole/pihole)
|
||
- **Compose Example:** [Compose](https://hub.docker.com/r/pihole/pihole)
|
||
- **Documentation:** [Docs](https://docs.docker.com/compose/install/)
|
||
- **Reverse Proxy Port:** `53 (tcp & udp), 80, 443, 67, 123`
|
||
|
||
## Getting Started
|
||
|
||
1. Start the container: `docker compose up -d`
|
||
2. Open http://localhost:PORT in your browser
|
||
3. Follow the initial setup wizard to configure the application
|
||
|
||
## Environment Variable Notes
|
||
|
||
Below are the key environment variables commonly used with the Pi-hole container.
|
||
You can also read more here: https://hub.docker.com/r/pihole/pihole
|
||
|
||
```
|
||
TZ – Your timezone (e.g., "America/Toronto"). Used for correct log timestamps.
|
||
WEBPASSWORD – Password for the Pi-hole admin web interface. If omitted, a random one is generated.
|
||
DNSMASQ_LISTENING – Set to "all" to allow queries from the LAN.
|
||
ServerIP – The host machine’s LAN IP address. Required so Pi-hole can properly generate block pages.
|
||
FTLCONF_LOCAL_IPV4 – Alternative to ServerIP for newer versions; defines Pi-hole’s listening IP.
|
||
INTERFACE – Network interface Pi-hole should bind to (e.g., eth0). Optional if using host networking.
|
||
VIRTUAL_HOST – (Optional) Used with reverse proxies for URL routing.
|
||
```
|
||
|
||
## Volume Notes
|
||
|
||
Pi-hole uses volumes to persist configuration and query data:
|
||
|
||
```
|
||
/etc/pihole – Stores Pi-hole configs, gravity lists, custom blocklists, DHCP settings, logs.
|
||
/etc/dnsmasq.d – Stores dnsmasq configuration files used by Pi-hole’s DNS service.
|
||
```
|
||
|
||
## Network Notes
|
||
|
||
Uses `network_mode: host` (DNS server) — no proxy network.
|
||
|
||
## Docker Run
|
||
|
||
```bash
|
||
docker run -d \
|
||
--name pihole \
|
||
-v /data/pihole/etc:/etc/pihole \
|
||
-v /data/pihole/dnsmasq:/etc/dnsmasq.d \
|
||
pihole/pihole:latest
|
||
```
|
||
|
||
See compose.yaml for the full set of environment variables.
|
||
|
||
## Additional Notes / Gotchas
|
||
|
||
DHCP Server: If running Pi-hole as your network DHCP server, the container must run in host networking mode to broadcast DHCP packets correctly.
|
||
|
||
Networking: Pi-hole works best in host networking mode. If using bridge mode, you must set ServerIP and ensure port 53 (TCP/UDP) is exposed.
|
||
|
||
Port Conflicts: Nothing else on the host may use port 53. Disable systemd-resolved or any local DNS server if necessary.
|
||
|
||
Docker + Reverse Proxy: Pi-hole doesn’t always play nicely behind reverse proxies. If using one, forward only the admin interface (port 80) and keep DNS ports (53) exposed directly.
|
||
|
||
Gravity Updates: Pi-hole updates blocklists daily. If using custom lists, verify they can be fetched without authentication or special headers.
|
||
|
||
## Dockhand Stack, Deploy from Git
|
||
|
||
Cookbooks Repository
|
||
stackname: pihole
|
||
Compose file path: pihole/compose.yaml
|
||
Additional env file (optional): pihole/sample.env
|
||
|
||
Then "Load" pihole/sample.env into the Environmental variables in dockhand
|
||
|
||
Create the Stack
|