Public Repository

Last pushed: a year ago
Short Description
A Docker project to make lightweight continers with pi-hole https://pi-hole.net functionality
Full Description

A Docker project to make lightweight x86 and ARM continer with pi-hole functionality. Why? Maybe you don't have a Raspberry Pi lying around but you do have a Docker server.

Now with ARM (actual docker-pi) support! Just install docker on your Rasberry-Pi and run docker image diginc/pi-hole:arm tag (see below for full required command).

  • The current Raspbian install is simply curl -sSL https://get.docker.com | sh [1]

Running Pi-Hole Docker

Dockerhub automatically builds the latest docker-pi-hole changes into images which can easily be pulled and ran with a simple docker run command.

One crucial thing to know before starting is the docker-pi-hole container needs port 53 and port 80, 2 very popular ports that may conflict with existing applications. If you have no other services or dockers using port 53/80 (if you do, keep reading below for a reverse proxy example), the minimum options required to run this container are in the script docker_run.sh or summarized here:

IMAGE='diginc/pi-hole'
NIC='eth0'
IP=$(ip addr show $NIC | grep "inet\b" | awk '{print $2}' | cut -d/ -f1)
docker run -p 53:53/tcp -p 53:53/udp -p 80:80 --cap-add=NET_ADMIN -e ServerIP="$IP" --name pihole -d $IMAGE

# Recommended auto ad list updates & log rotation:
wget -O- https://raw.githubusercontent.com/diginc/docker-pi-hole/master/docker-pi-hole.cron | sudo tee /etc/cron.d/docker-pi-hole.cron

This is just an example and might need changing. For exmaple of you're running on a raspberry pi over wireless you'll probably want to change your NIC variable to wlan0 and IMAGE to diginc/pi-hole:arm

Automatic Ad List Updates - docker-pi-hole.cron is a modified verion of upstream pi-hole's crontab entries using docker exec to run the same update scripts inside the docker container. The cron automatically updates pi-hole ad lists and cleans up pi-hole logs nightly. If you're not using the docker run with --name pihole from default contariner run command be sure to fill in your container's DOCKER_NAME into the variable in the cron file.

Environment Variables

In addition to the required environment variable you saw above (-e ServerIP="$IP") there are optional ones if you want to customize various things inside the docker container:

Env Variable Default Description
ServerIP REQUIRED! Set to your server's external IP in order to override what Pi-Hole users. Pi-Hole autodiscovers the unusable internal docker IP otherwise
DNS1 8.8.8.8 Primary upstream DNS for Pi-Hole's DNSMasq to use, defaults to google
DNS2 8.8.4.4 Secondary upstream DNS for Pi-Hole's DNSMasq to use, defaults to google
VIRTUAL_HOST Server_IP 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
IPv6 True Allows forced disabling of IPv6 for docker setups that can't support it (like unraid)

Tips and Tricks

  • A good way to test things are working right is by loading this page: http://pi.hole/admin/
  • Port conflicts? Stop your server's existing DNS / Web services.
    • Ubuntu users especially may need to shutoff dnsmasq on your docker server so it can run in the container on port 53
    • Don't forget to stop your services from auto-starting again after you reboot
  • Port 80 is required because if you have another site/service using port 80 by default then the ads may not transform into blank ads correctly. To make sure docker-pi-hole plays nicely with an exising webserver you run you'll probably need a reverse proxy websever config if you don't have one already. Pi-Hole has to be the default web app on said proxy e.g. if you goto your host by IP instead of domain pi-hole is served out instead of any other sites hosted by the proxy. This behavior is taken advantage of so any ad domain can be directed to your webserver and get blank html/images/videos instead of ads.
    • Here is an example of running with jwilder/proxy (an nginx auto-configuring docker reverse proxy for docker) on my port 80 with pihole on another port. Pi-hole needs to be DEFAULT_HOST env in jwilder/proxy and you need to set the matching VIRTUAL_HOST for the pihole's container. Please read jwilder/proxy readme for more info if you have trouble. I tested this basic exmaple which is based off what I run.

Volume Mounts

