Portainer Templates logo

Portainer Templates

Pi-Hole DoH/DoT Pi-Hole DoH/DoT

Container

OtherTools

A Linux network-level advertisement and Internet tracker blocking application which acts as a DNS sinkhole with both DoH (DNS over HTTPS) and DoT (DNS over TLS) clients.

Image details

Pulls: 200k
Architecture: amd64, arm
Image size: 115 MB
Latest: v1.4
User: oijkn
Created: Sep 22, 2021
Updated: 4 years ago
Status: active

Source details

Repo: oijkn/pihole-doh-dot
Stars: 9
Forks: 2
Language: Shell
License: GPL-3.0
Updated: 4 years ago

Configuration

Type
Container
Platform
linux
Image
oijkn/pihole-doh-dot:latest
Ports
53:53/tcp53:53/udp67:67/udp1010:80/tcp4443:443/tcp
Volumes
/etc/pihole : /portainer/Files/AppData/Config/PiHole_DoH-DoT/etc/dnsmasq.d : /portainer/Files/AppData/Config/PiHole_DoH-DoT/DNS
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://pi-hole.net/
Official Docker Documentation: https://hub.docker.com/r/oijkn/pihole-doh-dot

Pi-Hosted dedicated documentation: pi-hole.md




When the installation is complete, navigate to your.ip.goes.here:1010/admin. Follow the article here if you run into issues binding to port 53. If you like to use Pi-Hole's built in DHCP-Server change the Network type to host and open advance options and scroll to Labels and add: NET_ADMIN with the value True. When you do so, specify a port is no more needed, navigate to your.ip.goes.here/admin.

Standalone Install

Select an install method, to see config/commands for deploying Pi-Hole DoH/DoT

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Pi-Hole DoH/DoT, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see oijkn/pihole-doh-dot for app-specific guidance.

/!\ project is discontinued, and replaced by AdGuardHome DoH/DoT /!\

Welcome to Pi-hole DoH/DoT !

💻 Introduction

Official Pi-hole docker with both DoH (DNS over HTTPS) and DoT (DNS over TLS) clients. Don't browse the Internet insecurely by sending your DNS requests in clear text !
Image built for Raspberry Pi (arm32/v7).
Github : https://github.com/oijkn/pihole-doh-dot

🚀 Installation

1. Clone the repository
# git clone https://github.com/oijkn/pihole-doh-dot.git /path/of/your/docker/pihole
2. Edit environment files to fit your needs
For docker parameters, refer to official pihole docker readme.
# cat /path/of/your/docker/pihole/config/.env 
TZ=Europe/Paris                             # Set your timezone to make sure logs rotate at local midnight instead of at UTC midnight.
WEBPASSWORD=password                        # Set your password to access Web UI
ServerIP=0.0.0.0                            # Set to your server's LAN IP, used by web block modes and lighttpd bind address
VIRTUAL_HOST=192.168.1.100                  # What your web server 'virtual host' is, accessing admin through this Hostname/IP allows you to make changes to the whitelist / blacklists in addition to the default 'http://pi.hole/admin/' address
PIHOLE_DNS_=127.0.0.1#5053;127.0.0.1#5153   # Upstream DNS server(s) for Pi-hole to forward queries to, seperated by a semicolon (supports non-standard ports with #[port number]) e.g 127.0.0.1#5053;8.8.8.8;8.8.4.4
IPv6=false                                  # For unraid compatibility, strips out all the IPv6 configuration from DNS/Web services when false.
DNSMASQ_LISTENING=all                       # local listens on all local subnets, all permits listening on internet origin subnets in addition to local, single listens only on the interface specified.
PIHOLE_DOMAIN=home                          # Domain name sent by the DHCP server.
DNSMASQ_USER=root                           # Allows running FTLDNS as non-root.

☕ Docker usage

Consider changing the mounting point of the volume according to your needs.
docker run -d \
    --hostname='rpi-srv' \
    --name='pihole-doh-dot' \
    --cap-add=NET_ADMIN \
    --restart=unless-stopped \
    --net='bridge' \
    --env-file .env \
    -v '/data/pihole-doh-dot/pihole/':'/etc/pihole/':'rw' \
    -v '/data/pihole-doh-dot/dnsmasq.d/':'/etc/dnsmasq.d/':'rw' \
    -v '/data/pihole-doh-dot/config/':'/config':'rw' \
    -p '53:53/tcp' \
    -p '53:53/udp' \
    -p '67:67/udp' \
    -p '1010:80/tcp' \
    -p '443:443/tcp' \
    'oijkn/pihole-doh-dot:latest'

📝 Notes

  • To use just DoH or just DoT service, set PIHOLE_DNS_ to the same value.
- DoH service (cloudflared) runs at 127.0.0.1#5053. Uses cloudflare (1.1.1.1 / 1.0.0.1) by default - DoT service (stubby) runs at 127.0.0.1#5153. Uses cloudflare (1.1.1.1 / 1.0.0.1) by default
  • In addition to the 2 official paths, you can also map container /config to expose configuration yml files for cloudflared (cloudflared.yml) and stubby (stubby.yml).
- Edit these files to add / remove services as you wish. The flexibility is yours.

📫 Credits

Serve Pi-Hole DoH/DoT on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying pi-hole-doh-dot.example.com to http://pihole DoH/DoT:80

Add this to your Caddyfile

pi-hole-doh-dot.example.com {
	reverse_proxy http://pihole DoH/DoT:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs pihole DoH/DoT
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:53 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :53
  • Stop the other service, or pick a different host port. In 53:53 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:1010. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, pihole DoH/DoT can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 1010

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/PiHole_DoH-DoT (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull oijkn/pihole-doh-dot:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect pihole DoH/DoT --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Pi-Hole DoH/DoT runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Pi-Hole DoH/DoT needs bundled into one download. This template pulls oijkn/pihole-doh-dot:latest, which Docker fetches once (about 115 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Pi-Hole DoH/DoT's comes from Docker Hub, published by oijkn.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v1.4. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 53:53 means it's reachable on port 53 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:1010 in a browser. It opens:

  • 53:53
  • 53:53 over UDP
  • 67:67 over UDP
  • 1010:80, likely the web interface
  • 4443:443, likely the web interface

Volumes

A volume is where Pi-Hole DoH/DoT keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /etc/pihole from /portainer/Files/AppData/Config/PiHole_DoH-DoT on the host
  • /etc/dnsmasq.d from /portainer/Files/AppData/Config/PiHole_DoH-DoT/DNS on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts Pi-Hole DoH/DoT after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Pi-Hole DoH/DoT sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container pihole DoH/DoT. That's what you'll spot in the containers list and use in commands like docker logs pihole DoH/DoT.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Pi-Hole DoH/DoT is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Pi-Hole DoH/DoT up. Add the template list to Portainer once, then deploying Pi-Hole DoH/DoT is a click rather than a wall of config.