annotate xml/en/docs/http/ngx_http_geoip_module.xml @ 689:3cc1c7bb0674

Documented geoip_org directive and fixed parameter names
author Vladimir Homutov <vl@nginx.com>
date Wed, 26 Sep 2012 12:36:37 +0000
parents 764fbac1b8b4
children c66610f9a53f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
7
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_geoip_module"
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_geoip_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
13 rev="1">
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_geoip_module</literal> module (0.8.6+) creates variables
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 whose values depend on the client IP address, using the precompiled
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 <link url="http://www.maxmind.com">MaxMind</link> databases.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 This module is not built by default, it should be enabled with the
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 <literal>--with-http_geoip_module</literal>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 configuration parameter.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 <note>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 This module requires the
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 <link url="http://www.maxmind.com/app/c">MaxMind GeoIP</link> library.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 </note>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 <section id="example" name="Example Configuration">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 <example>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 http {
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
41 geoip_country GeoIP.dat;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
42 geoip_city GeoLiteCity.dat;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
43 geoip_proxy 192.168.100.0/24;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
44 geoip_proxy 2001:0db8::/32;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
45 geoip_proxy_recursive on;
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 ...
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 </example>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <section id="directives" name="Directives">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <directive name="geoip_country">
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
56 <syntax><value>file</value></syntax>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <default/>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <context>http</context>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 Specifies a database used to determine a country
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 depending on the client IP address.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 The following variables are available when using this database:
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <list type="tag">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <tag-name><var>$geoip_country_code</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 two-letter country code, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 “<literal>RU</literal>”, “<literal>US</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 <tag-name><var>$geoip_country_code3</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 three-letter country code, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 “<literal>RUS</literal>”, “<literal>USA</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <tag-name><var>$geoip_country_name</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 country name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 “<literal>Russian Federation</literal>”, “<literal>United States</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 </list>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </directive>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <directive name="geoip_city">
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
91 <syntax><value>file</value></syntax>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <default/>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <context>http</context>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 Specifies a database used to determine a country, region, and city
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 depending on the client IP address.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 The following variables are available when using this database:
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 <list type="tag">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 <tag-name><var>$geoip_city_country_code</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 two-letter country code, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 “<literal>RU</literal>”, “<literal>US</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <tag-name><var>$geoip_city_country_code3</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 three-letter country code, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 “<literal>RUS</literal>”, “<literal>USA</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <tag-name><var>$geoip_city_country_name</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 country name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 “<literal>Russian Federation</literal>”, “<literal>United States</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 <tag-name><var>$geoip_region</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 country region name (region, territory, state, province, federal land
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 and the like), for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 “<literal>Moscow City</literal>”, “<literal>DC</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 <tag-name><var>$geoip_city</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 city name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 “<literal>Moscow</literal>”, “<literal>Washington</literal>”.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 <tag-name><var>$geoip_postal_code</var></tag-name>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 postal code.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137 </list>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 </directive>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
142
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
143 <directive name="geoip_org">
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
144 <syntax><value>file</value></syntax>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
145 <default/>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
146 <context>http</context>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
147 <appeared-in>1.0.3</appeared-in>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
148
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
149 <para>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
150 Specifies a database used to determine an organization
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
151 depending on the client IP address.
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
152 The following variable is available when using this database:
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
153 <list type="tag">
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
154
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
155 <tag-name><var>$geoip_org</var></tag-name>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
156 <tag-desc>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
157 organization name, for example, “The University of Melbourne”.
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
158 </tag-desc>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
159
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
160 </list>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
161 </para>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
162
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
163 </directive>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
164
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
165
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
166 <directive name="geoip_proxy">
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
167 <syntax><value>address</value> | <value>CIDR</value></syntax>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
168 <default/>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
169 <context>http</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
170 <appeared-in>1.3.0</appeared-in>
523
a8daad8e83bb Documented 1.2.1 changes.
Ruslan Ermilov <ru@nginx.com>
parents: 518
diff changeset
171 <appeared-in>1.2.1</appeared-in>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
172
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
173 <para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
174 Defines trusted addresses.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
175 When a request comes from a trusted address,
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
176 an address from the <header>X-Forwarded-For</header> request
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
177 header field will be used instead.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
178 </para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
179
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
180 </directive>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
181
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
182
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
183 <directive name="geoip_proxy_recursive">
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
184 <syntax><literal>on</literal> | <literal>off</literal></syntax>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
185 <default>off</default>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
186 <context>http</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
187 <appeared-in>1.3.0</appeared-in>
523
a8daad8e83bb Documented 1.2.1 changes.
Ruslan Ermilov <ru@nginx.com>
parents: 518
diff changeset
188 <appeared-in>1.2.1</appeared-in>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
189
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
190 <para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
191 If recursive search is disabled then instead of an original client
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
192 address that matches one of the trusted addresses, the last
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
193 address sent in <header>X-Forwarded-For</header> will be used.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
194 If recursive search is enabled then instead an original client
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
195 address that matches one of the trusted addresses, the last
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
196 non-trusted address sent in <header>X-Forwarded-For</header> will be used.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
197 </para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
198
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
199 </directive>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
200
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 </module>