Module ngx_stream_geoip_module

Example Configuration Directives      geoip_country      geoip_city      geoip_org      geoip_set

The ngx_stream_geoip_module module (1.11.3) creates variables with values depending on the client IP address, using the precompiled MaxMind databases.

The module supports both legacy GeoIP databases and new GeoIP2 databases in the MaxMind DB (MMDB) file format (1.29.4).

When using legacy databases with IPv6 support, IPv4 addresses are looked up as IPv4-mapped IPv6 addresses.

This module is not built by default, it should be enabled with the --with-stream_geoip_module configuration parameter.

This module requires the MaxMind GeoIP library to support loading of legacy GeoIP databases, and the libmaxminddb library to support loading of GeoIP2 databases in the MaxMind DB (MMDB) file format (1.29.4).

Example Configuration

stream {
    geoip_country         GeoIP.dat;
    geoip_city            GeoLiteCity.dat;

    map $geoip_city_continent_code $nearest_server {
        default        example.com;
        EU          eu.example.com;
        NA          na.example.com;
        AS          as.example.com;
    }
    ...
}

Directives

Specifies a database used to determine the country depending on the client IP address. The following variables are available when using this database:

$geoip_country_code

two-letter country code, for example, “RU”, “US”.

$geoip_country_code3

three-letter country code, for example, “RUS”, “USA”.

This variable is not available when using MMDB databases.

$geoip_country_name

country name, for example, “Russian Federation”, “United States”.

Specifies a database used to determine the country, region, and city depending on the client IP address. The following variables are available when using this database:

$geoip_area_code

telephone area code (US only).

This variable may contain outdated information since the corresponding database field is deprecated.

$geoip_city_continent_code

two-letter continent code, for example, “EU”, “NA”.

$geoip_city_country_code

two-letter country code, for example, “RU”, “US”.

$geoip_city_country_code3

three-letter country code, for example, “RUS”, “USA”.

This variable is not available when using MMDB databases.

$geoip_city_country_name

country name, for example, “Russian Federation”, “United States”.

$geoip_dma_code

DMA region code in US (also known as “metro code”), according to the geotargeting in Google AdWords API.

$geoip_latitude

latitude.

$geoip_longitude

longitude.

$geoip_region

country region code (region, territory, state, province, federal land and the like), for example, “48”, “DC”.

$geoip_region_name

country region name (region, territory, state, province, federal land and the like), for example, “Moscow City”, “District of Columbia”.

$geoip_city

city name, for example, “Moscow”, “Washington”.

$geoip_postal_code

postal code.

Specifies a database used to determine the organization depending on the client IP address. The following variable is available when using this database:

$geoip_org

organization name, for example, “The University of Melbourne”.

Creates a variable whose value is determinded from the specified database file with the specified data path, for example:

geoip_set $country GeoLite2-Country.mmdb country.names.en;
geoip_set $region  GeoLite2-City.mmdb    subdivisions.0.iso_code;
geoip_set $asn     GeoLite2-ASN.mmdb     autonomous_system_number;

This directive only supports MMDB databases.