Mercurial > hg > nginx-site
diff xml/en/docs/stream/ngx_stream_core_module.xml @ 1778:1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 13 Sep 2016 16:03:19 +0300 |
parents | 6a30f04a0208 |
children | 8df9ba4e56c6 |
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_core_module.xml +++ b/xml/en/docs/stream/ngx_stream_core_module.xml @@ -9,7 +9,7 @@ <module name="Module ngx_stream_core_module" link="/en/docs/stream/ngx_stream_core_module.html" lang="en" - rev="17"> + rev="18"> <section id="summary"> @@ -82,6 +82,7 @@ stream { <value>address</value>:<value>port</value> [<literal>ssl</literal>] [<literal>udp</literal>] + [<literal>proxy_protocol</literal>] [<literal>backlog</literal>=<value>number</value>] [<literal>bind</literal>] [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] @@ -124,6 +125,13 @@ The <literal>udp</literal> parameter con for working with datagrams (1.9.13). </para> +<para id="proxy_protocol"> +The <literal>proxy_protocol</literal> parameter (1.11.4) +allows specifying that all connections accepted on this port should use the +<link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY +protocol</link>. +</para> + <para> The <literal>listen</literal> directive can have several additional parameters specific to socket-related system calls. @@ -417,6 +425,28 @@ protocol used to communicate with the cl <literal>TCP</literal> or <literal>UDP</literal> (1.11.4) </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.11.4) +<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_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name> +<tag-desc> +client port from the PROXY protocol header, or an empty string otherwise +(1.11.4) +<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_remote_addr"><var>$remote_addr</var></tag-name> <tag-desc> client address