Merge pull request pi-hole#741 from pi-hole/dev

v5.2.2 and various to master

Author: PromoFaux

CONTRIBUTING.md

@@ -6,5 +6,5 @@ Please review the following before opening a pull request (PR) to help your PR g
   * To ensure proper testing and quality control, target any code change pull requests against `dev` branch.
 
 * Make sure the tests pass
-  * Take a look at [TESTING.md](TESTING.md) to see how to run tests locally so you do not have to push all your code to a PR and have travis-ci run it.  
+  * Take a look at [TESTING.md](TESTING.md) to see how to run tests locally so you do not have to push all your code to a PR and have GitHub Actions run it.
   * Your tests will probably run faster locally and you get a faster feedback loop.

README.md

@@ -102,8 +102,7 @@ There are other environment variables if you want to customize various things in
 | `ADMIN_EMAIL: <email address>`<br/> *Optional Default: ''* | Set an administrative contact address for the Block Page
 | `TZ: <Timezone>`<br/> **Recommended** *Default: UTC* | Set your [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) to make sure logs rotate at local midnight instead of at UTC midnight.
 | `WEBPASSWORD: <Admin password>`<br/> **Recommended** *Default: random* | http://pi.hole/admin password. Run `docker logs pihole \| grep random` to find your random pass.
-| `DNS1: <IP>`<br/> *Optional* *Default: 8.8.8.8* | Primary upstream DNS provider, default is google DNS
-| `DNS2: <IP>`<br/> *Optional* *Default: 8.8.4.4* | Secondary upstream DNS provider, default is google DNS, `no` if only one DNS should used
+| `PIHOLE_DNS_: <IPs delimited by ;>`<br/> *Optional* *Default: 8.8.8.8;8.8.4.4* | Upstream DNS server(s) for Pi-hole to forward queries to, seperated by a semicolon <br/> (supports non-standard ports with `#[port number]`) e.g `127.0.0.1#5053;8.8.8.8;8.8.4.4`
 | `DNSSEC: <"true"\|"false">`<br/> *Optional* *Default: "false"* | Enable DNSSEC support
 | `DNS_BOGUS_PRIV: <"true"\|"false">`<br/> *Optional* *Default: "true"* | Enable forwarding of reverse lookups for private ranges
 | `DNS_FQDN_REQUIRED: <"true"\|"false">`<br/> *Optional* *Default: true* | Never forward non-FQDNs
@@ -122,6 +121,7 @@ There are other environment variables if you want to customize various things in
 | `TEMPERATUREUNIT`: <c\|k\|f><br/>*Optional Default: c* | Set preferred temperature unit to `c`: Celsius, `k`: Kelvin, or `f` Fahrenheit units.
 | `WEBUIBOXEDLAYOUT: <boxed\|traditional>`<br/>*Optional Default: boxed* | Use boxed layout (helpful when working on large screens)
 | `SKIPGRAVITYONBOOT`: <Not Set\|1><br/> *Optional Default: Not Set* | Use this option to skip updating the Gravity Database when booting up the container.  By default this environment variable is not set so the Gravity Database will be updated when the container starts up.  Setting this environment variable to 1 (or anything) will cause the Gravity Database to not be updated when container starts up.
+| `QUERY_LOGGING: <"true"\|"false">`<br/> *Optional* *Default: "true"* | Enable query logging or not.
 
 ## Deprecated environment variables:
 While these may still work, they are likely to be removed in a future version. Where applicible, alternative variable names are indicated. Please review the table above for usage of the alternative variables
@@ -130,8 +130,10 @@ While these may still work, they are likely to be removed in a future version. W
 | ----------------------- | ----------- | ----------- |
 | `CONDITIONAL_FORWARDING: <"true"\|"false">`<br/> *Optional* *Default: "false"* | Enable DNS conditional forwarding for device name resolution | `REV_SERVER`|
 | `CONDITIONAL_FORWARDING_IP: <Router's IP>`<br/> *Optional* | If conditional forwarding is enabled, set the IP of the local network router | `REV_SERVER_TARGET` |
-| `CONDITIONAL_FORWARDING_DOMAIN: <Network Domain>`<br/> *Optional* | If conditional forwarding is enabled, set the domain of the local network router | `REV_SERVER_DOMAIN` | 
+| `CONDITIONAL_FORWARDING_DOMAIN: <Network Domain>`<br/> *Optional* | If conditional forwarding is enabled, set the domain of the local network router | `REV_SERVER_DOMAIN` |
 | `CONDITIONAL_FORWARDING_REVERSE: <Reverse DNS>`<br/> *Optional* | If conditional forwarding is enabled, set the reverse DNS of the local network router (e.g. `0.168.192.in-addr.arpa`) | `REV_SERVER_CIDR` |
