gilbn/docker-mods-geo repository overview

⁠Geoip2Influx - Docker mod for nginx/swag

This mod adds a python script that sends geo location metrics from the nginx access log to InfluxDB

The mod will parse the access log for IPs and and convert them into geo metrics for InfluxDB. It will also send log metrics if enabled.

Add -e DOCKER_MODS=linuxserver/mods:swag-geoip2influx

⁠Enviroment variables:

These are the default values for all envs. Add the ones that differ on your system.

⁠MaxMind Geolite2

Default download location is /config/geoip2db/GeoLite2-City.mmdb

Get your licence key here: https://www.maxmind.com/en/geolite2/signup⁠

⁠InfluxDB

The InfluxDB database will be created automatically with the name you choose.

⁠Grafana dashboard:

⁠Grafana Dashboard Link⁠

⁠Sending Nginx log metrics

1. Add the following to the http block in your nginx.conffile:

geoip2 /config/geoip2db/GeoLite2-City.mmdb {
auto_reload 5m;
$geoip2_data_country_code country iso_code;
$geoip2_data_city_name city names en;
}

log_format geoip2influx '$remote_addr - $remote_user [$time_local]'
           '"$request" $status $body_bytes_sent'
           '"$http_referer" $host "$http_user_agent"'
           '"$request_time" "$upstream_connect_time"'
           '"$geoip2_data_city_name" "$geoip2_data_country_code"';

1. Set the access log use the geoip2influx log format.

access_log /config/log/nginx/access.log geoip2influx;

⁠Multiple log files

If you separate your nginx log files but want this mod to parse all of them you can do the following:

As nginx can have multiple access log directives in a block, just add another one in the server block.

Example

	access_log /config/log/nginx/technicalramblings/access.log;
	access_log /config/log/nginx/access.log geoip2influx;

This will log the same lines to both files.

Then use the /config/log/nginx/access.log file in the NGINX_LOG_PATH variable.