Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_realip_module.xml @ 1097:eeb690d4212b
Documented the PROXY protocol support.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 18 Mar 2014 19:59:24 +0400 |
parents | 95c3c3bbf1ce |
children | 3b4a86b3515e |
comparison
equal
deleted
inserted
replaced
1096:f34be6b26447 | 1097:eeb690d4212b |
---|---|
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="1"> | 13 rev="2"> |
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 |
70 | 70 |
71 <directive name="real_ip_header"> | 71 <directive name="real_ip_header"> |
72 <syntax> | 72 <syntax> |
73 <value>field</value> | | 73 <value>field</value> | |
74 <literal>X-Real-IP</literal> | | 74 <literal>X-Real-IP</literal> | |
75 <literal>X-Forwarded-For</literal></syntax> | 75 <literal>X-Forwarded-For</literal> | |
76 <literal>proxy_protocol</literal></syntax> | |
76 <default>X-Real-IP</default> | 77 <default>X-Real-IP</default> |
77 <context>http</context> | 78 <context>http</context> |
78 <context>server</context> | 79 <context>server</context> |
79 <context>location</context> | 80 <context>location</context> |
80 | 81 |
81 <para> | 82 <para> |
82 Defines a request header field used to send | 83 Defines a request header field used to send |
83 the address for a replacement. | 84 the address for a replacement. |
85 </para> | |
86 | |
87 <para> | |
88 The <literal>proxy_protocol</literal> parameter (1.5.12) changes | |
89 the client address to the one from the PROXY protocol header. | |
90 The PROXY protocol must be previously enabled by setting the | |
91 <literal>proxy_protocol</literal> parameter | |
92 in the <link doc="ngx_http_core_module.xml" id="listen"/> directive. | |
84 </para> | 93 </para> |
85 | 94 |
86 </directive> | 95 </directive> |
87 | 96 |
88 | 97 |