+| `DNS1: <IP>`<br/> *Optional* *Default: 8.8.8.8* | Primary upstream DNS provider, default is google DNS | `PIHOLE_DNS_` |
+| `DNS2: <IP>`<br/> *Optional* *Default: 8.8.4.4* | Secondary upstream DNS provider, default is google DNS, `no` if only one DNS should used | `PIHOLE_DNS_` |
 
 To use these env vars in docker run format style them like: `-e DNS1=1.1.1.1`
 

TESTING.md

@@ -1,22 +1,24 @@
 # Prerequisites 
 
-Make sure you have bash, docker.  Python and some test hacks are crammed into the `Dockerfile_build` file for now.  Revisions in the future may re-enable running python on your host (not just in docker).
+Make sure you have bash & docker.  
+Python and some test hacks are crammed into the `Dockerfile_build` file for now.  
+Revisions in the future may re-enable running python on your host (not just in docker).
 
 # Running tests locally
 
 `ARCH=amd64 ./gh-actions-test.sh`
 
-Should result in :
+Should result in:
 
-- An image named `pihole:amd64` being build
-- Tests being ran to confirm the image doesnt have any regressions
+- An image named `pihole:amd64` being built
+- Tests being ran to confirm the image doesn't have any regressions
 
 # Local image names
 
 Docker images built by `Dockerfile.py` are named the same but stripped of the `pihole/` docker repository namespace.
 
 e.g. `pi-hole:debian_amd64` or `pi-hole-multiarch:debian_arm64`
 
