Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_core_module.xml @ 1097:eeb690d4212b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the PROXY protocol support.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 18 Mar 2014 19:59:24 +0400
parents 3fde5aa256ac
children ebe027a963f4
comparison
equal deleted inserted replaced
1096:f34be6b26447 1097:eeb690d4212b
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_core_module" 10 <module name="Module ngx_http_core_module"
11 link="/en/docs/http/ngx_http_core_module.html" 11 link="/en/docs/http/ngx_http_core_module.html"
12 lang="en" 12 lang="en"
13 rev="29"> 13 rev="30">
14 14
15 <section id="directives" name="Directives"> 15 <section id="directives" name="Directives">
16 16
17 <directive name="aio"> 17 <directive name="aio">
18 <syntax> 18 <syntax>
1096 <syntax> 1096 <syntax>
1097 <value>address</value>[:<value>port</value>] 1097 <value>address</value>[:<value>port</value>]
1098 [<literal>default_server</literal>] 1098 [<literal>default_server</literal>]
1099 [<literal>ssl</literal>] 1099 [<literal>ssl</literal>]
1100 [<literal>spdy</literal>] 1100 [<literal>spdy</literal>]
1101 [<literal>proxy_protocol</literal>]
1101 [<literal>setfib</literal>=<value>number</value>] 1102 [<literal>setfib</literal>=<value>number</value>]
1102 [<literal>fastopen</literal>=<value>number</value>] 1103 [<literal>fastopen</literal>=<value>number</value>]
1103 [<literal>backlog</literal>=<value>number</value>] 1104 [<literal>backlog</literal>=<value>number</value>]
1104 [<literal>rcvbuf</literal>=<value>size</value>] 1105 [<literal>rcvbuf</literal>=<value>size</value>]
1105 [<literal>sndbuf</literal>=<value>size</value>] 1106 [<literal>sndbuf</literal>=<value>size</value>]
1111 <syntax> 1112 <syntax>
1112 <value>port</value> 1113 <value>port</value>
1113 [<literal>default_server</literal>] 1114 [<literal>default_server</literal>]
1114 [<literal>ssl</literal>] 1115 [<literal>ssl</literal>]
1115 [<literal>spdy</literal>] 1116 [<literal>spdy</literal>]
1117 [<literal>proxy_protocol</literal>]
1116 [<literal>setfib</literal>=<value>number</value>] 1118 [<literal>setfib</literal>=<value>number</value>]
1117 [<literal>fastopen</literal>=<value>number</value>] 1119 [<literal>fastopen</literal>=<value>number</value>]
1118 [<literal>backlog</literal>=<value>number</value>] 1120 [<literal>backlog</literal>=<value>number</value>]
1119 [<literal>rcvbuf</literal>=<value>size</value>] 1121 [<literal>rcvbuf</literal>=<value>size</value>]
1120 [<literal>sndbuf</literal>=<value>size</value>] 1122 [<literal>sndbuf</literal>=<value>size</value>]
1126 <syntax> 1128 <syntax>
1127 <literal>unix:</literal><value>path</value> 1129 <literal>unix:</literal><value>path</value>
1128 [<literal>default_server</literal>] 1130 [<literal>default_server</literal>]
1129 [<literal>ssl</literal>] 1131 [<literal>ssl</literal>]
1130 [<literal>spdy</literal>] 1132 [<literal>spdy</literal>]
1133 [<literal>proxy_protocol</literal>]
1131 [<literal>backlog</literal>=<value>number</value>] 1134 [<literal>backlog</literal>=<value>number</value>]
1132 [<literal>rcvbuf</literal>=<value>size</value>] 1135 [<literal>rcvbuf</literal>=<value>size</value>]
1133 [<literal>sndbuf</literal>=<value>size</value>] 1136 [<literal>sndbuf</literal>=<value>size</value>]
1134 [<literal>accept_filter</literal>=<value>filter</value>] 1137 [<literal>accept_filter</literal>=<value>filter</value>]
1135 [<literal>deferred</literal>] 1138 [<literal>deferred</literal>]
1200 The <literal>spdy</literal> parameter (1.3.15) allows accepting 1203 The <literal>spdy</literal> parameter (1.3.15) allows accepting
1201 <link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port. 1204 <link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port.
1202 Normally, for this to work the <literal>ssl</literal> parameter should be 1205 Normally, for this to work the <literal>ssl</literal> parameter should be
1203 specified as well, but nginx can also be configured to accept SPDY 1206 specified as well, but nginx can also be configured to accept SPDY
1204 connections without SSL. 1207 connections without SSL.
1208 </para>
1209
1210 <para>
1211 The <literal>proxy_protocol</literal> parameter (1.5.12)
1212 allows specifying that all connections accepted on this port should use the
1213 <link url="http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt">PROXY
1214 protocol</link>.
1205 </para> 1215 </para>
1206 1216
1207 <para> 1217 <para>
1208 A <literal>listen</literal> directive 1218 A <literal>listen</literal> directive
1209 can have several additional parameters specific to socket-related system calls. 1219 can have several additional parameters specific to socket-related system calls.
2885 <tag-desc> 2895 <tag-desc>
2886 “<literal>p</literal>” if request was pipelined, “<literal>.</literal>” 2896 “<literal>p</literal>” if request was pipelined, “<literal>.</literal>”
2887 otherwise (1.3.12, 1.2.7) 2897 otherwise (1.3.12, 1.2.7)
2888 </tag-desc> 2898 </tag-desc>
2889 2899
2900 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name>
2901 <tag-desc>
2902 client address from the PROXY protocol header, or an empty string otherwise
2903 (1.5.12)
2904 <para>
2905 The PROXY protocol must be previously enabled by setting the
2906 <literal>proxy_protocol</literal> parameter
2907 in the <link id="listen"/> directive.
2908 </para>
2909 </tag-desc>
2910
2890 <tag-name id="var_query_string"><var>$query_string</var></tag-name> 2911 <tag-name id="var_query_string"><var>$query_string</var></tag-name>
2891 <tag-desc> 2912 <tag-desc>
2892 same as <var>$args</var> 2913 same as <var>$args</var>
2893 </tag-desc> 2914 </tag-desc>
2894 2915