v1.0.9 (#60)

* updated readme file

* refactoring of code and updated goaccess to v1.6 (#58)

* updated to goaccess 1.6
* daemonize goaccess
* updated readme to reflect goaccess version
* creating better debug output UX
* code refactoring

* fixed some coding issues

* addition issue on loading screen

* missing ( around variable

* some code cleanup

* check if html directory exists

* echoing FALSE for skipped archive

Author: xavier-hernandez

Dockerfile

@@ -8,8 +8,8 @@ RUN apk add --no-cache \
 
 # set up goacess
 WORKDIR /goaccess
-RUN wget https://tar.goaccess.io/goaccess-1.5.5.tar.gz
-RUN tar --strip-components=1  -xzvf goaccess-1.5.5.tar.gz
+RUN wget https://tar.goaccess.io/goaccess-1.6.tar.gz
+RUN tar --strip-components=1  -xzvf goaccess-1.6.tar.gz
 RUN ./configure --enable-utf8 --enable-geoip=mmdb --with-getline
 RUN make
 RUN make install
@@ -29,18 +29,15 @@ RUN apk add --no-cache \
     rm /etc/nginx/nginx.conf
 
 COPY --from=builder /goaccess /goaccess
-COPY /resources/goaccess/goaccess.conf /goaccess-config/goaccess.conf.bak
 COPY /resources/goaccess/goaccess.conf /goaccess-config/goaccess.conf
 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
 
 WORKDIR /goan
 ADD /resources/scripts/funcs funcs
-ADD /resources/scripts/debug debug
 COPY /resources/scripts/start.sh start.sh
 
 VOLUME ["/opt/log"]

README.md

@@ -13,11 +13,10 @@ This docker container should work out of the box with Nginx Proxy Manager to par
 The docker image scans and includes files matching the following criteria: 
 * proxy-host-*_access.log.gz
 * proxy-host-*_access.log
-* proxy-host-*.log
-* proxy_host-*.log
+* proxy\*host-*.log
 
 **Dependencies:**
-- GoAccess version: 1.5.5  
+- GoAccess version: 1.6.0 
 - GeoLite2-City.mmdb  (2022-05-27)
 
 ---

resources/goaccess/goaccess.conf

@@ -21,8 +21,6 @@
 #
 #time-format %s
 
-time-format %T
-
 ######################################
 # Date Format Options (required)
 ######################################
@@ -53,8 +51,6 @@ time-format %T
 #
 #date-format %s
 
-date-format %d/%b/%Y
-
 ######################################
 # Log Format Options (required)
 ######################################
@@ -102,7 +98,7 @@ date-format %d/%b/%Y
 #log-format %^ %^ [%h] %^ %^ [%d:%t %^] "%r" %s %b "%R" "%u" %^ %^ [%v] %^:%^ %^ %T %^ %^
 
 # CADDY JSON Structured
-#log-format {ts:"%x.%^",request:{remote_addr:"%h:%^",proto:"%H",method:"%m",host:"%v",uri:"%U",headers:{"User-Agent":["%u","%^"]},tls:{cipher_suite:"%k",proto:"%K"}},duration:"%T",size:"%b",status:"%s",resp_headers:{"Content-Type":["%M;%^"]}}
+#log-format {ts:"%x.%^",request:{remote_ip:"%h",proto:"%H",method:"%m",host:"%v",uri:"%U",headers:{"User-Agent":["%u","%^"]},tls:{cipher_suite:"%k",proto:"%K"}},duration:"%T",size:"%b",status:"%s",resp_headers:{"Content-Type":["%M;%^"]}}
 
 # In addition to specifying the raw log/date/time formats, for
 # simplicity, any of the following predefined log format names can be
@@ -122,9 +118,6 @@ date-format %d/%b/%Y
 #log-format AWSS3
 #log-format CADDY
 
-#log_format [%d:%t %^] %s - %m %^ %v "%U" [Client %h] [Length %b] [Gzip %^] "%u" "%R"
-log_format [%d:%t %^] %^ %^ %s - %m %^ %v "%U" [Client %h] [Length %b] [Gzip %^] [Sent-to %^] "%u" "%R"
-
 ######################################
 # UI Options
 ######################################
@@ -293,7 +286,7 @@ with-mouse false
 
 # Enable real-time HTML output.
 #
-real-time-html true
+#real-time-html true
 
 # Path to TLS/SSL certificate.
 # Note that ssl-cert and ssl-key need to be used to enable TLS/SSL.
@@ -322,7 +315,7 @@ real-time-html true
 # specified here. Also, make sure it is a valid host and NOT an http
 # address.
 #
-#ws-url wss://goaccess.io/ws:7890
+#ws-url goaccess.io
 
 # Path to read named pipe (FIFO).
 #
@@ -339,7 +332,7 @@ real-time-html true
 # Specify the path to the input log file. If set, it will take
 # priority over -f from the command line.
 #
-#GOAN_PROXY_FILES
+#log-file /var/log/apache2/access.log
 
 # Send all debug messages to the specified file.
 #
@@ -401,7 +394,7 @@ http-protocol yes
 # /path/file.json - JSON (JavaScript Object Notation)
 # /path/file.html - HTML
 #
-output /var/www/html/index.html
+# output /path/file.html
 
 # Ignore request's query string.
 # i.e.,  www.google.com/page.htm?query => www.google.com/page.htm
@@ -443,9 +436,9 @@ all-static-files false
 #
 #browsers-file <filename>
 
-# Date specificity. Possible values: `date` (default), or `hr`.
+# Date specificity. Possible values: `date` (default), or `hr` or `min`.
 #
-#date-spec hr
+#date-spec hr|min
 
 # Decode double-encoded values.
 #
@@ -719,7 +712,7 @@ static-file .zst
 # Download the GeoLite2-Country.mmdb.gz
 # gunzip GeoLite2-Country.mmdb.gz
 #
-geoip-database /goaccess-config/GeoLite2-City.mmdb
+#geoip-database /usr/local/share/GeoIP/GeoLiteCity.dat
 
 ######################################
 # Persistence Options
@@ -734,4 +727,4 @@ geoip-database /goaccess-config/GeoLite2-City.mmdb
 
 # Load previously stored data from disk.
 # Database files need to exist. See `persist`.
-#restore true
+#restore true

resources/nginx/index.html

@@ -2,27 +2,30 @@
 
 #Exclude IPs
 function exclude_ips() {
+    echo -e "\nEXCLUDE IPS"
+    echo "-------------------------------"    
     if [[ -z "${EXCLUDE_IPS}" ]]
     then
-        //no excluded ips
+        echo "None"
     else
-        echo -e "\nExcluding IPs..."
         ips=""
 
-        echo $'\n' >> /goaccess-config/goaccess.conf
-        echo "#GOAN_EXCLUDE_IPS" >> /goaccess-config/goaccess.conf
+        echo $'\n' >> ${1}
+        echo "#GOAN_EXCLUDE_IPS" >> ${1}
         IFS=','
         read -ra ADDR <<< "$EXCLUDE_IPS"
         for ip in "${ADDR[@]}"; do
             echo ${ip}
-            echo "exclude-ip ${ip}" >> /goaccess-config/goaccess.conf
+            echo "exclude-ip ${ip}" >> ${1}
         done
         unset IFS
     fi
 }
 
 #Set NGINX basic authentication
 function nginx_basic_auth() {
+    echo -e "\nNGINX BASIC AUTH"
+    echo "-------------------------------"
     if [[ "${BASIC_AUTH}" == "True" ]]
     then
         echo "Setting up basic auth in NGINX..."
@@ -35,50 +38,101 @@ function nginx_basic_auth() {
             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
+            echo "Done"
         fi
+    else
+        echo "None"
     fi
+
 }
 
 #ADD DEBUGGING
 function debug() {
+    echo -e "\nDEBUG"
+    echo "-------------------------------"
     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
+        echo "ON"
+        echo "<!doctype html><html><head>" > ${1}
+        echo "<title>GoAccess for Nginx Proxy Manager Logs - ${goan_version}</title>" >> ${1}
+        echo "<style>body{font-family:Arial,sans-serif;}code{white-space:pre-wrap;}</style>" >> ${1}
+        echo "</head><body><code>" >> ${1}
+        cat ${2} >> ${1}
+        echo "</code></body></html>" >> ${1}
     else
-        echo "DEBUG - OFF"
+        echo -e "OFF"
     fi
 }
 
 #Find active logs and check for read access
-function logs_load_archive() {
-    touch ${goan_container_archive_log}
+function load_proxy_logs() {
+    echo -e "\nLOADING ACTIVE PROXY LOGS"
+    echo "-------------------------------"
+
+    goan_proxy_log_count=0
+    goan_proxy_archive_log_count=0
+
+    echo -e "\n#GOAN_PROXY_FILES" >> ${2}
+    if [[ -d "${1}" && -x "${1}" ]];
+    then
+        IFS=$'\n'
+        for file in $(find "${1}" -name 'proxy*host-*.log' ! -name "*_error.log");
+        do
+            if [ -f $file ]
+            then
+                if [ -r $file ] && R="Read = yes" || R="Read = No"
+                then
+                    echo "log-file ${file}" >> ${2}
+                    goan_proxy_log_count=$((goan_proxy_log_count+1))
+                    echo "Filename: $file | $R"
+                else
+                    echo "Filename: $file | $R"
+                fi
+            else
+                echo "Filename: $file | Not a file"
+            fi
+        done
+        unset IFS
+    else
+        echo "Problem loading directory (check directory or permissions)... ${1}"
+    fi
+
+    if [ $goan_proxy_log_count != 0 ]
+    then
+        echo "Found (${goan_proxy_log_count}) proxy logs..."
+    fi
+
+    echo -e "\nSKIP ARCHIVED LOGS"
+    echo "-------------------------------"
 
+    echo -e "\n#GOAN_ARCHIVE_PROXY_FILES" >> ${2}
     if [[ "${SKIP_ARCHIVED_LOGS}" == "True" ]]
     then
-        echo "Skipping archived logs as requested..."
+        echo "True"
     else
+        echo "False"
         if [[ -d "${1}" && -x "${1}" ]];
         then
-            count=`ls -1 ${1}/proxy-host-*_access.log*.gz | wc -l`
+            count=`ls -1 ${1}/proxy-host-*_access.log*.gz 2> /dev/null | 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}
+                zcat -f ${1}/proxy-host-*_access.log*.gz > ${3}
+                echo  "log-file ${3}" >> ${2}
+                goan_proxy_archive_log_count=${count}
             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
+    
+    echo "<!doctype html><html><head>" > ${4}
+    echo "<title>GoAccess for Nginx Proxy Manager Logs - ${goan_version}</title>" >> ${4}
+    echo "<meta http-equiv=\"refresh\" content=\"1\" >" >> ${4}
+    echo "<style>body {font-family: Arial, sans-serif;}</style>" >> ${4}
+    echo "</head><body><p><b>${goan_version}</b><br/><br/>loading... <br/><br/>" >> ${4}
+    echo "Logs processing: $(($goan_proxy_log_count + $goan_proxy_archive_log_count)) (might take some time depending on the number of files to parse)" >> ${4}
+    echo "<br/></p></body></html>" >> ${4}
 }