Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_core_module.xml @ 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 6a30f04a0208
children 8df9ba4e56c6
comparison
equal deleted inserted replaced
1777:8b1ef02c8686 1778:1626f1bf164c
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_core_module" 9 <module name="Module ngx_stream_core_module"
10 link="/en/docs/stream/ngx_stream_core_module.html" 10 link="/en/docs/stream/ngx_stream_core_module.html"
11 lang="en" 11 lang="en"
12 rev="17"> 12 rev="18">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_core_module</literal> module 17 The <literal>ngx_stream_core_module</literal> module
80 <directive name="listen"> 80 <directive name="listen">
81 <syntax> 81 <syntax>
82 <value>address</value>:<value>port</value> 82 <value>address</value>:<value>port</value>
83 [<literal>ssl</literal>] 83 [<literal>ssl</literal>]
84 [<literal>udp</literal>] 84 [<literal>udp</literal>]
85 [<literal>proxy_protocol</literal>]
85 [<literal>backlog</literal>=<value>number</value>] 86 [<literal>backlog</literal>=<value>number</value>]
86 [<literal>bind</literal>] 87 [<literal>bind</literal>]
87 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] 88 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>]
88 [<literal>reuseport</literal>] 89 [<literal>reuseport</literal>]
89 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> 90 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
120 </para> 121 </para>
121 122
122 <para id="udp"> 123 <para id="udp">
123 The <literal>udp</literal> parameter configures a listening socket 124 The <literal>udp</literal> parameter configures a listening socket
124 for working with datagrams (1.9.13). 125 for working with datagrams (1.9.13).
126 </para>
127
128 <para id="proxy_protocol">
129 The <literal>proxy_protocol</literal> parameter (1.11.4)
130 allows specifying that all connections accepted on this port should use the
131 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
132 protocol</link>.
125 </para> 133 </para>
126 134
127 <para> 135 <para>
128 The <literal>listen</literal> directive 136 The <literal>listen</literal> directive
129 can have several additional parameters specific to socket-related system calls. 137 can have several additional parameters specific to socket-related system calls.
415 <tag-desc> 423 <tag-desc>
416 protocol used to communicate with the client: 424 protocol used to communicate with the client:
417 <literal>TCP</literal> or <literal>UDP</literal> (1.11.4) 425 <literal>TCP</literal> or <literal>UDP</literal> (1.11.4)
418 </tag-desc> 426 </tag-desc>
419 427
428 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name>
429 <tag-desc>
430 client address from the PROXY protocol header, or an empty string otherwise
431 (1.11.4)
432 <para>
433 The PROXY protocol must be previously enabled by setting the
434 <literal>proxy_protocol</literal> parameter
435 in the <link id="listen"/> directive.
436 </para>
437 </tag-desc>
438
439 <tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
440 <tag-desc>
441 client port from the PROXY protocol header, or an empty string otherwise
442 (1.11.4)
443 <para>
444 The PROXY protocol must be previously enabled by setting the
445 <literal>proxy_protocol</literal> parameter
446 in the <link id="listen"/> directive.
447 </para>
448 </tag-desc>
449
420 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name> 450 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
421 <tag-desc> 451 <tag-desc>
422 client address 452 client address
423 </tag-desc> 453 </tag-desc>
424 454