comparison xml/en/docs/http/ngx_http_core_module.xml @ 2956:a85e4d126bc7

Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 02 May 2023 11:39:21 +0100
parents 547303412ab9
children 23eedf89fd5d
comparison
equal deleted inserted replaced
2955:2c4d7151b9a9 2956:a85e4d126bc7
853 853
854 <listitem> 854 <listitem>
855 requests redirected by the 855 requests redirected by the
856 <link id="error_page"/>, 856 <link id="error_page"/>,
857 <link doc="ngx_http_index_module.xml" id="index"/>, 857 <link doc="ngx_http_index_module.xml" id="index"/>,
858 <link doc="ngx_http_internal_redirect_module.xml" id="internal_redirect"/>,
858 <link doc="ngx_http_random_index_module.xml" id="random_index"/>, and 859 <link doc="ngx_http_random_index_module.xml" id="random_index"/>, and
859 <link id="try_files"/> directives; 860 <link id="try_files"/> directives;
860 </listitem> 861 </listitem>
861 862
862 <listitem> 863 <listitem>
1268 <directive name="listen"> 1269 <directive name="listen">
1269 <syntax> 1270 <syntax>
1270 <value>address</value>[:<value>port</value>] 1271 <value>address</value>[:<value>port</value>]
1271 [<literal>default_server</literal>] 1272 [<literal>default_server</literal>]
1272 [<literal>ssl</literal>] 1273 [<literal>ssl</literal>]
1273 [<literal>http2</literal> | <literal>spdy</literal>] 1274 [<literal>http2</literal> |
1275 <literal>quic</literal> |
1276 <literal>spdy</literal>]
1274 [<literal>proxy_protocol</literal>] 1277 [<literal>proxy_protocol</literal>]
1275 [<literal>setfib</literal>=<value>number</value>] 1278 [<literal>setfib</literal>=<value>number</value>]
1276 [<literal>fastopen</literal>=<value>number</value>] 1279 [<literal>fastopen</literal>=<value>number</value>]
1277 [<literal>backlog</literal>=<value>number</value>] 1280 [<literal>backlog</literal>=<value>number</value>]
1278 [<literal>rcvbuf</literal>=<value>size</value>] 1281 [<literal>rcvbuf</literal>=<value>size</value>]
1285 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> 1288 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
1286 <syntax> 1289 <syntax>
1287 <value>port</value> 1290 <value>port</value>
1288 [<literal>default_server</literal>] 1291 [<literal>default_server</literal>]
1289 [<literal>ssl</literal>] 1292 [<literal>ssl</literal>]
1290 [<literal>http2</literal> | <literal>spdy</literal>] 1293 [<literal>http2</literal> |
1294 <literal>quic</literal> |
1295 <literal>spdy</literal>]
1291 [<literal>proxy_protocol</literal>] 1296 [<literal>proxy_protocol</literal>]
1292 [<literal>setfib</literal>=<value>number</value>] 1297 [<literal>setfib</literal>=<value>number</value>]
1293 [<literal>fastopen</literal>=<value>number</value>] 1298 [<literal>fastopen</literal>=<value>number</value>]
1294 [<literal>backlog</literal>=<value>number</value>] 1299 [<literal>backlog</literal>=<value>number</value>]
1295 [<literal>rcvbuf</literal>=<value>size</value>] 1300 [<literal>rcvbuf</literal>=<value>size</value>]
1302 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> 1307 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
1303 <syntax> 1308 <syntax>
1304 <literal>unix:</literal><value>path</value> 1309 <literal>unix:</literal><value>path</value>
1305 [<literal>default_server</literal>] 1310 [<literal>default_server</literal>]
1306 [<literal>ssl</literal>] 1311 [<literal>ssl</literal>]
1307 [<literal>http2</literal> | <literal>spdy</literal>] 1312 [<literal>http2</literal> |
1313 <literal>quic</literal> |
1314 <literal>spdy</literal>]
1308 [<literal>proxy_protocol</literal>] 1315 [<literal>proxy_protocol</literal>]
1309 [<literal>backlog</literal>=<value>number</value>] 1316 [<literal>backlog</literal>=<value>number</value>]
1310 [<literal>rcvbuf</literal>=<value>size</value>] 1317 [<literal>rcvbuf</literal>=<value>size</value>]
1311 [<literal>sndbuf</literal>=<value>size</value>] 1318 [<literal>sndbuf</literal>=<value>size</value>]
1312 [<literal>accept_filter</literal>=<value>filter</value>] 1319 [<literal>accept_filter</literal>=<value>filter</value>]
1378 The <literal>http2</literal> parameter (1.9.5) configures the port to accept 1385 The <literal>http2</literal> parameter (1.9.5) configures the port to accept
1379 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections. 1386 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections.
1380 Normally, for this to work the <literal>ssl</literal> parameter should be 1387 Normally, for this to work the <literal>ssl</literal> parameter should be
1381 specified as well, but nginx can also be configured to accept HTTP/2 1388 specified as well, but nginx can also be configured to accept HTTP/2
1382 connections without SSL. 1389 connections without SSL.
1390 </para>
1391
1392 <para id="quic">
1393 The <literal>quic</literal> parameter (1.23.4) configures the port to accept
1394 <link doc="ngx_http_v3_module.xml">QUIC</link> connections.
1383 </para> 1395 </para>
1384 1396
1385 <para> 1397 <para>
1386 The <literal>spdy</literal> parameter (1.3.15-1.9.4) allows accepting 1398 The <literal>spdy</literal> parameter (1.3.15-1.9.4) allows accepting
1387 <link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port. 1399 <link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port.
1704 configuration C, 1716 configuration C,
1705 the “<literal>/images/1.gif</literal>” request will match configuration D, and 1717 the “<literal>/images/1.gif</literal>” request will match configuration D, and
1706 the “<literal>/documents/1.jpg</literal>” request will match configuration E. 1718 the “<literal>/documents/1.jpg</literal>” request will match configuration E.
1707 </para> 1719 </para>
1708 1720
1709 <para> 1721 <para id="location_named">
1710 The “<literal>@</literal>” prefix defines a named location. 1722 The “<literal>@</literal>” prefix defines a named location.
1711 Such a location is not used for a regular request processing, but instead 1723 Such a location is not used for a regular request processing, but instead
1712 used for request redirection. 1724 used for request redirection.
1713 They cannot be nested, and cannot contain nested locations. 1725 They cannot be nested, and cannot contain nested locations.
1714 </para> 1726 </para>
3488 <tag-name id="var_server_protocol"><var>$server_protocol</var></tag-name> 3500 <tag-name id="var_server_protocol"><var>$server_protocol</var></tag-name>
3489 <tag-desc> 3501 <tag-desc>
3490 request protocol, usually 3502 request protocol, usually
3491 “<literal>HTTP/1.0</literal>”, 3503 “<literal>HTTP/1.0</literal>”,
3492 “<literal>HTTP/1.1</literal>”, 3504 “<literal>HTTP/1.1</literal>”,
3505 “<link doc="ngx_http_v2_module.xml">HTTP/2.0</link>”,
3493 or 3506 or
3494 “<link doc="ngx_http_v2_module.xml">HTTP/2.0</link>” 3507 “<link doc="ngx_http_v3_module.xml">HTTP/3.0</link>”
3495 </tag-desc> 3508 </tag-desc>
3496 3509
3497 <tag-name id="var_status"><var>$status</var></tag-name> 3510 <tag-name id="var_status"><var>$status</var></tag-name>
3498 <tag-desc> 3511 <tag-desc>
3499 response status (1.3.2, 1.2.2) 3512 response status (1.3.2, 1.2.2)