Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_geoip_module.xml @ 2769:16f6fa718be2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated TLSv1.3 support notes. Previous notes described some early development snapshot of OpenSSL 1.1.1 with disabled TLSv1.3 by default. It was then enabled in the first alpha. Further, the updated text covers later major releases such as OpenSSL 3.0.
author Sergey Kandaurov <pluknet@nginx.com>
date Thu, 30 Sep 2021 16:29:20 +0300
parents 07402a11fd8d
children
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"
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
13 rev="5">
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
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
19 with values depending on the client IP address, using the precompiled
348
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>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
24 When using the databases with IPv6 support (1.3.12, 1.2.7),
824
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
25 IPv4 addresses are looked up as IPv4-mapped IPv6 addresses.
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
26 </para>
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
27
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
28 <para>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 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
30 <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
31 configuration parameter.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <note>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 This module requires the
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <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
35 </note>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 </para>
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 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 <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
42
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 <example>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 http {
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
46 geoip_country GeoIP.dat;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
47 geoip_city GeoLiteCity.dat;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
48 geoip_proxy 192.168.100.0/24;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
49 geoip_proxy 2001:0db8::/32;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
50 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
51 ...
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 </example>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 </para>
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 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <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
59
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <directive name="geoip_country">
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
61 <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
62 <default/>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <context>http</context>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
66 Specifies a database used to determine the country
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 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
68 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
69 <list type="tag">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
71 <tag-name id="var_geoip_country_code"><var>$geoip_country_code</var></tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 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
74 “<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
75 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
77 <tag-name id="var_geoip_country_code3"><var>$geoip_country_code3</var>
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
78 </tag-name>
348
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 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
81 “<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
82 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
84 <tag-name id="var_geoip_country_name"><var>$geoip_country_name</var></tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 country name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 “<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
88 </tag-desc>
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 </list>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 </directive>
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
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 <directive name="geoip_city">
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
97 <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
98 <default/>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 <context>http</context>
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 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
102 Specifies a database used to determine the country, region, and city
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 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
104 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
105 <list type="tag">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
107 <tag-name id="var_geoip_area_code"><var>$geoip_area_code</var></tag-name>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
108 <tag-desc>telephone area code (US only).
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
109 <note>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
110 This variable may contain outdated information since
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
111 the corresponding database field is deprecated.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
112 </note>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
113 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
114
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
115 <tag-name id="var_geoip_city_continent_code">
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
116 <var>$geoip_city_continent_code</var></tag-name>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
117 <tag-desc>two-letter continent code, for example,
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
118 “<literal>EU</literal>”, “<literal>NA</literal>”.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
119 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
120
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
121 <tag-name id="var_geoip_city_country_code"><var>$geoip_city_country_code</var>
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
122 </tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 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
125 “<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
126 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
128 <tag-name id="var_geoip_city_country_code3"><var>$geoip_city_country_code3</var>
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
129 </tag-name>
348
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 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
132 “<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
133 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
135 <tag-name id="var_geoip_city_country_name"><var>$geoip_city_country_name</var>
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
136 </tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 country name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 “<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
140 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
142 <tag-name id="var_geoip_dma_code"><var>$geoip_dma_code</var></tag-name>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
143 <tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
144 DMA region code in US (also known as “metro code”), according to the
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
145 <link url="https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions">geotargeting</link>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
146 in Google AdWords API.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
147 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
148
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
149 <tag-name id="var_geoip_latitude"><var>$geoip_latitude</var></tag-name>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
150 <tag-desc>latitude.</tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
151
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
152 <tag-name id="var_geoip_longitude"><var>$geoip_longitude</var></tag-name>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
153 <tag-desc>longitude.</tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
154
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
155 <tag-name id="var_geoip_region"><var>$geoip_region</var></tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 <tag-desc>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
157 two-symbol country region code (region, territory, state, province, federal land
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
158 and the like), for example,
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
159 “<literal>48</literal>”, “<literal>DC</literal>”.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
160 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
161
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
162 <tag-name id="var_geoip_region_name"><var>$geoip_region_name</var></tag-name>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
163 <tag-desc>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 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
165 and the like), for example,
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
166 “<literal>Moscow City</literal>”, “<literal>District of Columbia</literal>”.
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
169 <tag-name id="var_geoip_city"><var>$geoip_city</var></tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 city name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 “<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
173 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
175 <tag-name id="var_geoip_postal_code"><var>$geoip_postal_code</var></tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 postal code.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 </list>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 </directive>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
185
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
186 <directive name="geoip_org">
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
187 <syntax><value>file</value></syntax>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
188 <default/>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
189 <context>http</context>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
190 <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
191
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
192 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
193 Specifies a database used to determine the organization
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
194 depending on the client IP address.
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
195 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
196 <list type="tag">
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
197
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
198 <tag-name id="var_geoip_org"><var>$geoip_org</var></tag-name>
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
199 <tag-desc>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
200 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
201 </tag-desc>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
202
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
203 </list>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
204 </para>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
205
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
206 </directive>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
207
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
208
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
209 <directive name="geoip_proxy">
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
210 <syntax><value>address</value> | <value>CIDR</value></syntax>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
211 <default/>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
212 <context>http</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
213 <appeared-in>1.3.0</appeared-in>
523
a8daad8e83bb Documented 1.2.1 changes.
Ruslan Ermilov <ru@nginx.com>
parents: 518
diff changeset
214 <appeared-in>1.2.1</appeared-in>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
215
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
216 <para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
217 Defines trusted addresses.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
218 When a request comes from a trusted address,
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
219 an address from the <header>X-Forwarded-For</header> request
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
220 header field will be used instead.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
221 </para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
222
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
223 </directive>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
224
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
225
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
226 <directive name="geoip_proxy_recursive">
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
227 <syntax><literal>on</literal> | <literal>off</literal></syntax>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
228 <default>off</default>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
229 <context>http</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
230 <appeared-in>1.3.0</appeared-in>
523
a8daad8e83bb Documented 1.2.1 changes.
Ruslan Ermilov <ru@nginx.com>
parents: 518
diff changeset
231 <appeared-in>1.2.1</appeared-in>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
232
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
233 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
234 If recursive search is disabled then instead of the original client
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
235 address that matches one of the trusted addresses, the last
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
236 address sent in <header>X-Forwarded-For</header> will be used.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
237 If recursive search is enabled then instead of the original client
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
238 address that matches one of the trusted addresses, the last
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
239 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
240 </para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
241
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
242 </directive>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
243
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 </module>