Mercurial > hg > nginx-site

comparison xml/ru/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/ru/docs/http/ngx_http_geoip_module.xml@07402a11fd8d
children 8e2a95422dc4
comparison
equal deleted inserted replaced
1749:153a99d25210 1750:0e591e97737c
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Модуль ngx_stream_geoip_module"
10 link="/ru/docs/http/ngx_stream_geoip_module.html"
11 lang="ru"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 Модуль <literal>ngx_stream_geoip_module</literal> (1.11.3) создаёт переменные,
18 значения которых зависят от IP-адреса клиента, используя готовые базы данных
19 <link url="http://www.maxmind.com">MaxMind</link>.
20 </para>
21
22 <para>
23 При использовании баз данных с поддержкой IPv6
24 IPv4-адреса ищутся отображёнными на IPv6.
25 </para>
26
27 <para>
28 По умолчанию этот модуль не собирается, его сборку необходимо
29 разрешить с помощью конфигурационного параметра
30 <literal>--with-stream_geoip_module</literal>.
31 <note>
32 Для сборки и работы этого модуля нужна библиотека
33 <link url="http://www.maxmind.com/app/c">MaxMind GeoIP</link>.
34 </note>
35 </para>
36
37 </section>
38
39
40 <section id="example" name="Пример конфигурации">
41
42 <para>
43 <example>
44 stream {
45 geoip_country GeoIP.dat;
46 geoip_city GeoLiteCity.dat;
47
48 map $geoip_city_continent_code $nearest_server {
49 default example.com;
50 EU eu.example.com;
51 NA na.example.com;
52 AS as.example.com;
53 }
54 ...
55 }
56 </example>
57 </para>
58
59 </section>
60
61
62 <section id="directives" name="Директивы">
63
64 <directive name="geoip_country">
65 <syntax><value>файл</value></syntax>
66 <default/>
67 <context>stream</context>
68
69 <para>
70 Задаёт базу данных для определения страны в зависимости
71 от значения IP-адреса клиента.
72 При использовании этой базы данных доступны следующие переменные:
73 <list type="tag">
74
75 <tag-name id="var_geoip_country_code"><var>$geoip_country_code</var></tag-name>
76 <tag-desc>
77 двухбуквенный код страны, например,
78 “<literal>RU</literal>”, “<literal>US</literal>”.
79 </tag-desc>
80
81 <tag-name id="var_geoip_country_code3"><var>$geoip_country_code3</var>
82 </tag-name>
83 <tag-desc>
84 трёхбуквенный код страны, например,
85 “<literal>RUS</literal>”, “<literal>USA</literal>”.
86 </tag-desc>
87
88 <tag-name id="var_geoip_country_name"><var>$geoip_country_name</var></tag-name>
89 <tag-desc>
90 название страны, например,
91 “<literal>Russian Federation</literal>”, “<literal>United States</literal>”.
92 </tag-desc>
93
94 </list>
95 </para>
96
97 </directive>
98
99
100 <directive name="geoip_city">
101 <syntax><value>файл</value></syntax>
102 <default/>
103 <context>stream</context>
104
105 <para>
106 Задаёт базу данных для определения страны, региона и города
107 в зависимости от значения IP-адреса клиента.
108 При использовании этой базы данных доступны следующие переменные:
109 <list type="tag">
110
111 <tag-name id="var_geoip_area_code"><var>$geoip_area_code</var></tag-name>
112 <tag-desc>телефонный код области (только для США).
113 <note>
114 Данная переменная может содержать неактуальную информацию, т.к.
115 соответствующее поле базы данных объявлено устаревшим.
116 </note>
117 </tag-desc>
118
119 <tag-name id="var_geoip_city_continent_code">
120 <var>$geoip_city_continent_code</var>
121 </tag-name>
122 <tag-desc>двухбуквенный код континента, например,
123 “<literal>EU</literal>”, “<literal>NA</literal>”.
124 </tag-desc>
125
126 <tag-name id="var_geoip_city_country_code"><var>$geoip_city_country_code</var>
127 </tag-name>
128 <tag-desc>
129 двухбуквенный код страны, например,
130 “<literal>RU</literal>”, “<literal>US</literal>”.
131 </tag-desc>
132
133 <tag-name id="var_geoip_city_country_code3"><var>$geoip_city_country_code3</var>
134 </tag-name>
135 <tag-desc>
136 трёхбуквенный код страны, например,
137 “<literal>RUS</literal>”, “<literal>USA</literal>”.
138 </tag-desc>
139
140 <tag-name id="var_geoip_city_country_name"><var>$geoip_city_country_name</var>
141 </tag-name>
142 <tag-desc>
143 название страны, например,
144 “<literal>Russian Federation</literal>”, “<literal>United States</literal>”.
145 </tag-desc>
146
147 <tag-name id="var_geoip_dma_code"><var>$geoip_dma_code</var></tag-name>
148 <tag-desc>
149 DMA-код региона в США (также известный как “код агломерации”), согласно
150 <link url="https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions">геотаргетингу</link>
151 Google AdWords API.
152 </tag-desc>
153
154 <tag-name id="var_geoip_latitude"><var>$geoip_latitude</var></tag-name>
155 <tag-desc>широта.</tag-desc>
156
157 <tag-name id="var_geoip_longitude"><var>$geoip_longitude</var></tag-name>
158 <tag-desc>долгота.</tag-desc>
159
160 <tag-name id="var_geoip_region"><var>$geoip_region</var></tag-name>
161 <tag-desc>
162 двухсимвольный код региона страны (область, край, штат,
163 провинция, федеральная земля и тому подобное), например,
164 “<literal>48</literal>”, “<literal>DC</literal>”.
165 </tag-desc>
166
167 <tag-name id="var_geoip_region_name"><var>$geoip_region_name</var></tag-name>
168 <tag-desc>
169 название региона страны (область, край, штат,
170 провинция, федеральная земля и тому подобное), например,
171 “<literal>Moscow City</literal>”, “<literal>District of Columbia</literal>”.
172 </tag-desc>
173
174 <tag-name id="var_geoip_city"><var>$geoip_city</var></tag-name>
175 <tag-desc>
176 название города, например,
177 “<literal>Moscow</literal>”, “<literal>Washington</literal>”.
178 </tag-desc>
179
180 <tag-name id="var_geoip_postal_code"><var>$geoip_postal_code</var></tag-name>
181 <tag-desc>
182 почтовый индекс.
183 </tag-desc>
184
185 </list>
186 </para>
187
188 </directive>
189
190
191 <directive name="geoip_org">
192 <syntax><value>файл</value></syntax>
193 <default/>
194 <context>stream</context>
195
196 <para>
197 Задаёт базу данных для определения названия организации
198 в зависимости от значения IP-адреса клиента.
199 При использовании этой базы данных доступна следующая переменная:
200 <list type="tag">
201
202 <tag-name id="var_geoip_org"><var>$geoip_org</var></tag-name>
203 <tag-desc>
204 название организации, например, “The University of Melbourne”.
205 </tag-desc>
206
207 </list>
208 </para>
209
210 </directive>
211
212 </section>
213
214 </module>