add nginx basic authentication

Author: xavier-hernandez

Dockerfile

@@ -21,6 +21,7 @@ RUN apk add --no-cache \
         tini \
         wget \
         curl \
+        apache2-utils\
         libmaxminddb \
         ncurses && \
     rm -rf /var/lib/apt/lists/* && \
@@ -33,6 +34,7 @@ COPY /resources/goaccess/GeoLite2-City.mmdb /goaccess-config/GeoLite2-City.mmdb
 # set up nginx
 COPY /resources/nginx/index.html /var/www/html/index.html
 COPY /resources/nginx/nginx.conf /etc/nginx/nginx.conf
+ADD /resources/nginx/.htpasswd /opt/auth/.htpasswd
 
 COPY /resources/scripts/start.sh /start.sh
 VOLUME ["/opt/log"]

README.md

@@ -42,7 +42,10 @@ goaccess:
     restart: always
     environment:
         - TZ=America/New_York
-        - SKIP_ARCHIVED_LOGS=False #optional        
+        - SKIP_ARCHIVED_LOGS=False #optional   
+        - BASIC_AUTH=False #optional
+        - BASIC_AUTH_USERNAME=user #optional
+        - BASIC_AUTH_PASSWORD=pass #optional                
     ports:
         - '7880:7880'
     volumes:
@@ -62,12 +65,18 @@ goaccess:
         - PUID=0
         - PGID=0
         - TZ=America/New_York        
-        - SKIP_ARCHIVED_LOGS=False #optional        
+        - SKIP_ARCHIVED_LOGS=False #optional
+        - BASIC_AUTH=False #optional
+        - BASIC_AUTH_USERNAME=user #optional
+        - BASIC_AUTH_PASSWORD=pass #optional               
 ```
 
 | Parameter | Function |
 |-----------|----------|
 | `-e SKIP_ARCHIVED_LOGS=True/False`         |   (Optional) Defaults to False. Set to True to skip archived logs, i.e. proxy-host*.gz     |
+| `-e BASIC_AUTH=True/False`         |   (Optional) Defaults to False. Set to True to enable nginx basic authentication.     |
+| `-e BASIC_AUTH_USERNAME=user`         |   (Optional) Requires BASIC_AUTH to bet set to True.  Username for basic authentication.     |
+| `-e BASIC_AUTH_PASSWORD=pass`         |   (Optional) Requires BASIC_AUTH to bet set to True.  Password for basic authentication.     |
 
 Thanks to https://github.com/GregYankovoy for the inspiration, and for their nginx.conf :)
 

resources/nginx/.htpasswd

@@ -24,6 +24,7 @@ http {
     access_log off;
 
     location / {
+      #goan_authbasic
       try_files /nonexistent @$type;
     }
 

resources/nginx/nginx.conf

@@ -1,5 +1,22 @@
 #!/bin/bash
 
+#BEGIN - Set NGINX basic authentication
+if [[ "${BASIC_AUTH}" == "True" ]]
+then
+    echo "Setting up basic auth in NGINX..."
+    if [[ -z "$BASIC_AUTH_USERNAME" || -z "$BASIC_AUTH_PASSWORD" ]]
+    then
+        echo "Username or password is blank or not set."
+    else
+        nginx_auth_basic_s="#goan_authbasic"
+        nginx_auth_basic_r="auth_basic    \"GoAccess WebUI\";\n      auth_basic_user_file \/opt\/auth\/.htpasswd; \n"
+        sed -i "s/$nginx_auth_basic_s/$nginx_auth_basic_r/" /etc/nginx/nginx.conf
+
+        htpasswd -b /opt/auth/.htpasswd $BASIC_AUTH_USERNAME $BASIC_AUTH_PASSWORD
+    fi
+fi
+#END - Set NGINX basic authentication
+
 #BEGIN - Load archived logs
 if [[ "${SKIP_ARCHIVED_LOGS}" == "True" ]]
 then