HttpGeoipModule - Revision history

Admin: /* Directives */

2012-05-15T15:42:30Z

‎Directives

Admin: /* Directives */

2012-05-02T19:43:59Z

‎Directives

Admin: moved HttpGeoIPModule to HttpGeoipModule: correct case mapping

2012-05-01T20:12:52Z

moved HttpGeoIPModule to HttpGeoipModule: correct case mapping

Admin: /* Directives */

2012-04-30T18:10:21Z

‎Directives

VBart: /* References */ Update link to the original documentation

2012-04-21T15:50:50Z

‎References: Update link to the original documentation

Nateynate: Hope I'm not stepping on anyone's toes by sharing these.

2012-01-25T03:08:01Z

Hope I'm not stepping on anyone's toes by sharing these.

Kblessinggr at 20:39, 31 March 2011

2011-03-31T20:39:30Z

New page

= Synopsis =
This module creates ngx_http_geoip_module variables based on the IP-address of the client matched against the [http://www.maxmind.com/ MaxMind] GeoIP binary files. This module appeared in nginx version 0.7.63 and 0.8.6.

Precondition

This module needs the geo databases and the library to read from the database.

There are several options:

* Download the database yourself, e.g.:
<pre>
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
</pre>

* Install a package providing the database. For example in Debian the package is called '''geoip-database'''.
<pre>
aptitude install geoip-database
</pre>

* Install a port providing the database. For example in FreeBSD the port is called "GeoIP".
<pre>
cd /usr/ports/net/GeoIP
make install clean
</pre>

The FreeBSD port provides the GeoLite country database located at /usr/local/share/GeoIP/GeoIP.dat

Note that this is only the country database. You'll need to download the '''city''' database from Maxmind site:
<pre>
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
</pre>
To compile Nginx you'll need the library development files. In Debian they're in the package '''libgeoip-dev'''.
<pre>
aptitude install libgeoip-dev
</pre>
For systems where there's not a packaged version of the library you'll have to compile it from source:
<pre>
wget http://geolite.maxmind.com/download/geoip/api/c/GeoIP.tar.gz
</pre>
Follow the install instructions provided there.

Compile Nginx enabling Geo IP support:
<pre>
./configure --with-http_geoip_module
</pre>

You can check if your installed version of Nginx supports Geo IP with <code>nginx -V</code>. Watch for the <code> --with-http_geoip_module</code>. This means that Geo IP support is enabled.

Here'a a configuration example:
<geshi lang="nginx">
http {
geoip_country GeoIP.dat; # the country IP database
geoip_city GeoLiteCity.dat; # the city IP database
(...)
</geshi>

You can mimic Apache's mod_geoip functionality with PHP-FPM by adding the following fastcgi_param values:

(From [http://kbeezie.com/view/apache-mod_geoip-nginx/ Mimic Apache mod_geoip in Nginx])
<geshi lang="nginx">
fastcgi_param GEOIP_COUNTRY_CODE $geoip_country_code;
fastcgi_param GEOIP_COUNTRY_NAME $geoip_country_name;
</geshi>

= Directives =
== geoip_country ==
'''syntax:''' ''geoip_country path/to/db.dat;''

'''default:''' none

'''context:''' ''http''

This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country geolocation information. This allows you to get the country corresponding to the given IP. It can be used to determine the visitor's country from the IP address of the client. When set the following variables are available:

* $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 — the (verbose) name of the country, for example, "Russian Federation", "United States", &c.

Nginx caches all supplied databases in memory. The country database is small, roughly 1.4M, therefore there's very little penalty in caching it. The city database is much bigger. Hence its memory footprint is larger.

== geoip_city ==
'''syntax:''' ''geoip_city path/to/db.dat;''

'''default:''' none

'''context:''' ''http''

This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country, city and region geolocation information. This allows you to get that information corresponding to the given IP. It can be used to determine the visitor's geolocation from the IP address of the client. When set the following variables are available:

* '''$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''' — the name of the country, for example, "Russian Federation", "United States" — if available.
* '''$geoip_region''' — the name of region (province, region, state, province, federal land, and the like), for example, "Moscow City", "DC" — if available.
* '''$geoip_city''' — the name of the city, for example, "Moscow", "Washington", "Lisbon", &c — if available.
* '''$geoip_postal_code''' — zip code or postal code — if available.
* '''$geoip_city_continent_code''' — if available.
* '''$geoip_latitude''' — latitude — if available.
* '''$geoip_longitude''' — longitude — if available.

= References =
[http://sysoev.ru/nginx/docs/http/ngx_http_geoip_module.html Original Documentation]

@@ Line 91: / Line 91: @@
 * '''$geoip_dma_code''' &mdash; DMA Code &mdash; if available.
 * '''$geoip_area_code''' &mdash; Area Code &mdash; if available.
 = References =
 [http://nginx.org/en/docs/http/ngx_http_geoip_module.html Original Documentation]

@@ Line 65: / Line 65: @@
 = Directives =
 == geoip_country ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_geoip_module/geoip_country.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_country.txt" />
 This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country geolocation information. This allows you to get the country corresponding to the given IP. It can be used to determine the visitor's country from the IP address of the client. When set the following variables are available:
@@ Line 76: / Line 76: @@
 == geoip_city ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_geoip_module/geoip_city.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_city.txt" />
 This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country, city and region geolocation information. This allows you to get that information corresponding to the given IP. It can be used to determine the visitor's geolocation from the IP address of the client. When set the following variables are available:

← Older revision		Revision as of 15:50, 21 April 2012
Line 101:		Line 101:

	= References =		= References =
−	[http://~~sysoev~~.ru/~~nginx~~/docs/http/ngx_http_geoip_module.html Original Documentation]	+	[http://nginx.org/en/docs/http/ngx_http_geoip_module.html Original Documentation]

@@ Line 97: / Line 97: @@
 * '''$geoip_latitude''' &mdash; latitude &mdash; if available.
 * '''$geoip_longitude''' &mdash; longitude &mdash; if available.
 = References =
 [http://sysoev.ru/nginx/docs/http/ngx_http_geoip_module.html Original Documentation]