Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_geoip_module.xml @ 1750:0e591e97737c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the geoip module in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 13 Jul 2016 21:15:55 +0300
parents xml/en/docs/http/ngx_http_geoip_module.xml@07402a11fd8d
children 3064cb25e29d
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) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
5 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
6
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <!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
8
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
9 <module name="Module ngx_stream_geoip_module"
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
10 link="/en/docs/stream/ngx_http_geoip_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
11 lang="en"
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
12 rev="1">
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
17 The <literal>ngx_stream_geoip_module</literal> module (1.11.3) creates variables
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
18 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
19 <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
20 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <para>
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
23 When using the databases with IPv6 support,
824
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
24 IPv4 addresses are looked up as IPv4-mapped IPv6 addresses.
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
25 </para>
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
26
c66610f9a53f GeoIP: IPv6 support.
Ruslan Ermilov <ru@nginx.com>
parents: 689
diff changeset
27 <para>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 This module is not built by default, it should be enabled with the
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
29 <literal>--with-stream_geoip_module</literal>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 configuration parameter.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 <note>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 This module requires the
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <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
34 </note>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38
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 <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
41
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 <example>
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
44 stream {
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
45 geoip_country GeoIP.dat;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
46 geoip_city GeoLiteCity.dat;
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
47
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
48 map $geoip_city_continent_code $nearest_server {
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
49 default example.com;
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
50 EU eu.example.com;
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
51 NA na.example.com;
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
52 AS as.example.com;
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
53 }
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
54 ...
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
55 }
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 </example>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <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
63
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <directive name="geoip_country">
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
65 <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
66 <default/>
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
67 <context>stream</context>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
70 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
71 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
72 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
73 <list type="tag">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
75 <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
76 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 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
78 “<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
79 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
81 <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
82 </tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 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
85 “<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
86 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
88 <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
89 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 country name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 “<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
92 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 </list>
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
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 </directive>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <directive name="geoip_city">
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
101 <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
102 <default/>
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
103 <context>stream</context>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
106 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
107 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
108 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
109 <list type="tag">
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
111 <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
112 <tag-desc>telephone area code (US only).
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
113 <note>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
114 This variable may contain outdated information since
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
115 the corresponding database field is deprecated.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
116 </note>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
117 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
118
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
119 <tag-name id="var_geoip_city_continent_code">
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
120 <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
121 <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
122 “<literal>EU</literal>”, “<literal>NA</literal>”.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
123 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
124
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
125 <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
126 </tag-name>
348
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 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
129 “<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
130 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
132 <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
133 </tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 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
136 “<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
137 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
139 <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
140 </tag-name>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 country name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 “<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
144 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
146 <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
147 <tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
148 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
149 <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
150 in Google AdWords API.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
151 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
152
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
153 <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
154 <tag-desc>latitude.</tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
155
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
156 <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
157 <tag-desc>longitude.</tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
158
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
159 <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
160 <tag-desc>
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
161 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
162 and the like), for example,
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
163 “<literal>48</literal>”, “<literal>DC</literal>”.
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
164 </tag-desc>
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
165
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
166 <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
167 <tag-desc>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 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
169 and the like), for example,
834
1a6cb3e282fe GeoIP: updated description of module variables (English).
Homutov Vladimir <vl@nginx.com>
parents: 824
diff changeset
170 “<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
171 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
173 <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
174 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 city name, for example,
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 “<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
177 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
179 <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
180 <tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 postal code.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 </tag-desc>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 </list>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 </directive>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 348
diff changeset
189
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
190 <directive name="geoip_org">
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
191 <syntax><value>file</value></syntax>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
192 <default/>
1750
0e591e97737c Documented the geoip module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1155
diff changeset
193 <context>stream</context>
689
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
194
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
195 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 840
diff changeset
196 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
197 depending on the client IP address.
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
198 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
199 <list type="tag">
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
200
1155
07402a11fd8d Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
201 <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
202 <tag-desc>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
203 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
204 </tag-desc>
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 </list>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
207 </para>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
208
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
209 </directive>
3cc1c7bb0674 Documented geoip_org directive and fixed parameter names
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
210
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 </module>