README.md

IP2Location Downloader

A microservice that regularly downloads IP2Location dump files with a given period.

Build from sources

Requirements:

• JDK 1.8
• Maven 3.3+

mvn clean install

Basic usage

Requirements:

• JRE 1.8
• IP2Location download key (token)

$ IP2LOCATION_DOWNLOAD_DIR=/tmp \
  IP2LOCATION_DOWNLOAD_FREQUENCY=MONTH \
  IP2LOCATION_DOWNLOAD_TYPE=DB1 \
  IP2LOCATION_DOWNLOAD_TOKEN=1234-4567-abc \
  java -jar target/ip2location-1.0-SNAPSHOT.jar

Configuration properties

• IP2LOCATION_DOWNLOAD_DIR [string] - a dir where the dumps will get downloaded to. If the dir does not exist, an attempt will be made to create it.
• IP2LOCATION_DOWNLOAD_PERIOD [HOUR|DAY|MOTH] - the frequency of download
• IP2LOCATION_DOWNLOAD_TYPE [string] - type of the IP2Location database to download
• IP2LOCATION_DOWNLOAD_TOKEN [string] - IP2Location download token (aka. API key)
• IP2LOCATION_DOWNLOAD_CRON [string|number] = 0 * * * * * - cron-like expression (in UTC time zone) when the download check kicks in