GeoIP

A geolocation library for Joomla!

  • Last updated: 14 Sep 2020
  • Version: 3.0.7
  • Types: System plugin Library

Tutorial for GeoIP

Introduction

Regular Labs GeoIP is a library / plugin that enables Joomla extension to use GeoIP locating.

This library is required if you want to utilize the Geolocation assignment options in several Regular Labs extensions:

These Joomla extensions include assignments by the following Geographical Location options:

  • Continents
  • Countries
  • Regions / States
  • Postal Codes (and ranges)

Please note: Geolocating is not always 100% accurate. The Geolocation is based on the IP address of the visitor. Not all IP addresses are fixed or known. Also, IP addresses can be spoofed.

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

Getting Started

Once Regular Labs GeoIP is installed for the first time on your site, you will be presented with a message saying that GeoIP cannot function until you sync the MaxMind GeoLite 2 database.

That is because, as of December 30, 2019 you need a MaxMind License Key (free) in order to use the GeoIP database.

MaxMind License Key

MaxMind GeoLite2 requires you to create a free account (no purchase required) and create a License Key.

This means that in order to download the GeoIP database on your website, you first need to create a License Key and enter it in the GeoIP system plugin settings.

The field to enter your MaxMind License Key has been introduced in version 3.0.0 of GeoIP, released in January 2020.

Syncing the Database

Once a MaxMind License Key has been entered, you can download the GeoIP database by simply clicking on the "Sync" button in the GeoIP system plugin settings.

At this point, you have completed the setup of GeoIP and you will be able to use it in any of the supported Regular Labs Extensions.

Updating the Database

The IP Geolocation Database (created by MaxMind) used by Regular Labs GeoIP is stored in a file on your server.

The MaxMind GeoLite2 database gets updated on (or just after) the first Tuesday of the month. However, the database file will not get updated automatically on your website.

With a MaxMind License Key entered, you will be able to sync to the latest database manually at anytime via the GeoIP system plugin settings.

Also, your database will be synced to the latest version every time you update the Regular Labs GeoIP extension.

Supported Extensions

GeoIP allows you to personalize the content of your Joomla website based on the location of the visitor, with options for Continents, Countries, Regions / States and Postal Codes.

While the Regular Labs GeoIP library is free, its features can be used in the Pro Versions of the following Regular Labs extensions:

Advanced Module Manager

Advanced Module Manager is an extension that enhances the way your module manager works.

With Advanced Module Manager you have the possibility to assign modules to just about anything you want, including Joomla! Content, Users, Components, Templates, Devices - and with GeoIP, Geolocating assignments.

Advanced Template Manager

Advanced Template Manager is an extension that enhances the way your template manager works.

With Advanced Template Manager you have the possibility to assign template styles to just about anything you want, including Joomla! Content, Users, Components, Devices - and with GeoIP, Geolocating assignments.

Content Templater

With Content Templater you can create predefined reusable content templates for your Joomla articles. You can also make entire page layouts, and automatically set/change any available option in the article edit form, like the Category or Title of an article, and even Custom Fields.

You can determine the conditions where or when a template will be used. You can choose from an enormous amount of assignment options, such as Categories, User Groups, Seasons - and with GeoIP, Geolocating assignments.

ReReplacer

ReReplacer enables you to search and replace anything you want in your Joomla website on-the-fly.

You can determine the conditions where or when a replacement is done. You can choose from an enormous amount of assignment options, such as Categories, User Groups, Seasons - and with GeoIP, Geolocating assignments.

Conditional Content

With Conditional Content you can restrict or grant access to parts of the content (text, images...) based on a wide selection of conditions (device, user groups, date ranges, languages, menu items and more).

Want to show some text only to registered users? Or hide some content in December? Want to display a message for mobile users? Or hide an image every Monday? You can do that and a whole lot more with Conditional Content!

Want to have a piece of text only visible for people from Europe? You can do so thanks to the GeoIP Geolocating assignments.

Settings

The GeoIP library comes with a few options. Here is the full list of the options you can find in the GeoIP system plugin settings:

Sync GeoIP Database

Create a MaxMind GeoLite2 account Link to create a MaxMind GeoLite 2 account.
Create a License Key Link to create a MaxMind License Key.
License Key Enter your MaxMind License Key (see link above).
Database Version This area shows the date of the current GeoLite2 Database version installed on your website.
Sync GeoIP Database Update your GeoIP database to the latest version of the MaxMind GeoLite2 database.
The MaxMind GeoLite2 database gets updated on or just after the first Tuesday of the month.
Re-Download Database Use this to force-download the database even if it is already up-to-date. This can be useful if the database is broken for some reason.

Advanced

Show Notices Select to show a warning message in the administrator when the GeoIP database file is missing or outdated.

Installation

You can either install GeoIP by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful Regular Labs Extension Manager.

Note: When updating GeoIP, you do not need to uninstall it first. The package will update all the files automatically.

Keep in mind that when you update to a major new version (or uninstall first), you might lose some configuration settings.

Regular Labs Extension Manager

It is very easy to install/update any Regular Labs Extension using the Regular Labs Extension Manager.

Please see the Tutorial for the Regular Labs Extension Manager for more detailed information...

Joomla! Extension Manager

To install via the Joomla! Extension Manager, just follow these steps:

  1. Log into your Joomla administrator;
  2. In the menu, choose: Extensions >> Extensions;
  3. Choose the tab: Install from Web (or enable it if you haven't done so yet);
  4. Select the search field and enter GeoIP and hit enter;
  5. Click on the GeoIP listing;
  6. Click on Install;
  7. Click on Install to confirm.
Joomla! Installer - Install from Web

Or if cannot install via the 'Install via Web' method for some reason:

  1. Download the extension install file (.zip);
  2. Log into your Joomla administrator;
  3. In the menu, choose: Extensions >> Extensions;
  4. Choose the tab: Upload Package File;
  5. Click on the Choose File button and select the extension zip;
  6. Click on Upload & Install.
Joomla! Installer - Upload Package File

If you have problems installing GeoIP, please try the manual installation process as described here: docs.joomla.org/Installing_an_extension