GeoIP#

Creates variables with values depending on the client IP address, using the precompiled MaxMind databases.

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

When building from the source code, this module isn't built by default; it should be enabled with the ‑‑with‑stream_geoip_module build option.

Important

This module requires the MaxMind GeoIP library.

Configuration Example#

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#

geoip_country#

Syntax

geoip_country file;

Default

Context

stream

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".

$geoip_country_name

country name, for example, "Russian Federation", "United States".

geoip_city#

Syntax

geoip_city file;

Default

Context

stream

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_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".

$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

two-symbol 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.

geoip_org#

Syntax

geoip_org file;

Default

Context

stream

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".