Merge pull request #106 from diginc/README

Web Password and updated documentation

bash_functions.sh

@@ -108,6 +108,14 @@ setup_php_env_alpine() {
     cat "$PHP_ENV_CONFIG"
 }
 
+setup_web_password() {
+    if [ -z "${WEBPASSWORD+x}" ] ; then 
+        # Not set at all, give the user a random pass
+        WEBPASSWORD=$(tr -dc _A-Z-a-z-0-9 < /dev/urandom | head -c 8)
+        echo "Assigning random password: $WEBPASSWORD"
+    fi;
+    pihole -a -p "$WEBPASSWORD"
+}
 setup_ipv4_ipv6() {
     local ip_versions="IPv4 and IPv6"
     if [ "$IPv6" != "True" ] ; then

docker_run.sh

@@ -8,4 +8,5 @@ docker run -p 53:53/tcp -p 53:53/udp -p 80:80 \
   --cap-add=NET_ADMIN \
   -e ServerIP="$IP" \
   --name pihole \
+  --restart=always \
   -d "$IMAGE"

doco-alpine.yml

@@ -11,3 +11,4 @@ services:
       - "80:80/tcp"
     cap_add:
       - NET_ADMIN
+    restart: always

doco-debian.yml

@@ -10,3 +10,4 @@ debian:
     - "80:80/tcp"
   cap_add:
     - NET_ADMIN
+  restart: always

doco-example.yml

@@ -23,3 +23,4 @@ pihole:
     # WARNING: if this log don't exist as a file on the host already
     # docker will try to create a directory in it's place making for lots of errors
     # - '/var/log/pihole.log:/var/log/pihole.log'
+  restart: always

start.sh

@@ -20,6 +20,7 @@ validate_env
 prepare_setup_vars
 change_setting "IPV4_ADDRESS" "$ServerIP"
 change_setting "IPV6_ADDRESS" "$ServerIPv6"
+setup_web_password "$WEBPASSWORD"
 setup_dnsmasq_dns "$DNS1" "$DNS2"
 setup_php_env
 setup_dnsmasq_hostnames "$ServerIP" "$ServerIPv6" "$HOSTNAME"

test/test_bash_functions.py

@@ -57,3 +57,23 @@ def test_debian_setup_php_env(Docker, tag, expected_lines, repeat_function):
         search_config_cmd = "grep -c '{}' /etc/lighttpd/conf-enabled/15-fastcgi-php.conf".format(expected_line)
         search_config_count = Docker.run(search_config_cmd)
         assert search_config_count.stdout.rstrip('\n') == '1'
+
+@pytest.mark.parametrize('args,secure,setupVarsHash', [
+    ('-e ServerIP=1.2.3.4 -e WEBPASSWORD=login', True, 'WEBPASSWORD=6060d59351e8c2f48140f01b2c3f3b61652f396c53a5300ae239ebfbe7d5ff08'),
+    ('-e ServerIP=1.2.3.4 -e WEBPASSWORD=""', False, ''),
+    ('-e ServerIP=1.2.3.4', True, 'WEBPASSWORD='),
+])
+def test_webPassword_env_assigns_password_to_file(Docker, args, secure, setupVarsHash):
+    ''' When a user sets webPassword env the admin password gets set to that '''
+    function = Docker.run('. /bash_functions.sh ; eval `grep setup_web_password /start.sh`')
+    if secure and 'WEBPASSWORD' not in args:
+        assert 'Assigning random password' in function.stdout
+    else:
+        assert 'Assigning random password' not in function.stdout
+
+    if secure:
+        assert 'New password set' in function.stdout
+        assert Docker.run('grep -q \'{}\' {}'.format(setupVarsHash, '/etc/pihole/setupVars.conf')).rc == 0
+    else:
+        assert 'Password removed' in function.stdout
+        assert Docker.run('grep -q \'^WEBPASSWORD=$\' /etc/pihole/setupVars.conf').rc == 0