Skip to content

Geo IP Location

Introduction

The component GeoIp provides geo IP location features.

Setup

The GeoIp component does require a IP-location database to work. The latter is not part of the distribution. As it has to be obtained directly from MaxMind.

After obtaining an account-id and license-key, the IP-location database can be integrated by extending the docker-compose.yml file as follows:

  1. Add new service geoipupdate to section services:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
      geoipupdate:
    image: ghcr.io/maxmind/geoipupdate
    restart: unless-stopped
    environment:
      - GEOIPUPDATE_ACCOUNT_ID=${GEOIPUPDATE_ACCOUNT_ID}
      - GEOIPUPDATE_LICENSE_KEY=${GEOIPUPDATE_LICENSE_KEY}
      - GEOIPUPDATE_EDITION_IDS=GeoLite2-Country
      - GEOIPUPDATE_DB_DIR=/tmp/GeoIp
      - GEOIPUPDATE_FREQUENCY=72
    networks:
      - geoipupdate
    volumes:
      - ./core_modules/GeoIp/Data:/tmp/GeoIp"

    Note

    Replace ${GEOIPUPDATE_ACCOUNT_ID} and ${GEOIPUPDATE_LICENSE_KEY} by your account-id
    and license-key or set those environment variables in a env_file.

  2. Add new network geoipupdate to section networks:

    1
      geoipupdate:

  3. Restart env:

    1
    cx env restart

Info

This product includes GeoLite2 Data created by MaxMind, available from https://www.maxmind.com.