-You can run the multiarch images on an amd64 development system if you [enable binfmt-support as described in the multiarch image docs](https://hub.docker.com/r/multiarch/multiarch/debian-debootstrap/)
+You can run the multiarch images on an amd64 development system if you [enable binfmt-support as described in the multiarch image docs](https://hub.docker.com/r/multiarch/debian-debootstrap/)
 
 `docker run --rm --privileged multiarch/qemu-user-static:register --reset`

VERSION

@@ -1 +1 @@
-v5.2.1
+v5.2.2

bash_functions.sh

@@ -66,43 +66,6 @@ validate_env() {
     fi;
 }
 
-setup_dnsmasq_dns() {
-    . /opt/pihole/webpage.sh
-    local DNS1="${1:-8.8.8.8}"
-    local DNS2="${2:-8.8.4.4}"
-    local dnsType='default'
-    if [ "$DNS1" != '8.8.8.8' ] || [ "$DNS2" != '8.8.4.4' ] ; then
-        dnsType='custom'
-    fi;
-
-    # TODO With the addition of this to /start.sh this needs a refactor
-    if [ ! -f /.piholeFirstBoot ] ; then
-        local setupDNS1="$(grep 'PIHOLE_DNS_1' ${setupVars})"
-        local setupDNS2="$(grep 'PIHOLE_DNS_2' ${setupVars})"
-        setupDNS1="${setupDNS1/PIHOLE_DNS_1=/}"
-        setupDNS2="${setupDNS2/PIHOLE_DNS_2=/}"
-        if [[ -n "$DNS1" && -n "$setupDNS1"  ]] || \
-           [[ -n "$DNS2" && -n "$setupDNS2"  ]] ; then
-                echo "Docker DNS variables not used"
-        fi
-        echo "Existing DNS servers used (${setupDNS1:-unset} & ${setupDNS2:-unset})"
-        return
-    fi
-
-    echo "Using $dnsType DNS servers: $DNS1 & $DNS2"
-    if [[ -n "$DNS1" && -z "$setupDNS1" ]] ; then
-        change_setting "PIHOLE_DNS_1" "${DNS1}"
-    fi
-    if [[ -n "$DNS2" && -z "$setupDNS2" ]] ; then
-        if [[ "$DNS2" == "no" ]] ; then
-            delete_setting "PIHOLE_DNS_2"
-            unset PIHOLE_DNS_2
-        else
-            change_setting "PIHOLE_DNS_2" "${DNS2}"
-        fi
-    fi
-}
-
 setup_dnsmasq_interface() {
     local interface="${1:-eth0}"
     local interfaceType='default'
@@ -129,13 +92,10 @@ setup_dnsmasq_config_if_missing() {
 }
 
 setup_dnsmasq() {
-    local dns1="$1"
-    local dns2="$2"
-    local interface="$3"
-    local dnsmasq_listening_behaviour="$4"
+    local interface="$1"
+    local dnsmasq_listening_behaviour="$2"
     # Coordinates
     setup_dnsmasq_config_if_missing
-    setup_dnsmasq_dns "$dns1" "$dns2"
     setup_dnsmasq_interface "$interface"
     setup_dnsmasq_listening_behaviour "$dnsmasq_listening_behaviour"
     setup_dnsmasq_user "${DNSMASQ_USER}"

build.yml

@@ -5,7 +5,7 @@ x-common-args: &common-args
   PIHOLE_VERSION: ${PIHOLE_VERSION}
   NAME: pihole/pihole
   MAINTAINER: [email protected]
-  S6_VERSION: v1.22.1.0
+  S6_VERSION: v2.1.0.2
   PHP_ENV_CONFIG: /etc/lighttpd/conf-enabled/15-fastcgi-php.conf
   PHP_ERROR_LOG: /var/log/lighttpd/error.log
 

docker-pi-hole.cron

@@ -22,7 +22,7 @@ PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
 #          Download any updates from the adlists
 59 1    * * 7   root    PATH="$PATH:/usr/local/bin/" docker exec $DOCKER_NAME pihole updateGravity > /dev/null
 
-# Update docker-pi-hole by pulling the latest docker image ane re-creating your container.
+# Update docker-pi-hole by pulling the latest docker image and re-creating your container.
 # pihole software update commands are unsupported in docker!
 #30 2    * * 7   root    PATH="$PATH:/usr/local/bin/" docker exec $DOCKER_NAME pihole updatePihole > /dev/null
 

start.sh

@@ -28,6 +28,8 @@ export CONDITIONAL_FORWARDING_REVERSE
 export TEMPERATUREUNIT
 export ADMIN_EMAIL
 export WEBUIBOXEDLAYOUT
+export QUERY_LOGGING
+export PIHOLE_DNS_
 
 export adlistFile='/etc/pihole/adlists.list'
 
@@ -54,35 +56,71 @@ load_web_password_secret
 generate_password
 validate_env || exit 1
 prepare_configs
-change_setting "PIHOLE_INTERFACE" "$PIHOLE_INTERFACE"
-change_setting "IPV4_ADDRESS" "$IPV4_ADDRESS"
-change_setting "QUERY_LOGGING" "$QUERY_LOGGING"
-change_setting "INSTALL_WEB_SERVER" "$INSTALL_WEB_SERVER"
-change_setting "INSTALL_WEB_INTERFACE" "$INSTALL_WEB_INTERFACE"
-change_setting "LIGHTTPD_ENABLED" "$LIGHTTPD_ENABLED"
-change_setting "IPV4_ADDRESS" "$ServerIP"
-change_setting "IPV6_ADDRESS" "$ServerIPv6"
-change_setting "DNS_BOGUS_PRIV" "$DNS_BOGUS_PRIV"
-change_setting "DNS_FQDN_REQUIRED" "$DNS_FQDN_REQUIRED"
-change_setting "DNSSEC" "$DNSSEC"
-change_setting "REV_SERVER" "$REV_SERVER"
-change_setting "REV_SERVER_DOMAIN" "$REV_SERVER_DOMAIN"
-change_setting "REV_SERVER_TARGET" "$REV_SERVER_TARGET"
-change_setting "REV_SERVER_CIDR" "$REV_SERVER_CIDR"
+
+[ -n "${PIHOLE_INTERFACE}" ] && change_setting "PIHOLE_INTERFACE" "$PIHOLE_INTERFACE"
+[ -n "${IPV4_ADDRESS}" ] && change_setting "IPV4_ADDRESS" "$IPV4_ADDRESS"
+[ -n "${QUERY_LOGGING}" ] && change_setting "QUERY_LOGGING" "$QUERY_LOGGING"
+[ -n "${INSTALL_WEB_SERVER}" ] && change_setting "INSTALL_WEB_SERVER" "$INSTALL_WEB_SERVER"
+[ -n "${INSTALL_WEB_INTERFACE}" ] && change_setting "INSTALL_WEB_INTERFACE" "$INSTALL_WEB_INTERFACE"
+[ -n "${LIGHTTPD_ENABLED}" ] && change_setting "LIGHTTPD_ENABLED" "$LIGHTTPD_ENABLED"
+[ -n "${ServerIP}" ] && change_setting "IPV4_ADDRESS" "$ServerIP"
+[ -n "${ServerIPv6}" ] && change_setting "IPV6_ADDRESS" "$ServerIPv6"
+[ -n "${DNS_BOGUS_PRIV}" ] && change_setting "DNS_BOGUS_PRIV" "$DNS_BOGUS_PRIV"
+[ -n "${DNS_FQDN_REQUIRED}" ] && change_setting "DNS_FQDN_REQUIRED" "$DNS_FQDN_REQUIRED"
+[ -n "${DNSSEC}" ] && change_setting "DNSSEC" "$DNSSEC"
+[ -n "${REV_SERVER}" ] && change_setting "REV_SERVER" "$REV_SERVER"
+[ -n "${REV_SERVER_DOMAIN}" ] && change_setting "REV_SERVER_DOMAIN" "$REV_SERVER_DOMAIN"
+[ -n "${REV_SERVER_TARGET}" ] && change_setting "REV_SERVER_TARGET" "$REV_SERVER_TARGET"
+[ -n "${REV_SERVER_CIDR}" ] && change_setting "REV_SERVER_CIDR" "$REV_SERVER_CIDR"
+
 if [ -z "$REV_SERVER" ];then
     # If the REV_SERVER* variables are set, then there is no need to add these.
     # If it is not set, then adding these variables is fine, and they will be converted by the Pi-hole install script
-    change_setting "CONDITIONAL_FORWARDING" "$CONDITIONAL_FORWARDING"
-    change_setting "CONDITIONAL_FORWARDING_IP" "$CONDITIONAL_FORWARDING_IP"
-    change_setting "CONDITIONAL_FORWARDING_DOMAIN" "$CONDITIONAL_FORWARDING_DOMAIN"
-    change_setting "CONDITIONAL_FORWARDING_REVERSE" "$CONDITIONAL_FORWARDING_REVERSE"
+    [ -n "${CONDITIONAL_FORWARDING}" ] && change_setting "CONDITIONAL_FORWARDING" "$CONDITIONAL_FORWARDING"
+    [ -n "${CONDITIONAL_FORWARDING_IP}" ] && change_setting "CONDITIONAL_FORWARDING_IP" "$CONDITIONAL_FORWARDING_IP"
+    [ -n "${CONDITIONAL_FORWARDING_DOMAIN}" ] && change_setting "CONDITIONAL_FORWARDING_DOMAIN" "$CONDITIONAL_FORWARDING_DOMAIN"
+    [ -n "${CONDITIONAL_FORWARDING_REVERSE}" ] && change_setting "CONDITIONAL_FORWARDING_REVERSE" "$CONDITIONAL_FORWARDING_REVERSE"
+fi
+
+if [ -z "${PIHOLE_DNS_}" ]; then
+    # For backward compatibility, if DNS1 and/or DNS2 are set, but PIHOLE_DNS_ is not, convert them to
+    # a semi-colon delimited string and store in PIHOLE_DNS_
+    # They are not used anywhere if PIHOLE_DNS_ is set already
+    [ -n "${DNS1}" ] && echo "Converting DNS1 to PIHOLE_DNS_" && PIHOLE_DNS_="$DNS1"
+    [[ -n "${DNS2}" && "${DNS2}" != "no" ]] && echo "Converting DNS2 to PIHOLE_DNS_" && PIHOLE_DNS_="$PIHOLE_DNS_;$DNS2"
 fi
+
+# Parse the PIHOLE_DNS variable, if it exists, and apply upstream servers to Pi-hole config
+if [ -n "${PIHOLE_DNS_}" ]; then
+    echo "Setting DNS servers based on PIHOLE_DNS_ variable"
+    # Split into an array (delimited by ;)
+    PIHOLE_DNS_ARR=(${PIHOLE_DNS_//;/ })
+    count=1
+    for i in "${PIHOLE_DNS_ARR[@]}"; do
+        change_setting "PIHOLE_DNS_$count" "$i"
+        ((count=count+1))
+    done
+else
+    # Environment variable has not been set, but there may be existing values in an existing setupVars.conf
+    # if this is the case, we do not want to overwrite these with the defaults of 8.8.8.8 and 8.8.4.4
+    # Pi-hole can run with only one upstream configured, so we will just check for one.
+    setupVarsDNS="$(grep 'PIHOLE_DNS_' /etc/pihole/setupVars.conf || true)"
+
+    if [ -z "${setupVarsDNS}" ]; then
+      echo "Configuring default DNS servers: 8.8.8.8, 8.8.4.4"
+      change_setting "PIHOLE_DNS_1" "8.8.8.8"
+      change_setting "PIHOLE_DNS_2" "8.8.4.4"
+    else
+      echo "Existing DNS servers detected in setupVars.conf. Leaving them alone"
+    fi
+fi
+
 setup_web_port "$WEB_PORT"
 setup_web_password "$WEBPASSWORD"
 setup_temp_unit "$TEMPERATUREUNIT"
 setup_ui_layout "$WEBUIBOXEDLAYOUT"
 setup_admin_email "$ADMIN_EMAIL"
-setup_dnsmasq "$DNS1" "$DNS2" "$INTERFACE" "$DNSMASQ_LISTENING_BEHAVIOUR"
+setup_dnsmasq "$INTERFACE" "$DNSMASQ_LISTENING_BEHAVIOUR"
 setup_php_env
 setup_dnsmasq_hostnames "$ServerIP" "$ServerIPv6" "$HOSTNAME"
 setup_ipv4_ipv6