Here are some useful volume mount options to persist your history of stats in the admin interface, or add custom whitelists/blacklists. Create these files on the docker host first or you'll get errors:

  • docker run -v /var/log/pihole.log:/var/log/pihole.log ... (plus all of the minimum options added)
    • touch /var/log/pihole.log on your docker server first or you will end up with a directory there (silly docker!)
  • docker run -v /etc/pihole/:/etc/pihole/ ... (plus all of the minimum options added)

All of these options get really long when strung together in one command, which is why I'm not showing all the full docker run commands variations here. This is where docker-compose yml files come in handy for representing really long docker commands in a readable file format.

Docker tags

The primary docker tags / versions are as follows. Click here to see the full list of tags, I also try to tag with the specific version of Pi-Hole Core / Web for historical or version pinning purposes.

tag architecture description Dockerfile
alpine / latest x86 Alpine x86 image, small size container running nginx and dnsmasq Dockerfile
debian x86 Debian x86 image, container running lighttpd and dnsmasq Dockerfile
arm ARM Debian ARM image, container running lighttpd and dnsmasq built for ARM Dockerfile

diginc/pi-hole:alpine

Alpine is also the default, aka latest tag. If you don't specify a tag you will get this version. This is only an x86 version and will not work on Raspberry Pi's ARM architecture.

diginc/pi-hole:debian

This version of the docker aims to be as close to a standard pi-hole installation by using the same base OS and the exact configs and scripts (minimally modified to get them working). This serves as a nice baseline for merging and testing upstream repository pi-hole changes.

diginc/pi-hole:arm

As close to the debian image as possible, but cross compiled for ARM architecture hardware through resin.io's awesome Qemu wrapper.

Alpine doesn't have an arm cross compileable image at this time.

Upgrading, Persistence, and Customizations

The standard pi-hole customization abilities apply to this docker, but with docker twists such as using docker volume mounts to map host stored file configurations over the container defaults. Volumes are also important to persist the configuration incase you have remove the pi-hole container which is a typical docker upgrade pattern.

Upgrading

If you try to use pi-hole -up it will fail. For those unfamilar, the docker way to ugprade is:

  • Throw away your container: docker rm -f pihole
    • If you care about your data (logs/customizations), make sure you have it volume mapped or it will be deleted in this step
  • Download the latest version of the image: docker pull diginc/pi-hole
  • Start your container with the newer base image: docker run ... diginc/pi-hole (whatever your original run command was)

Why is this style of upgrading good? A couple reasons: Everyone is starting from the same base image which has been tested to know it works. No worrying about upgrading from A to B, B to C, or A to C is required when rolling out updates, reducing complexity.

Volumes customizations

Here are some relevant wiki pages from pi-hole's documentation and example volume mappings to optionally add to the basic example:

  • Customizing sources for ad lists
    • -v your-adlists.list:/etc/pihole/adlists.list Your version should probably start with the existing defaults for this file.
  • Whitlisting and Blacklisting
    • -v your-whitelist:/etc/pihole/whitelist.txt Your version should probably start with the existing defaults for this file.
    • -v your-blacklist:/etc/pihole/blacklist.txt This one is empty by default

Scripts

The original pi-hole scripts are in the container so they should work via docker exec <container> <command> like so:

  • docker exec pihole_container_name pihole updateGravity
  • docker exec pihole_container_name whitelist.sh some-good-domain.com
  • docker exec pihole_container_name blacklist.sh some-bad-domain.com

Customizations

Any configuration files you volume mount into /etc/dnsmasq.d/ will be loaded by dnsmasq when the container starts or restarts or if you need to modify the pi-hole config it is located at /etc/dnsmasq.d/01-pihole.conf. The docker start scripts runs a config test prior to starting so it should tell you about any errors in the docker log.

Similarly for the webserver you can customize configs in /etc/nginx (:alpine tag) and /etc/lighttpd (:debian tag).

Development

If you plan on making a contribution please pull request to the dev branch. I also build tags of the dev branch for bug fix testing after merges have been made:

tag architecture description Dockerfile
alpine_dev x86 Alpine x86 image, small size container running nginx and dnsmasq Dockerfile
debian_dev x86 Debian x86 image, container running lighttpd and dnsmasq Dockerfile
arm_dev ARM Debian ARM image, container running lighttpd and dnsmasq built for ARM Dockerfile
Docker Pull Command
Owner
flammedemon

Comments (0)