Mercurial > hg > nginx-site

changeset 1778:1626f1bf164c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 8b1ef02c8686
children ee56773d44e8
files xml/en/docs/stream/ngx_stream_core_module.xml xml/ru/docs/stream/ngx_stream_core_module.xml
diffstat 2 files changed, 61 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_core_module.xml	Fri Sep 09 18:51:33 2016 +0300
+++ b/xml/en/docs/stream/ngx_stream_core_module.xml	Tue Sep 13 16:03:19 2016 +0300
@@ -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 @@
     <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 @@
 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 @@
 <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
--- a/xml/ru/docs/stream/ngx_stream_core_module.xml	Fri Sep 09 18:51:33 2016 +0300
+++ b/xml/ru/docs/stream/ngx_stream_core_module.xml	Tue Sep 13 16:03:19 2016 +0300
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_core_module"
         link="/ru/docs/stream/ngx_stream_core_module.html"
         lang="ru"
-        rev="17">
+        rev="18">
 
 <section id="summary">
 
@@ -82,6 +82,7 @@
     <value>адрес</value>:<value>порт</value>
     [<literal>ssl</literal>]
     [<literal>udp</literal>]
+    [<literal>proxy_protocol</literal>]
     [<literal>backlog</literal>=<value>число</value>]
     [<literal>bind</literal>]
     [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>]
@@ -123,6 +124,14 @@
 для работы с датаграммами (1.9.13).
 </para>
 
+<para id="proxy_protocol">
+Параметр <literal>proxy_protocol</literal> (1.11.4)
+указывает на то, что все соединения, принимаемые на данном порту,
+должны использовать
+<link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">протокол
+PROXY</link>.
+</para>
+
 <para>
 В директиве <literal>listen</literal> можно также указать несколько
 дополнительных параметров, специфичных для связанных с сокетами
@@ -425,6 +434,26 @@
 <literal>TCP</literal> или <literal>UDP</literal> (1.11.4)
 </tag-desc>
 
+<tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name>
+<tag-desc>
+адрес клиента, полученный из заголовка протокола PROXY, либо пустая строка
+(1.11.4)
+<para>
+Протокол PROXY должен быть предварительно включён при помощи установки
+параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
+</para>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
+<tag-desc>
+порт клиента, полученный из заголовка протокола PROXY, либо пустая строка
+(1.11.4)
+<para>
+Протокол PROXY должен быть предварительно включён при помощи установки
+параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
+</para>
+</tag-desc>
+
 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
 <tag-desc>
 адрес клиента