Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/msimerson/maxmind-geolite-mirror/llms.txt

Use this file to discover all available pages before exploring further.

maxmind-geolite-mirror downloads exactly three GeoLite2 v2 databases, all in MaxMind’s binary .mmdb format. Each database is checked against the remote copy before downloading — if the local file is already up to date, the download is skipped. The three databases cover country-level geolocation, city-level geolocation, and autonomous system information respectively.

​
Database reference

Local FilenameMaxMind Edition IDDescription
GeoLite2-Country.mmdbGeoLite2-CountryMaps IP addresses to country, continent, and registered-country data
GeoLite2-City.mmdbGeoLite2-CityMaps IP addresses to city, subdivisions, latitude/longitude, and postal code
GeoLite2-ASN.mmdbGeoLite2-ASNMaps IP addresses to Autonomous System Number (ASN) and organization name

​
Configuration in config.js

The list of databases is defined as the geoIpDbs array in lib/config.js. Each entry has a local property (the filename written to disk) and a remote property (the MaxMind edition ID used in the download URL): 
// lib/config.js

exports.geoIpDbs = [
    // v2
    { local: 'GeoLite2-Country.mmdb', remote: 'GeoLite2-Country' },
    { local: 'GeoLite2-City.mmdb',    remote: 'GeoLite2-City' },
    { local: 'GeoLite2-ASN.mmdb',     remote: 'GeoLite2-ASN' },
];

​
Download URL format

For each database entry, the tool constructs a download URL using the remote edition ID as the edition_id query parameter: 
https://download.maxmind.com/app/geoip_download?license_key=<key>&suffix=tar.gz&edition_id=<remote>
For example, the City database URL resolves to: 
https://download.maxmind.com/app/geoip_download?license_key=your_key_here&suffix=tar.gz&edition_id=GeoLite2-City
MaxMind serves the database as a gzip-compressed tarball (.tar.gz). The tool decompresses and extracts the .mmdb file from the archive and writes it to the configured database directory under the local filename.

​
Legacy v1 databases

Older versions of this tool supported MaxMind’s v1 .dat format files (GeoIP.dat, GeoIPCity.dat, GeoIPASNum.dat, and others). MaxMind stopped publishing those files and they are no longer supported. The v1 entries remain visible as comments in config.js for historical reference only.
MaxMind publishes updated GeoLite2 databases on a weekly basis. Running maxmind-geolite-mirror on a weekly schedule is sufficient to stay current. The tool sends an If-Modified-Since request before each download and skips any database that has not changed since the last run, so redundant runs are safe and inexpensive.

Build docs developers (and LLMs) love

Get started for freeTalk to us