oschwald / geoip2-update

Update Maxmind.com GeoIP2/GeoLite2 databases from your php script, application or via Composer.

Geoip2 Update is a php tool for updating Maxmind GeoLite2 and GeoIP2 databases from your script, application or via Composer.

REQUIREMENTS

The minimum requirement of this library is for your web server to support PHP >= 5.3.0 with curl extension and an optional zip extension if you want to update the csv databases.

INSTALLATION

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

You can then install this library using the following command:

composer require tronovav/geoip2-update

CONFIGURATION

1. Updating databases via Composer:

To update Geoip2 databases via Composer, you can set up an update call in your composer.json. Each time the composer update command is invoked, the library will check for updates on the "maxmind.com" server and update the Geoip2 databases if necessary.

# composer.json

"scripts": {
        "post-update-cmd": [
            "tronovav\\GeoIP2Update\\ComposerClient::run"
        ]
},
"extra": {
    "tronovav\\GeoIP2Update\\ComposerClient::run": {
        "license_key": "MAXMIND_LICENSE_KEY",
        "dir": "DESTINATION_DIRECTORY_PATH",
        "editions": ["GeoLite2-ASN", "GeoLite2-City", "GeoLite2-Country"]
    }
}

Parameters in the scripts section:

Just add the "post-update-cmd": "tronovav\\GeoIP2Update\\ComposerClient::run" line to update databases via Composer.

Parameters in the extra section:

• license_key (required) - You can see your license key information on your account License Keys page at maxmind.com.
• dir (required) - Absolute path to the Geoip2 local database storage directory. Or you can alias part of the path relative to your composer.json. For example @composer/path-to-db-storage. The script itself will find the absolute path to the composer.json file in your project and the path-to-db-storage directory for storing Geoip2 databases relative to composer.json. You can also specify @composer/../path-to-db-storage. The main thing is that you yourself understand which path to storing the database you specify.
• editions - List of database editions that you want to update. Maxmind.com offers databases for free download: GeoLite2-ASN, GeoLite2-City, GeoLite2-Country. These editions will be updated by default if you do not fill in the editions parameter. Otherwise, only the editions that you specified will be updated. See available editions in your maxmind.com account.

2. Updating databases from your php application:

<?php

require 'vendor/autoload.php';

// configuration
$client = new \tronovav\GeoIP2Update\Client(array(
    'license_key' => 'MAXMIND_LICENSE_KEY',
    'dir' => 'DESTINATION_DIRECTORY_PATH',
    'editions' => array('GeoLite2-ASN', 'GeoLite2-City', 'GeoLite2-Country'),
));
// run update
$client->run();

// After updating, you can get information about the result:

print_r($client->updated()); // update result

print_r($client->errors()); // update errors

Params:

• license_key (required) - You can see your license key information on your account License Keys page at maxmind.com.
• dir (required) - Absolute path to the local storage of Geoip2 databases.
• editions - List of database editions that you want to update. Maxmind.com offers databases for free download: GeoLite2-ASN, GeoLite2-City, GeoLite2-Country. These editions will be updated by default if you do not fill in the editions parameter. Otherwise, only the editions that you specified will be updated. See available editions in your maxmind.com account.

Available GeoIP2 Edition ID of the databases that you can specify in the editions parameter and update.

• GeoLite2-ASN

• GeoLite2-City

• GeoLite2-Country

• GeoLite2-ASN-CSV

• GeoLite2-City-CSV

• GeoLite2-Country-CSV

• GeoIP2-ASN

• GeoIP2-City

• GeoIP2-Country

• GeoIP2-ASN-CSV

• GeoIP2-City-CSV

• GeoIP2-Country-CSV

See available Edition ID databases for updates in your maxmind.com account.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2021 by Andrey Tronov.

This is free software, licensed under the MIT License.