GeoIP2

MaxMind GeoIP2 databases provide contextual data for a comprehensive profile of IP addresses, including geolocation data (region, state, city, postal code) and extra data (ISP, domain, connection type). Basing on these data, F5 NGINX Plus will be able to perform different user differentiation strategies, for example, provide different type of content depending on a country.

Installation

1. Check the Technical Specifications page to verify that the module is supported by your operating system.

2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the Installing NGINX Plus page.

3. Install the GeoIP2 module package nginx-plus-module-geoip2 from the official NGINX Plus repository.

   For CentOS, Oracle Linux, and RHEL:

   shell

   Copy

   sudo yum update && \
   sudo yum install nginx-plus-module-geoip2

   the GeoIP2 module cannot be installed on ppc64le version of CentOS, Oracle Linux, and RHEL.

   For Amazon Linux 2023, AlmaLinux, Rocky Linux:

   shell

   Copy

   sudo dnf update && \
   sudo dnf install nginx-plus-module-geoip2

   For Debian and Ubuntu:

   shell

   Copy

   sudo apt update && \
   sudo apt install nginx-plus-module-geoip2

   For Alpine:

   Copy

   apk add nginx-plus-module-geoip2

   For FreeBSD:

   shell

   Copy

   sudo pkg update && \
   sudo pkg install nginx-plus-module-geoip2

Configuration

After installation you will need to enable and configure the module in NGINX Plus configuration file nginx.conf.

1. Enable dynamic loading of GeoIP2 modules with the load_module directives specified in the top-level (“main”) context:

   nginx

   Copy

   load_module modules/ngx_http_geoip2_module.so;
   load_module modules/ngx_stream_geoip2_module.so;
   
   http {
       # ...
   }
   
   stream {
       # ...
   }

2. Perform additional configuration as required by the module.

3. Test the NGINX Plus configuration. In a terminal, type-in the command:

   Copy

   nginx -t

   Expected output of the command:

   shell

   Copy

   nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
   nginx: configuration file /etc/nginx/nginx.conf is successful

4. Reload the NGINX Plus configuration to enable the module:

   Copy

   nginx -s reload

More info

• Restricting Access by Geographical Location

• MaxMind GeoIP2 databases

• MaxMind Geolite2 free downloadable databases

• NGINX dynamic modules

• NGINX Plus technical specifications

• Uninstalling a dynamic module

---

---