unifios-utilities/run-pihole

Run Pi-hole on your UDM

Features

1. Run Pi-hole on your UDM with a completely isolated network stack. This will not port conflict or be influenced by any changes on by Ubiquiti
2. Persists through reboots and firmware updates.

Requirements

1. You have successfully setup the on boot script described here

Customization

• Feel free to change 20-dns.conflist to change the IP address and MAC address of the container.
• Update 10-dns.sh with your own values
• If you want IPv6 support use 20-dnsipv6.conflist and update 10-dns.sh with the IPv6 addresses. Also, please provide IPv6 servers to podman using --dns arguments.

Steps

1. Copy 05-install-cni-plugins.sh to /mnt/data/on_boot.d

2. Execute /mnt/data/on_boot.d/05-install-cni-plugins.sh

3. On your controller, make a Corporate network with no DHCP server and give it a VLAN. For this example we are using VLAN 5.

4. Copy 20-dns.conflist to /mnt/data/podman/cni. This will create your podman macvlan network

5. Copy 10-dns.sh to /mnt/data/on_boot.d and update its values to reflect your environment

   ...
   VLAN=5
   IPV4_IP="10.0.5.3"
   IPV4_GW="10.0.5.1/24"
   ...
   CONTAINER=pihole
   ...
   

6. Execute /mnt/data/on_boot.d/10-dns.sh

7. Create directories for persistent Pi-hole configuration

   mkdir -p /mnt/data/etc-pihole
   mkdir -p /mnt/data/pihole/etc-dnsmasq.d
   

8. Create and run the Pi-hole docker container. The following command sets the upstream DNS servers to 1.1.1.1 and 8.8.8.8.

    podman run -d --network dns --restart always \
       --name pihole \
       -e TZ="America/Los Angeles" \
       -v "/mnt/data/etc-pihole/:/etc/pihole/" \
       -v "/mnt/data/pihole/etc-dnsmasq.d/:/etc/dnsmasq.d/" \
       --dns=127.0.0.1 \
       --dns=1.1.1.1 \
       --dns=8.8.8.8 \
       --hostname pi.hole \
       -e VIRTUAL_HOST="pi.hole" \
       -e PROXY_LOCATION="pi.hole" \
       -e ServerIP="10.0.5.3" \
       -e IPv6="False" \
       pihole/pihole:latest
   

   The below errors are expected and acceptable

      ```sh
      ERRO[0022] unable to get systemd connection to add healthchecks: dial unix /run/systemd/private: connect: no such file or directory
      ERRO[0022] unable to get systemd connection to start healthchecks: dial unix /run/systemd/private: connect: no such file or directory
      ```
   

9. Set pihole password

   podman exec -it pihole pihole -a -p YOURNEWPASSHERE
   

10. Update your DNS Servers to 10.0.5.3 (or your custom ip) for each of your Networks (UDM GUI | Networks | Advanced | DHCP Name Server)

11. Access the pihole like you would normally, e.g. http://10.0.5.3 if using examples above

Upgrading your PiHole container

1. Edit upd_pihole.sh script to use the same podman run command you used at installation.
2. Copy the upd_pihole.sh script to /mnt/data/scripts
3. Anytime you want to update your pihole installation, simply run /mnt/data/scripts/upd_pihole.sh

PiHole with CloudFlareD Command

 podman run -d --network dns --restart always \
    --name pihole \
    -e TZ="America/Los Angeles" \
    -v "/mnt/data/etc-pihole/:/etc/pihole/" \
    -v "/mnt/data/pihole/etc-dnsmasq.d/:/etc/dnsmasq.d/" \
    --dns=127.0.0.1 \
    --dns=1.1.1.1 \
    --hostname pi.hole \
    -e CLOUDFLARED_OPTS="--port 5053 --address 0.0.0.0" \
    -e VIRTUAL_HOST="pi.hole" \
    -e PROXY_LOCATION="pi.hole" \
    -e ServerIP="10.0.5.3" \
    -e PIHOLE_DNS_="127.0.0.1#5053" \
    -e IPv6="False" \
    boostchicken/pihole:latest

PiHole with DoTe

 podman run -d --network dns --restart always \
 --name pihole \
 -e TZ="America/Los Angeles" \
 -v "/mnt/data/etc-pihole/:/etc/pihole/" \
 -v "/mnt/data/pihole/etc-dnsmasq.d/:/etc/dnsmasq.d/" \
 --dns=127.0.0.1 \
 --dns=1.1.1.1 \
 --hostname pi.hole \
 -e CLOUDFLARED_OPTS="--port 5053 --address 0.0.0.0" \
 -e VIRTUAL_HOST="pi.hole" \
 -e PROXY_LOCATION="pi.hole" \
 -e ServerIP="10.0.5.3" \
 -e PIHOLE_DNS_="127.0.0.1#5053" \
 -e IPv6="False" \
 boostchicken/pihole-dote:latest

The cloudflared command is written in Go and is not very lightweight. In my experience, it's not made for long-term running. Instead, the project DoTe has a tiny memory footprint and operates on an event loop with some major optimisations for connection caching. It allows you to forward traffic to any DNS-over-TLS provider.

Migration Instructions

Simply copy the upd_pihole_dote.sh script to /mnt/data/scripts and run it to forward all DNS traffic over TLS to Cloudflare 1.1.1.1. You can modify the script to forward to different services with ease and full configuration options including certificate pinning is available in the DoTe README here: https://github.com/chrisstaite/DoTe/

New releases will be made when PiHole updates their labels