summaryrefslogtreecommitdiff
path: root/pod/nginx/ngx_stream_geoip_module.pod
blob: c6e2e2c1a707292316ecdc1b2806b4466a188ab1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
=encoding utf-8

=head1 NAME

ngx_stream_geoip_module - Module ngx_stream_geoip_module




=head1



The C<ngx_stream_geoip_module> module (1.11.3) creates variables
with values depending on the client IP address, using the precompiled
L<MaxMind|http://www.maxmind.com> databases.





When using the databases with IPv6 support,
IPv4 addresses are looked up as IPv4-mapped IPv6 addresses.





This module is not built by default, it should be enabled with the
C<--with-stream_geoip_module>
configuration parameter.

B<NOTE>

This module requires the
L<MaxMind GeoIP|http://www.maxmind.com/app/c> library.





=head1 Example Configuration




    
    stream {
        geoip_country         GeoIP.dat;
        geoip_city            GeoLiteCity.dat;
    
        map $geoip_city_continent_code $nearest_server {
            default        example.com;
            EU          eu.example.com;
            NA          na.example.com;
            AS          as.example.com;
        }
       ...
    }






=head1 Directives

=head2 geoip_country


B<syntax:> geoip_country I<I<C<file>>>



B<context:> I<stream>





Specifies a database used to determine the country
depending on the client IP address.
The following variables are available when using this database:

=over



=item C<$geoip_country_code>




two-letter country code, for example,
“C<RU>”, “C<US>”.



=item C<$geoip_country_code3>





three-letter country code, for example,
“C<RUS>”, “C<USA>”.



=item C<$geoip_country_name>




country name, for example,
“C<Russian Federation>”, “C<United States>”.




=back









=head2 geoip_city


B<syntax:> geoip_city I<I<C<file>>>



B<context:> I<stream>





Specifies a database used to determine the country, region, and city
depending on the client IP address.
The following variables are available when using this database:

=over



=item C<$geoip_area_code>



telephone area code (US only).

B<NOTE>

This variable may contain outdated information since
the corresponding database field is deprecated.




=item 
C<$geoip_city_continent_code>



two-letter continent code, for example,
“C<EU>”, “C<NA>”.



=item C<$geoip_city_country_code>





two-letter country code, for example,
“C<RU>”, “C<US>”.



=item C<$geoip_city_country_code3>





three-letter country code, for example,
“C<RUS>”, “C<USA>”.



=item C<$geoip_city_country_name>





country name, for example,
“C<Russian Federation>”, “C<United States>”.



=item C<$geoip_dma_code>




DMA region code in US (also known as “metro code”), according to the
L<geotargeting|https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions>
in Google AdWords API.



=item C<$geoip_latitude>



latitude.


=item C<$geoip_longitude>



longitude.


=item C<$geoip_region>




two-symbol country region code (region, territory, state, province, federal land
and the like), for example,
“C<48>”, “C<DC>”.



=item C<$geoip_region_name>




country region name (region, territory, state, province, federal land
and the like), for example,
“C<Moscow City>”, “C<District of Columbia>”.



=item C<$geoip_city>




city name, for example,
“C<Moscow>”, “C<Washington>”.



=item C<$geoip_postal_code>




postal code.




=back









=head2 geoip_org


B<syntax:> geoip_org I<I<C<file>>>



B<context:> I<stream>





Specifies a database used to determine the organization
depending on the client IP address.
The following variable is available when using this database:

=over



=item C<$geoip_org>




organization name, for example, “The University of Melbourne”.




=back