Available for NS7

Pi-hole is a Linux network-level advertisement and Internet tracker blocking application which acts as a DNS sinkhole and optionally a DHCP server (even if it is workable, you could use the router of your network or the DHCP server of NethServer), intended for use on a private network. It is designed for use on embedded devices with network capability, such as the Raspberry Pi,but it can be used on other machines running Linux and cloud implementations.

Pi-hole has the ability to block traditional website advertisements as well as advertisements in unconventional places, such as smart TVs and mobile operating system advertisements.

nethserver-pihole relie on nethserver-docker, you will run a docker container either on the aeria network (experimental) or on the macvlan network (Recommended). Saying that the pihole container will have an IP on your network, you will just have to set in the DHCP server of your network that the DNS server is the IP of pihole

Stephane de Labrusse at stephdl@de-labrusse.fr

1-You need to install my repository, see how to do it

2-You can install pihole

yum install nethserver-pihole --enablerepo=stephdl

if you have decided to use the aeria network, please jump to the next chapter. If you want to use macvlan network, please jump to the chapter below

aqua is the network for all containers on NethServer, all containers can contact each others, the host can contact the container, it is fast and secure. You have no special network configuration to do but the hosts on your local network cannot contact directly the container of pihole. You have to set the DNS server of your host to the NethServer IP and set the container IP as the DNS server of your NethServer.

Go to the cockpit dashboard, set the IP of the DNS server to the IP 172.28.45.1 (default of the pihole container)

config setprop  docker piholeNetwork aqua
signal-event nethserver-docker-update

check the container is up : docker ps

Then use NethServer as the DNS server of your network (by adding it manually in each host or by DHCP)

Go to https://pi.hole

if you have decided to use the aeria network, please jump to the next chapter

Macvlan is particuliar network, this is the documentation for explanation, please refer there to understand: https://github.com/NethServer/nethserver-docker/blob/master/README.rst#macvlan

config setprop  docker macVlanGateway 192.168.1.1 macVlanLocalNetwork 192.168.1.0/24 macVlanNetwork 192.168.1.224/27 macVlanNic br0
signal-event nethserver-docker-update

- check macvlan is up : docker network ls - then assign macvlan to piholeNetwork and set the IP to piholeMacVlanIP (in macvlan range)

config setprop pihole piholeNetwork macvlan piholeMacVlanIP 192.168.1.234

if you have decided to use the macvlan network, please jump to the next chapter

To create the AERIA network please review https://github.com/NethServer/nethserver-docker/blob/master/README.rst#aeria-network

config setprop docker bridgeAeria br0
signal-event nethserver-docker-update

- check aeria is up : docker network ls

- then assign aeria to piholeNetwork

config setprop pihole piholeNetwork aeria

review the pihole conf : config show pihole

pihole=configuration
    DNS1=8.8.8.8    #upstream dns
    DNS2=8.8.4.4    #upstream dns
    mac=00:60:2f:0a:66:06    # once generated, it is static mac
    PhpMemoryLimit=512M
    password=admin  #web admin password
    piholeMacVlanIP=192.168.1.234
    piholeNetwork=macvlan
    timezone=UTC

- change the admin password (default is admin)

By default the password is admin, you should change it obviously, once created with a password, you must destroy the container, change the password and create it again.

config setprop docker password azertyuiop

- Modify the upstream DNS of pihole following your needs (default is google DNS)

you can adjust to different DNS if you think they are faster or DNS with adult filtering if your want to protect your kids

as example I will use cleanbrowsing.org, decide what Family or Adult filter to use (https://cleanbrowsing.org/ip-address)

If you want to filter porn, set DNS1 and DNS2 to

Family filter
    DNS1=185.228.168.168    #upstream dns
    DNS2=185.228.169.168    #upstream dns

Adult filter
    DNS1=185.228.168.10    #upstream dns
    DNS2=185.228.169.11    #upstream dns

set DNS1 and DNS2 accordingly

config setprop pihole DNS1 185.228.168.168 DNS2 185.228.169.168

or

config setprop pihole DNS1 185.228.168.10 DNS2 185.228.169.11

- trigger the event to create the container

signal-event nethserver-pihole-update

- The time depends of your internet bandwith

- check docker pihole is up :

docker ps

pihole status

The php memory limit for CGI is set to 512M, this should be good but when you browse the long-term data graphs you might need to increase it

config setprop pihole PhpMemoryLimit 1024M
signal-event nethserver-pihole-update
pihole upgrade

Please RTFM: https://docs.pi-hole.net/

Once installed pihole is available at the ip of the container, to find it do pihole ip in the terminal, use the IP of the container in your browser, then log with the credential admin and the password set in the password esmith property

To use Pi-Hole, make sure that your devices use Pi-Hole's IP address as their only DNS server. To accomplish this, there are generally 2 methods to make it happen:

1. In router's LAN DHCP settings, set Pi-Hole's IP address as the only DNS server available for connected devices.
2. Manually configure each device to use Pi-Hole's IP address as their only DNS server.

Note: Some routers (or even ISPs) do not allow to change LAN DNS settings, so you might want to disable router's DHCP server and use the NetHServer built in DHCP server instead. More information about making other devices use Pi-Hole can be found at upstream documentation.

do pihole in your terminal to get help

pihole facilities wrapper to docker command

  pihole ip : find the IP of pihole given by your dhcp server for aeria network
  pihole status : retrieve the status of pihole container
  pihole env : retrieve all the environment vars of the container
  pihole bash : start a shell inside the container
  pihole start: Start the pihole container
  pihole stop: Stop the pihole container
  pihole destroy: Delete the pihole container
  pihole build: Delete then create the pihole container
  pihole upgrade: Upgrade docker image, delete then create the pihole container
  pihole ps: Container information
  pihole log: Display the error log of the container

As many docker container the upgrade of a container means you must destroy it before

pihole upgrade

Upgrade the docker image, delete then build again the container

All the container data are in /var/lib/pihole, it is included in the backup-data of your NethServer if used.

Please raise Issues on github