diff 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
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_realip_module.xml	Tue Mar 04 13:02:21 2014 +0000
+++ b/xml/en/docs/http/ngx_http_realip_module.xml	Tue Mar 18 19:59:24 2014 +0400
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_realip_module"
         link="/en/docs/http/ngx_http_realip_module.html"
         lang="en"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -72,7 +72,8 @@
 <syntax>
     <value>field</value> |
     <literal>X-Real-IP</literal> |
-    <literal>X-Forwarded-For</literal></syntax>
+    <literal>X-Forwarded-For</literal> |
+    <literal>proxy_protocol</literal></syntax>
 <default>X-Real-IP</default>
 <context>http</context>
 <context>server</context>
@@ -83,6 +84,14 @@
 the address for a replacement.
 </para>
 
+<para>
+The <literal>proxy_protocol</literal> parameter (1.5.12) changes
+the client address to the one from the PROXY protocol header.
+The PROXY protocol must be previously enabled by setting the
+<literal>proxy_protocol</literal> parameter
+in the <link doc="ngx_http_core_module.xml" id="listen"/> directive.
+</para>
+
 </directive>