Mercurial > hg > nginx-site
diff xml/en/docs/http/ngx_http_core_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 | 3fde5aa256ac |
children | ebe027a963f4 |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml +++ b/xml/en/docs/http/ngx_http_core_module.xml @@ -10,7 +10,7 @@ <module name="Module ngx_http_core_module" link="/en/docs/http/ngx_http_core_module.html" lang="en" - rev="29"> + rev="30"> <section id="directives" name="Directives"> @@ -1098,6 +1098,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the [<literal>default_server</literal>] [<literal>ssl</literal>] [<literal>spdy</literal>] + [<literal>proxy_protocol</literal>] [<literal>setfib</literal>=<value>number</value>] [<literal>fastopen</literal>=<value>number</value>] [<literal>backlog</literal>=<value>number</value>] @@ -1113,6 +1114,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the [<literal>default_server</literal>] [<literal>ssl</literal>] [<literal>spdy</literal>] + [<literal>proxy_protocol</literal>] [<literal>setfib</literal>=<value>number</value>] [<literal>fastopen</literal>=<value>number</value>] [<literal>backlog</literal>=<value>number</value>] @@ -1128,6 +1130,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the [<literal>default_server</literal>] [<literal>ssl</literal>] [<literal>spdy</literal>] + [<literal>proxy_protocol</literal>] [<literal>backlog</literal>=<value>number</value>] [<literal>rcvbuf</literal>=<value>size</value>] [<literal>sndbuf</literal>=<value>size</value>] @@ -1205,6 +1208,13 @@ connections without SSL. </para> <para> +The <literal>proxy_protocol</literal> parameter (1.5.12) +allows specifying that all connections accepted on this port should use the +<link url="http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt">PROXY +protocol</link>. +</para> + +<para> A <literal>listen</literal> directive can have several additional parameters specific to socket-related system calls. These parameters can be specified in any @@ -2887,6 +2897,17 @@ PID of the worker process otherwise (1.3.12, 1.2.7) </tag-desc> +<tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name> +<tag-desc> +client address from the PROXY protocol header, or an empty string otherwise +(1.5.12) +<para> +The PROXY protocol must be previously enabled by setting the +<literal>proxy_protocol</literal> parameter +in the <link id="listen"/> directive. +</para> +</tag-desc> + <tag-name id="var_query_string"><var>$query_string</var></tag-name> <tag-desc> same as <var>$args</var>