Merge pull request #19 from GilbN/alpine-3.20

Rebase to Alpine 3.20

Dockerfile

@@ -1,15 +1,19 @@
-FROM lsiobase/alpine:3.15
+FROM lsiobase/alpine:3.20
 LABEL maintainer="GilbN"
 
 WORKDIR /geoip2influx
 COPY requirements.txt geoip2influx.py /geoip2influx/
 RUN \
 echo " ## Installing packages ## " && \
 apk add --no-cache --virtual=build-dependencies \
-    python3 \
+    python3-dev \
     py3-pip \
     logrotate \
     libmaxminddb && \
+echo "**** install packages ****" && \
+apk add --no-cache \
+    python3 && \
 echo " ## Installing python modules ## " && \
+python3 -m venv /lsiopy && \
 pip3 install --no-cache-dir -r requirements.txt
 COPY root/ /

README.md

@@ -39,6 +39,7 @@ Add the ones that differ on your system.
 | INFLUX_RETENTION | 7d | Sets the retention for the database. Optional, defaults to example.|
 | INFLUX_SHARD | 1d | Set the shard for the database. Optional, defaults to example. |
 | MAXMINDDB_LICENSE_KEY | xxxxxxx | Add your Maxmind licence key |
+| MAXMINDDB_USER_ID | xxxxxxx| Add your Maxmind account id |
 
 
 ### MaxMind Geolite2
@@ -68,6 +69,7 @@ docker create \
   -e INFLUX_HOST=<influxdb host> \
   -e INFLUX_HOST_PORT=<influxdb port> \
   -e MAXMINDDB_LICENSE_KEY=<license key>\
+  -e MAXMINDDB_USER_ID=<account id>\
   -v /path/to/appdata/geoip2influx:/config \
   -v /path/to/nginx/accesslog/:/config/log/nginx/ \
   --restart unless-stopped \
@@ -89,6 +91,7 @@ services:
       - INFLUX_HOST=<influxdb host>
       - INFLUX_HOST_PORT=<influxdb port>
       - MAXMINDDB_LICENSE_KEY=<license key>
+      - MAXMINDDB_USER_ID=<account id>
     volumes:
       - /path/to/appdata/geoip2influx:/config
       - /path/to/nginx/accesslog/:/config/log/nginx/
@@ -148,6 +151,8 @@ Then use the `/config/log/nginx/access.log` file in the `NGINX_LOG_PATH` variabl
 
 ## Updates 
 
+**xx.xx.24** - Refactor to alpine 3.20. New env required. MAXMINDDB_USER_ID. 
+
 **21.06.20** - Added $host(domain) to the nginx log metrics. This will break your nginx logs parsing, as you need to update the custom log format.
 
 **06.06.20** - Added influx retention policy to try and mitigate max-values-per-tag limit exceeded errors.

root/etc/logrotate.d/geoip2influx

@@ -8,7 +8,7 @@
         missingok
         notifempty
         postrotate
-                s6-svc -r /var/run/s6/services/geoip2influx
+                s6-svc -1 /run/service/svc-geoip2influx
         endscript
         su abc abc
 }

root/etc/s6-overlay/s6-rc.d/init-adduser/branding

@@ -0,0 +1,11 @@
+
+ ██████╗ ███████╗ ██████╗ ██╗██████╗ ██████╗ ██╗███╗   ██╗███████╗██╗     ██╗   ██╗██╗  ██╗
+██╔════╝ ██╔════╝██╔═══██╗██║██╔══██╗╚════██╗██║████╗  ██║██╔════╝██║     ██║   ██║╚██╗██╔╝
+██║  ███╗█████╗  ██║   ██║██║██████╔╝ █████╔╝██║██╔██╗ ██║█████╗  ██║     ██║   ██║ ╚███╔╝ 
+██║   ██║██╔══╝  ██║   ██║██║██╔═══╝ ██╔═══╝ ██║██║╚██╗██║██╔══╝  ██║     ██║   ██║ ██╔██╗ 
+╚██████╔╝███████╗╚██████╔╝██║██║     ███████╗██║██║ ╚████║██║     ███████╗╚██████╔╝██╔╝ ██╗
+ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝╚═╝     ╚══════╝╚═╝╚═╝  ╚═══╝╚═╝     ╚══════╝ ╚═════╝ ╚═╝  ╚═╝
+
+
+                                 Made by @gilbN                                            
+                     https://github.com/GilbN/geoip2influx                                 

root/etc/cont-init.d/50-config → root/etc/s6-overlay/s6-rc.d/init-geoip2influx-setup/run

@@ -1,6 +1,9 @@
 #!/usr/bin/with-contenv bash
+# shellcheck shell=bash
 
-echo -e "Variables set:\\n\
+echo -e "[init-geoip2influx-setup] Starting"
+
+echo -e "[init-geoip2influx-setup] Variables set:\\n\
 NGINX_LOG_PATH=${NGINX_LOG_PATH}\\n\
 INFLUX_HOST=${INFLUX_HOST}\\n\
 INFLUX_HOST_PORT=${INFLUX_HOST_PORT}\\n\
@@ -14,31 +17,19 @@ LOG_MEASUREMENT=${LOG_MEASUREMENT}\\n\
 SEND_NGINX_LOGS=${SEND_NGINX_LOGS}\\n\
 GEOIP2INFLUX_LOG_LEVEL=${GEOIP2INFLUX_LOG_LEVEL}\\n\
 GEOIP2INFLUX_LOG_PATH=${GEOIP2INFLUX_LOG_PATH}\\n\
+MAXMINDDB_USER_ID=${MAXMINDDB_USER_ID}\\n\
 MAXMINDDB_LICENSE_KEY=${MAXMINDDB_LICENSE_KEY}\\n"
 
 mkdir -p \
