Mercurial > hg > nginx-site
view xml/en/docs/http/ngx_http_geoip_module.xml @ 678:90c27a37f4ed
nginx-1.3.6
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Wed, 12 Sep 2012 11:00:47 +0000 |
parents | 764fbac1b8b4 |
children | 3cc1c7bb0674 |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) Igor Sysoev Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Module ngx_http_geoip_module" link="/en/docs/http/ngx_http_geoip_module.html" lang="en" rev="1"> <section id="summary"> <para> The <literal>ngx_http_geoip_module</literal> module (0.8.6+) creates variables whose values depend on the client IP address, using the precompiled <link url="http://www.maxmind.com">MaxMind</link> databases. </para> <para> This module is not built by default, it should be enabled with the <literal>--with-http_geoip_module</literal> configuration parameter. <note> This module requires the <link url="http://www.maxmind.com/app/c">MaxMind GeoIP</link> library. </note> </para> </section> <section id="example" name="Example Configuration"> <para> <example> http { geoip_country GeoIP.dat; geoip_city GeoLiteCity.dat; geoip_proxy 192.168.100.0/24; geoip_proxy 2001:0db8::/32; geoip_proxy_recursive on; ... </example> </para> </section> <section id="directives" name="Directives"> <directive name="geoip_country"> <syntax><value>database</value></syntax> <default/> <context>http</context> <para> Specifies a database used to determine a country depending on the client IP address. The following variables are available when using this database: <list type="tag"> <tag-name><var>$geoip_country_code</var></tag-name> <tag-desc> two-letter country code, for example, “<literal>RU</literal>”, “<literal>US</literal>”. </tag-desc> <tag-name><var>$geoip_country_code3</var></tag-name> <tag-desc> three-letter country code, for example, “<literal>RUS</literal>”, “<literal>USA</literal>”. </tag-desc> <tag-name><var>$geoip_country_name</var></tag-name> <tag-desc> country name, for example, “<literal>Russian Federation</literal>”, “<literal>United States</literal>”. </tag-desc> </list> </para> </directive> <directive name="geoip_city"> <syntax><value>database</value></syntax> <default/> <context>http</context> <para> Specifies a database used to determine a country, region, and city depending on the client IP address. The following variables are available when using this database: <list type="tag"> <tag-name><var>$geoip_city_country_code</var></tag-name> <tag-desc> two-letter country code, for example, “<literal>RU</literal>”, “<literal>US</literal>”. </tag-desc> <tag-name><var>$geoip_city_country_code3</var></tag-name> <tag-desc> three-letter country code, for example, “<literal>RUS</literal>”, “<literal>USA</literal>”. </tag-desc> <tag-name><var>$geoip_city_country_name</var></tag-name> <tag-desc> country name, for example, “<literal>Russian Federation</literal>”, “<literal>United States</literal>”. </tag-desc> <tag-name><var>$geoip_region</var></tag-name> <tag-desc> country region name (region, territory, state, province, federal land and the like), for example, “<literal>Moscow City</literal>”, “<literal>DC</literal>”. </tag-desc> <tag-name><var>$geoip_city</var></tag-name> <tag-desc> city name, for example, “<literal>Moscow</literal>”, “<literal>Washington</literal>”. </tag-desc> <tag-name><var>$geoip_postal_code</var></tag-name> <tag-desc> postal code. </tag-desc> </list> </para> </directive> <directive name="geoip_proxy"> <syntax><value>address</value> | <value>CIDR</value></syntax> <default/> <context>http</context> <appeared-in>1.3.0</appeared-in> <appeared-in>1.2.1</appeared-in> <para> Defines trusted addresses. When a request comes from a trusted address, an address from the <header>X-Forwarded-For</header> request header field will be used instead. </para> </directive> <directive name="geoip_proxy_recursive"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <appeared-in>1.3.0</appeared-in> <appeared-in>1.2.1</appeared-in> <para> If recursive search is disabled then instead of an original client address that matches one of the trusted addresses, the last address sent in <header>X-Forwarded-For</header> will be used. If recursive search is enabled then instead an original client address that matches one of the trusted addresses, the last non-trusted address sent in <header>X-Forwarded-For</header> will be used. </para> </directive> </section> </module>