MaxMind GeoIP DB updater

Bash script with minimal dependencies to update MaxMind's GeoIP databases.

Features :

• download only if there is a new release of GeoIP databases.
• minimal dependencies

Requirements

• curl
• awk, sed, grep, md5sum, gzip

Ubuntu / Debian : apt install coreutils curl gawk grep gzip sed

Contribute

See CONTRIBUTING.md

Configuration & Usage

Config via Environment variables

override ALL other configurations even given in configuration file

Configuration file :

• MAXMIND_CONFIG_FILE : MaxMind's geoipupdate config file format.

AccountID :

1. MAXMIND_ACCOUNT_ID : Your MaxMind AccountID
2. MAXMIND_ACCOUNT_ID_FILE : filename path to your AccountID (first line)

License key :

1. MAXMIND_LICENSE_KEY : Your license key string
2. MAXMIND_LICENSE_KEY_FILE : filename path to the license key string (first line)

Database location :

• MAXMIND_DATADIR : path to the DB directory ; default to this script directory) Default value : <script directory/
  

Database editions :

• MAXMIND_EDITIONS : list of editions you want to update.
  Default value :
  MAXMIND_EDITIONS=('GeoLite2-ASN' 'GeoLite2-City' 'GeoLite2-Country')

Other :

• VERBOSE : active verbosity
• MAXMIND_HOST : change destination host ; if you host your own clone of Maxmind's GeoIP local databases update API endpoint.

Config via GeoIP.conf formatted file

Use a MaxMind's geoipupdate config file format.

By default : Try to use /etc/GeoIP.conf

• Autodetect AccountID
• Autodetect License key
• Autodetect EditionIDs

Usages

With env variables only

$ MAXMIND_HOST="my.host.tld" MAXMIND_LICENSE_KEY="TOTOISWITHYOU" MAXMIND_ACCOUNT_ID="123123" DRYRUN=1 VERBOSE=1 ./update-maxmind-geoip.sh
Updating MaxMind GeoIP DBs : 
    - Update URI               : https://my.host.tld/geoip/databases/%s/update
    - Try config file          : /etc/GeoIP.conf
    - Editions                 : GeoLite2-ASN GeoLite2-City GeoLite2-Country
    - Destination              : /home/me/update-maxmind-geoip
    - AccountID                : 123123
    - License Key              : TOTOISWITHYOU
DRYRUN is defined or not equal to 0. Exiting

using configuration file and explicit destination directory

$ DRYRUN=1 VERBOSE=1 ./update-maxmind-geoip.sh /tmp/GeoIP.conf /tmp
Updating MaxMind GeoIP DBs : 
    - Update URI               : https://updates.maxmind.com/geoip/databases/%s/update
    - Try config file          : /tmp/GeoIP.conf
    - Editions                 : GeoLite2-ASN GeoLite2-City GeoLite2-Country
    - Destination              : /tmp
    - AccountID                : 123123
    - License Key              : TOTOISWITHYOU
DRYRUN is defined or not equal to 0. Exiting

Cron example

With config file

/etc/cron.d/maxmind-autoupdate

MAILTO=your@email
https_proxy=your.proxy.tld
# m h  dom mon dow  user   command
0   6  *   *   *    root   /usr/local/sbin/update-maxmind-geoip.sh /etc/GeoIP.conf /usr/share/

With Env vars

/etc/cron.d/maxmind-autoupdate

MAILTO=your@email
MAXMIND_LICENSE_KEY="TOTOISWITHYOU"
MAXMIND_ACCOUNT_ID="123123"
# m h  dom mon dow  user   command
0   6  *   *   *    root   /path/to/update-maxmind-geoip/update-maxmind-geoip.sh

results : all DBs will be in /path/to/update-maxmind-geoip/

on RedHat and Archlinux : you must export vars in the same line like :

0   6  *   *   *    root   export MAXMIND_LICENSE_KEY="TOTOISWITHYOU"; /path/to/update-maxmind-geoip/update-maxmind-geoip.sh

License

Licensed under the EUPL, Version 1.2 or – as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at:

https://joinup.ec.europa.eu/software/page/eupl

Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.