Merge branch 'develop' into main

Author: xavier-hernandez

.gitignore

@@ -0,0 +1 @@
+**/.DS_Store

Dockerfile

@@ -45,4 +45,4 @@ COPY /resources/scripts/start.sh start.sh
 
 VOLUME ["/opt/log"]
 EXPOSE 7880
-CMD ["sh", "/goan/start.sh"]
+CMD ["bash", "/goan/start.sh"]

README.md

@@ -18,7 +18,7 @@ The docker image scans and includes files matching the following criteria:
 
 **Dependencies:**
 - GoAccess version: 1.5.5  
-- GeoLite2-City.mmdb  (2022-04-26)
+- GeoLite2-City.mmdb  (2022-05-27)
 
 ---
 
@@ -51,7 +51,8 @@ goaccess:
         - DEBUG=False #optional
         - BASIC_AUTH=False #optional
         - BASIC_AUTH_USERNAME=user #optional
-        - BASIC_AUTH_PASSWORD=pass #optional                
+        - BASIC_AUTH_PASSWORD=pass #optional
+        - EXCLUDE_IPS=127.0.0.1 #comma delimited list                
     ports:
         - '7880:7880'
     volumes:
@@ -75,7 +76,8 @@ goaccess:
         - DEBUG=False #optional
         - BASIC_AUTH=False #optional
         - BASIC_AUTH_USERNAME=user #optional
-        - BASIC_AUTH_PASSWORD=pass #optional               
+        - BASIC_AUTH_PASSWORD=pass #optional   
+        - EXCLUDE_IPS=127.0.0.1 #comma delimited 
 ```
 
 | Parameter | Function |
@@ -85,6 +87,7 @@ goaccess:
 | `-e BASIC_AUTH=True/False`         |   (Optional) Defaults to False. Set to True to enable nginx basic authentication.  Docker container needs to stopped or restarted each time this flag is modified. This allows for the .htpasswd file to be changed accordingly.   |
 | `-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.     |
+| `-e EXCLUDE_IPS=`         |   (Optional) IP Addresses or range of IPs delimited by comma refer to https://goaccess.io/man. For example: 192.168.0.1-192.168.0.100 or 127.0.0.1,192.168.0.1-192.168.0.100   |
 
 Thanks to https://github.com/GregYankovoy for the inspiration, and for their nginx.conf :)
 

resources/goaccess/GeoLite2-City.mmdb

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+#Exclude IPs
+function exclude_ips() {
+    if [[ -z "${EXCLUDE_IPS}" ]]
+    then
+        //no excluded ips
+    else
+        echo -e "\nExcluding IPs..."
+        ips=""
+
+        echo $'\n' >> /goaccess-config/goaccess.conf
+        echo "#GOAN_EXCLUDE_IPS" >> /goaccess-config/goaccess.conf
+        IFS=','
+        read -ra ADDR <<< "$EXCLUDE_IPS"
+        for ip in "${ADDR[@]}"; do
+            echo ${ip}
+            echo "exclude-ip ${ip}" >> /goaccess-config/goaccess.conf
+        done
+        unset IFS
+    fi
+}
+
+#Set NGINX basic authentication
+function nginx_basic_auth() {
+    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
+}
+
+#ADD DEBUGGING
+function debug() {
+    if [[ "${DEBUG}" == "True" ]]
+    then
+        echo -e "\nDEBUG - ON"
+        cp /goan/debug/goaccess_conf.html /var/www/html/goaccess_conf.html
+
+        src="#goan_version"
+        rpl=${goan_version}
+        sed -i "s/$src/$rpl/" /var/www/html/goaccess_conf.html
+
+        sed -i -e '/#GOAN_INPUT/r /goaccess-config/goaccess.conf' /var/www/html/goaccess_conf.html
+        sed -i -e 's/#GOAN_INPUT//' /var/www/html/goaccess_conf.html
+    else
+        echo "DEBUG - OFF"
+    fi
+}
+
+#Find active logs and check for read access
+function logs_load_archive() {
+    touch ${goan_container_archive_log}
+
+    if [[ "${SKIP_ARCHIVED_LOGS}" == "True" ]]
+    then
+        echo "Skipping archived logs as requested..."
+    else
+        if [[ -d "${1}" && -x "${1}" ]];
+        then
+            count=`ls -1 ${1}/proxy-host-*_access.log*.gz | wc -l`
+            if [ $count != 0 ]
+            then 
+                echo "Loading (${count}) archived logs from ${1}..."
+                zcat -f ${1}/proxy-host-*_access.log*.gz > ${goan_container_archive_log}
+                echo  "log-file ${goan_container_archive_log}" >> ${goan_container_proxy_logs}
+            else
+                echo "No archived logs found at ${1}..."
+            fi
+            goan_proxy_archive_log_count=$((count))
+        else
+            echo "Problem loading directory (check directory or permissions)... ${1}"
+        fi
+    fi
+}

