Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_realip_module.xml @ 1779:ee56773d44e8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented ngx_stream_realip_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 13 Sep 2016 16:14:00 +0300
parents xml/en/docs/http/ngx_http_realip_module.xml@f855acbd0a94
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) 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
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
9 <module name="Module ngx_stream_realip_module"
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
10 link="/en/docs/stream/ngx_stream_realip_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
11 lang="en"
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
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>
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
17 The <literal>ngx_stream_realip_module</literal> module is used
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
18 to change the client address and port
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
19 to the ones sent in the PROXY protocol header (1.11.4).
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
20 The PROXY protocol must be previously enabled by setting the
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
21 <link doc="ngx_stream_core_module.xml" id="proxy_protocol"/> parameter
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
22 in the <literal>listen</literal> directive.
348
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
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 <para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 This module is not built by default, it should be enabled with the
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
27 <literal>--with-stream_realip_module</literal>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 configuration parameter.
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 </section>
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
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <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
35
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 <example>
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
38 listen 12345 proxy_protocol;
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
39
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
40 set_real_ip_from 192.168.1.0/24;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
41 set_real_ip_from 192.168.2.1;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
42 set_real_ip_from 2001:0db8::/32;
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 </example>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <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
50
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <directive name="set_real_ip_from">
468
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
52 <syntax>
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
53 <value>address</value> |
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
54 <value>CIDR</value> |
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
55 <literal>unix:</literal></syntax>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <default/>
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
57 <context>stream</context>
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <context>server</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>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
61 Defines trusted addresses that are known to send correct
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 replacement addresses.
468
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
63 If the special value <literal>unix:</literal> is specified,
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
64 all UNIX-domain sockets will be trusted.
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 </para>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 </directive>
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 </section>
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70
1601
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
71
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
72 <section id="variables" name="Embedded Variables">
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
73
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
74 <para>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
75 <list type="tag">
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
76
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
77 <tag-name id="var_realip_remote_addr"><var>$realip_remote_addr</var></tag-name>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
78 <tag-desc>
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
79 keeps the original client address
1601
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
80 </tag-desc>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
81
1705
f855acbd0a94 Documented the $realip_remote_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1602
diff changeset
82 <tag-name id="var_realip_remote_port"><var>$realip_remote_port</var></tag-name>
f855acbd0a94 Documented the $realip_remote_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1602
diff changeset
83 <tag-desc>
1779
ee56773d44e8 Documented ngx_stream_realip_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1705
diff changeset
84 keeps the original client port
1705
f855acbd0a94 Documented the $realip_remote_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1602
diff changeset
85 </tag-desc>
f855acbd0a94 Documented the $realip_remote_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1602
diff changeset
86
1601
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
87 </list>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
88 </para>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
89
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
90 </section>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
91
348
5a848934a12d English translation of ngx_http_geoip_module, ngx_http_map_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 </module>