Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_realip_module.xml @ 1705:f855acbd0a94

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the $realip_remote_port variable.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 24 May 2016 20:22:35 +0300
parents bc25f237a966
children 66a30a380fba
comparison
equal deleted inserted replaced
1704:792478434bb1 1705:f855acbd0a94
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_realip_module" 10 <module name="Module ngx_http_realip_module"
11 link="/en/docs/http/ngx_http_realip_module.html" 11 link="/en/docs/http/ngx_http_realip_module.html"
12 lang="en" 12 lang="en"
13 rev="4"> 13 rev="5">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_realip_module</literal> module is used 18 The <literal>ngx_http_realip_module</literal> module is used
19 to change the client address to the one sent in the specified header field. 19 to change the client address and optional port
20 to the one sent in the specified header fields.
20 </para> 21 </para>
21 22
22 <para> 23 <para>
23 This module is not built by default, it should be enabled with the 24 This module is not built by default, it should be enabled with the
24 <literal>--with-http_realip_module</literal> 25 <literal>--with-http_realip_module</literal>
83 Defines the request header field 84 Defines the request header field
84 whose value will be used to replace the client address. 85 whose value will be used to replace the client address.
85 </para> 86 </para>
86 87
87 <para> 88 <para>
89 The <literal>X-Real-IP</literal> and <literal>X-Forwarded-For</literal>
90 parameters may contain an optional port (1.11.0).
91 The address and port should be specified according to
92 <link url="http://tools.ietf.org/html/3986">RFC 3986</link>.
93 </para>
94
95 <para>
88 The <literal>proxy_protocol</literal> parameter (1.5.12) changes 96 The <literal>proxy_protocol</literal> parameter (1.5.12) changes
89 the client address to the one from the PROXY protocol header. 97 the client address to the one from the PROXY protocol header.
90 The PROXY protocol must be previously enabled by setting the 98 The PROXY protocol must be previously enabled by setting the
91 <literal>proxy_protocol</literal> parameter 99 <literal>proxy_protocol</literal> parameter
92 in the <link doc="ngx_http_core_module.xml" id="listen"/> directive. 100 in the <link doc="ngx_http_core_module.xml" id="listen"/> directive.
127 <tag-name id="var_realip_remote_addr"><var>$realip_remote_addr</var></tag-name> 135 <tag-name id="var_realip_remote_addr"><var>$realip_remote_addr</var></tag-name>
128 <tag-desc> 136 <tag-desc>
129 keeps the original client address (1.9.7) 137 keeps the original client address (1.9.7)
130 </tag-desc> 138 </tag-desc>
131 139
140 <tag-name id="var_realip_remote_port"><var>$realip_remote_port</var></tag-name>
141 <tag-desc>
142 keeps the original client port (1.11.0)
143 </tag-desc>
144
132 </list> 145 </list>
133 </para> 146 </para>
134 147
135 </section> 148 </section>
136 149