resources/scripts/funcs/debug.sh

@@ -1,6 +1,17 @@
 #!/bin/bash
 
-#Find active logs and check for read access
+function nginx_image_version() {
+    src="#goan_version"
+    rpl=${goan_version}
+    sed -i "s/$src/$rpl/" /var/www/html/index.html
+}
+
+function nginx_processing_count() {
+    src="#goan_processing_count"
+    rpl=$((goan_proxy_log_count+goan_proxy_archive_log_count))
+    sed -i "s/$src/$rpl/" /var/www/html/index.html
+}
+
 function logs_load_active() {
     echo "Checking active logs..."
     if [[ -d "${1}" && -x "${1}" ]];
@@ -37,30 +48,4 @@ function logs_load_active() {
         touch ${goan_container_active_log}
         echo "log-file ${goan_container_active_log}" >> ${goan_container_proxy_logs}
     fi
-}
-
-#Find active logs and check for read access
-function logs_load_archive() {
-    touch ${goan_container_archive_log}
-
-    if [[ "${SKIP_ARCHIVED_LOGS}" == "True" ]]
-    then
-        echo "Skipping archived logs as requested..."
-    else
-        if [[ -d "${1}" && -x "${1}" ]];
-        then
-            count=`ls -1 ${1}/proxy-host-*_access.log*.gz | wc -l`
-            if [ $count != 0 ]
-            then 
-                echo "Loading (${count}) archived logs from ${1}..."
-                zcat -f ${1}/proxy-host-*_access.log*.gz > ${goan_container_archive_log}
-                echo  "log-file ${goan_container_archive_log}" >> ${goan_container_proxy_logs}
-            else
-                echo "No archived logs found at ${1}..."
-            fi
-            goan_proxy_archive_log_count=$((count))
-        else
-            echo "Problem loading directory (check directory or permissions)... ${1}"
-        fi
-    fi
 }

resources/scripts/funcs/environment.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 source $(dirname "$0")/funcs/nginx.sh
-source $(dirname "$0")/funcs/logs.sh
-source $(dirname "$0")/funcs/debug.sh
+source $(dirname "$0")/funcs/internal.sh
+source $(dirname "$0")/funcs/environment.sh
 
-goan_version="GOAN v1.0.7"
+goan_version="GOAN v1.0.8"
 goan_log_path="/opt/log"
 goan_dir_valid=0 #false
 goan_container_archive_log="/goaccess-config/access_archive.log"
@@ -28,7 +28,6 @@ if [[ -f "/goaccess-config/goaccess.conf" ]]; then
     cp /goaccess-config/goaccess.conf.bak /goaccess-config/goaccess.conf
 fi
 
-
 #Set NGINX basic authentication
 nginx_basic_auth
 
@@ -38,6 +37,9 @@ logs_load_archive ${goan_log_path}
 #Find active logs and check for read access
 logs_load_active ${goan_log_path}
 
+#Exclude IPs
+exclude_ips
+
 #Mods to index.html
 nginx_image_version
 nginx_processing_count