Configure MaxMind’s license key to download GeoIP2 files

in Revive Adserver

This article explains how to acquire a license key from MaxMind, and how to configure Revive Adserver to use that key to download GeoIP2 files.


When Revive Adserver version 5.0 was released on September 30, 2019, it introduced a new, completely rebuilt geotargeting plugin, capable of using the new GeoIP2 datafiles produced by MaxMind.

The software was developed to be capable of downloading the required GeoLite2 city datafile from MaxMind’s servers upon initial installation, or while upgrading from a version older than v5. It is also capable of keeping that datafile updated by downloading any newer files that MaxMind publish (usually on a weekly basis).

On December 18, 2019, MaxMind suddenly announced that they were going to implement a mandatory license model for file downloads and updates of GeoLite2 files. License keys for GeoLite2 are free of charge.

Following MaxMind’s announcement, a new version 5.0.3 of the Revive Adserver software was released on January 14, 2020, which is capable of using your MaxMind GeoLite2 license key to download GeoLite2 datafiles.

This article explains how to obtain a free license key from MaxMind’s website, and how to use it in your installation of Revive Adserver v5.0.3 or higher.

Step 1: Sign up for a MaxMind license key

As explained in the blog post by MaxMind, you can get a license key free of charge. The steps are:

(click to enlarge)

Step 2: Enter license key in geotargeting plugin settings

Here is what you need to do to enter the license key you just obtained in the plugin’s settings:

  • Go to your installed Revive Adserver v5.0.3 (or higher), and log in as a system administrator.
  • If necessary, switch to Working as System Administrator in the top right hand corner of the screen.
  • Now click the Plugins tab.
  • Most likely the new MaxMind GeoIP2 Plugin is listed at or near the top of the list of available plugins.
  • For this plugin, click the Details link in the same row.
  • On the details screen, you’ll see two components. Click the Settings link in the first row.
  • In this settings screen, you will notice fields for your license details.
  • Starting with v5.5.2 you will need to enter the Account ID you’ve received from MaxMind. This is new a requirement by MaxMind that came into effect on May 1st, 2024.
  • Paste the license key you obtained from MaxMind in step 1.
  • Leave the field for the ‘path to files’ empty, unless you have a specific process to update the GeoIP2 or GeoLite2 files separately. If you do use the path, you do not have to enter the License key.
  • Now click the Save Changes button.

(click to enlarge)

With Revive Adserver v5.5.2, this screen supports the new requirements by MaxMind that came into effect on May 1st, 2024. In addition to the License key, you will now also have to enter the account ID that’s displayed for you at the top of your MaxMind licenses page.

(click to enlarge)

Step 3: Force download of GeoLite2 file (optional)

If you’ve been using a prior version of the software that was capable of downloading the GeoLite2 city datafile without a license key, the software will now be able to do that again using the account ID and the license key you just entered.

By default, the software will check for new files during the maintenance process at midnight. If it notices that a newer file is available, it will download that and use it to replace the outdated file on your server.

If you created a fresh install of Revive Adserver v5.0.3, or if you updated from a version older than v5.0, and entered your account ID and license key, it will now be capable of downloading the GeoLite2 city datafile.

To force the system to do that right away, instead of having to wait until midnight, here’s how:

  • Make sure you are still logged in as a System administrator, and that you are still Working as System Administrator.
  • Go to the Plugins tab to open a list of the installed plugins.
  • In the row for the MaxMind GeoIP2 Plugin you will see that the status column shows the plugin to be Enabled.
  • Now click the Disable link at the right of the same row. The screen will refresh and the plugin’s status will have switched to Disabled.
  • A new Enable link has come into view in same place. Click it to enable the plugin again. To avoid disrupting your ad serving, disable and enable within a few seconds.
  • Once again the screen will refresh, but you may notice that it takes a few seconds. This is because at that very moment the plugin is proceeding to download the GeoLite2 city datafile from MaxMind’s servers. The time it takes to download it depends on the speed of your server’s connection to the internet.

That’s all, your geotargeting plugin is now up to date. It will automatically keep an eye on any new versions of the GeoLite2 city file and download it once available. This will happen at most once every 24 hours, at midnight.

Don’t want to get your own MaxMind license key?

Alternatively, if you don’t want to spend any time on configuring a server and installing the software, obtaining a MaxMind license key and setting that in the software, we also have a Hosted edition that you can subscribe to. This is a Software-as-a-Service offering that uses the exact same software, and that will always be kept up to date with the most recent version. All you have to do is subscribe, log in and use it. We’ve already taken care of regular updates of the GeoIP data files for you!