-  /config/geoip2db \
   /config/log/geoip2influx
 cp -f /geoip2influx/geoip2influx.py /config/geoip2db
 # move old log if needed
 if [ -f /config/geoip2db/geoip2influx.log ]; then
+  echo -e "[init-geoip2influx-setup] Moving old log"
   mv /config/geoip2db/geoip2influx.log /config/log/geoip2influx
 fi
-# create GeoIP2 folder symlink
-[[ -d /var/lib/libmaxminddb ]] && [[ ! -L /var/lib/libmaxminddb ]] && \
-  rm -rf /var/lib/libmaxminddb
-[[ ! -d /var/lib/libmaxminddb ]] && \
-  ln -s /config/geoip2db /var/lib/libmaxminddb
-# check GeoIP2 database
-if [ -n "$MAXMINDDB_LICENSE_KEY" ]; then
-    sed -i "s|.*MAXMINDDB_LICENSE_KEY.*|MAXMINDDB_LICENSE_KEY=\"${MAXMINDDB_LICENSE_KEY}\"|g" /etc/libmaxminddb.cron.conf
-    if [ ! -f /var/lib/libmaxminddb/GeoLite2-City.mmdb ]; then
-        echo "Downloading GeoIP2 City database."
-        /etc/periodic/weekly/libmaxminddb
-    fi
-fi
 
-# permissions
-chown -R abc:abc /config/geoip2db
 chmod +x /config/geoip2db/geoip2influx.py
-chmod -R 0644 /etc/logrotate.d
+chmod -R 0644 /etc/logrotate.d
+
+echo -e "[init-geoip2influx-setup] Finished"

root/etc/s6-overlay/s6-rc.d/init-geoip2influx-setup/type

@@ -0,0 +1 @@
+oneshot

root/etc/s6-overlay/s6-rc.d/init-geoip2influx-setup/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-geoip2influx-setup/run

root/etc/s6-overlay/s6-rc.d/init-maxmind-setup/run

@@ -0,0 +1,34 @@
+#!/usr/bin/with-contenv bash
+
+echo -e "[init-maxmind-setup] init started"
+
+# create GeoIP2 folder symlink
+mkdir -p \
+    /config/geoip2db
+if [[ -d /var/lib/libmaxminddb ]] && [[ ! -L /var/lib/libmaxminddb ]]; then
+    rm -rf /var/lib/libmaxminddb
+fi
+if [[ ! -d /var/lib/libmaxminddb ]]; then
+    ln -s /config/geoip2db /var/lib/libmaxminddb
+fi
+# check GeoIP2 database
+if [[ -n "${MAXMINDDB_USER_ID}" ]]; then
+    sed -i "s|.*MAXMINDDB_USER_ID.*|MAXMINDDB_USER_ID=\"${MAXMINDDB_USER_ID}\"|g" /etc/libmaxminddb.cron.conf
+else
+    echo -e "[init-maxmind-setup] Starting with Alpine 3.20 rebase, MaxMindDB now requires setting the env var MAXMINDDB_USER_ID with your account's user id."
+fi
+if [[ -n "${MAXMINDDB_LICENSE_KEY}" ]]; then
+    sed -i "s|.*MAXMINDDB_LICENSE_KEY.*|MAXMINDDB_LICENSE_KEY=\"${MAXMINDDB_LICENSE_KEY}\"|g" /etc/libmaxminddb.cron.conf
+    if [[ ! -f /var/lib/libmaxminddb/GeoLite2-City.mmdb ]]; then
+        echo -e "[init-maxmind-setup] Downloading GeoIP2 City database."
+        /etc/periodic/weekly/libmaxminddb
+    fi
+elif [[ -f /var/lib/libmaxminddb/GeoLite2-City.mmdb ]]; then
+    echo -e "[init-maxmind-setup] Currently using the user provided GeoLite2-City.mmdb.\nIf you want to enable weekly auto-updates of the database, retrieve a free license key from MaxMind,\nand add a new env variable \"MAXMINDDB_LICENSE_KEY\", set to your license key."
+else
+    echo -e "[init-maxmind-setup] Starting 2019/12/30, GeoIP2 databases require personal license key to download. Please retrieve a free license key from MaxMind,\nand add a new env variable \"MAXMINDDB_LICENSE_KEY\", set to your license key."
+fi
+
+# permissions
+lsiown -R abc:abc /config/geoip2db
+echo "[init-maxmind-setup] init finished"

root/etc/s6-overlay/s6-rc.d/init-maxmind-setup/type

@@ -0,0 +1 @@
+oneshot

root/etc/s6-overlay/s6-rc.d/init-maxmind-setup/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-maxmind-setup/run

root/etc/services.d/geoip2influx/run → root/etc/s6-overlay/s6-rc.d/svc-geoip2influx/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bash
+# shellcheck shell=bash
 
   exec \
         python3 /config/geoip2db/geoip2influx.py

root/etc/s6-overlay/s6-rc.d/svc-geoip2influx/type

@@ -0,0 +1 @@
+longrun