nginx-site: xml/en/docs/http/ngx_http_core

annotate xml/en/docs/http/ngx_http_core_module.xml @ 2457:3896055c397e

Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 31 Oct 2019 15:35:51 +0300
parents	4487310de7e7
children	9cd5883ac546

rev	line source
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	3 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	6 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	7
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9
89 f451dc5c5c82 Module names corrected. Ruslan Ermilov <ru@nginx.com> parents: 88 diff changeset	10 <module name="Module ngx_http_core_module"
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 link="/en/docs/http/ngx_http_core_module.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 587 diff changeset	12 lang="en"
2457 3896055c397e Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	13 rev="88">
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="directives" name="Directives">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
1879 3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	17 <directive name="absolute_redirect">
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	18 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	19 <default>on</default>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	20 <context>http</context>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	21 <context>server</context>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	22 <context>location</context>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	23 <appeared-in>1.11.8</appeared-in>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	24
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	25 <para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	26 If disabled, redirects issued by nginx will be relative.
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	27 </para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	28
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	29 <para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	30 See also <link id="server_name_in_redirect"/>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	31 and <link id="port_in_redirect"/> directives.
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	32 </para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	33
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	34 </directive>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	35
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	36
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	37 <directive name="aio">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	38 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	39 <literal>on</literal> \|
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	40 <literal>off</literal> \|
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	41 <literal>threads</literal>[<literal>=</literal><value>pool</value>]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	42 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	46 <appeared-in>0.8.11</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 Enables or disables the use of asynchronous file I/O (AIO)
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	50 on FreeBSD and Linux:
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	51 <example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	52 location /video/ {
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	53 aio on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	54 output_buffers 1 64k;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	55 }
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	56 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	60 On FreeBSD, AIO can be used starting from FreeBSD 4.3.
1859 5cd4964fbc5f Updated AIO description for FreeBSD 11.0 and upwards. Sergey Kandaurov <pluknet@nginx.com> parents: 1827 diff changeset	61 Prior to FreeBSD 11.0,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 AIO can either be linked statically into a kernel:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 options VFS_AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 or loaded dynamically as a kernel loadable module:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 kldload aio
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	72 <!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 In FreeBSD versions 5 and 6, enabling AIO statically, or dynamically
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 when booting the kernel, will cause the entire networking subsystem
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	76 to use the Giant lock, which can impact overall performance negatively.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 This limitation has been removed in FreeBSD 6.4-STABLE in 2009, and in
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 FreeBSD 7.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 However, starting from FreeBSD 5.3 it is possible to enable AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 without the penalty of running the networking subsystem under a
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 Giant lock—for this to work, the AIO module needs to be loaded
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 after the kernel has booted.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 In this case, the following message will appear in
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	84 <path>/var/log/messages</path>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 WARNING: Network stack Giant-free, but aio requires Giant.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 Consider adding 'options NET_WITH_GIANT' or setting debug.mpsafenet=0
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 and can safely be ignored.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 <note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 The requirement to use the Giant lock with AIO is related to the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 fact that FreeBSD supports asynchronous calls
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 <c-func>aio_read</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 <c-func>aio_write</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 when working with sockets.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	97 However, since nginx uses AIO only for disk I/O, no problems should arise.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 </note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 </para>
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	100 -->
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	103 On Linux, AIO can be used starting from kernel version 2.6.22.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	104 Also, it is necessary to enable
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	105 <link id="directio"/>,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	106 or otherwise reading will be blocking:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 directio 512;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 output_buffers 1 128k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 On Linux,
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	118 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 can only be used for reading blocks that are aligned on 512-byte
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 boundaries (or 4K for XFS).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	121 File’s unaligned end is read in blocking mode.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	122 The same holds true for byte range requests and for FLV requests
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 not from the beginning of a file: reading of unaligned data at the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 beginning and end of a file will be blocking.
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	125 </para>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	126
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	127 <para>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	128 When both AIO and <link id="sendfile"/> are enabled on Linux,
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	129 AIO is used for files that are larger than or equal to
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	130 the size specified in the <link id="directio"/> directive,
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	131 while <link id="sendfile"/> is used for files of smaller sizes
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	132 or when <link id="directio"/> is disabled.
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	133 <example>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	134 location /video/ {
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	135 sendfile on;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	136 aio on;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	137 directio 8m;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	138 }
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	139 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	142 <para>
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	143 Finally, files can be read and <link id="sendfile">sent</link>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	144 using multi-threading (1.7.11),
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	145 without blocking a worker process:
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	146 <example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	147 location /video/ {
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	148 sendfile on;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	149 aio threads;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	150 }
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	151 </example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	152 Read and send file operations are offloaded to threads of the specified
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	153 <link doc="../ngx_core_module.xml" id="thread_pool">pool</link>.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	154 If the pool name is omitted,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	155 the pool with the name “<literal>default</literal>” is used.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	156 The pool name can also be set with variables:
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	157 <example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	158 aio threads=pool$disk;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	159 </example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	160 By default, multi-threading is disabled, it should be
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	161 enabled with the
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	162 <literal>--with-threads</literal> configuration parameter.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	163 Currently, multi-threading is compatible only with the
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	164 <link doc="../events.xml" id="epoll"/>,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	165 <link doc="../events.xml" id="kqueue"/>,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	166 and
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	167 <link doc="../events.xml" id="eventport"/> methods.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	168 Multi-threaded sending of files is only supported on Linux.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	169 </para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	170
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	171 <para>
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	172 See also the <link id="sendfile"/> directive.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	173 </para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	174
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177
1664 1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	178 <directive name="aio_write">
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	179 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	180 <default>off</default>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	181 <context>http</context>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	182 <context>server</context>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	183 <context>location</context>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	184 <appeared-in>1.9.13</appeared-in>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	185
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	186 <para>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	187 If <link id="aio"/> is enabled, specifies whether it is used for writing files.
1665 57b53a0818df Slightly paraphrased aio_write description for better perception. Ruslan Ermilov <ru@nginx.com> parents: 1664 diff changeset	188 Currently, this only works when using
1664 1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	189 <literal>aio threads</literal>
1665 57b53a0818df Slightly paraphrased aio_write description for better perception. Ruslan Ermilov <ru@nginx.com> parents: 1664 diff changeset	190 and is limited to writing temporary files
57b53a0818df Slightly paraphrased aio_write description for better perception. Ruslan Ermilov <ru@nginx.com> parents: 1664 diff changeset	191 with data received from proxied servers.
1664 1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	192 </para>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	193
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	194 </directive>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	195
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	196
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 <directive name="alias">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	198 <syntax><value>path</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 Defines a replacement for the specified location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	210 on request of
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	211 “<literal>/i/top.gif</literal>”, the file
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	212 <path>/data/w3/images/top.gif</path> will be sent.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	216 The <value>path</value> value can contain variables,
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	217 except <var>$document_root</var> and <var>$realpath_root</var>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	221 If <literal>alias</literal> is used inside a location defined
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 with a regular expression then such regular expression should
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	223 contain captures and <literal>alias</literal> should refer to
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 these captures (0.7.40), for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 location ~ ^/users/(.+\.(?:gif\|jpe?g\|png))$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 alias /data/w3/images/$1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 <para>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	233 When location matches the last part of the directive’s value:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 it is better to use the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	240 <link id="root"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 directive instead:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	252 <directive name="chunked_transfer_encoding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	253 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	254 <default>on</default>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	255 <context>http</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	256 <context>server</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	257 <context>location</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	258
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	259 <para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	260 Allows disabling chunked transfer encoding in HTTP/1.1.
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	261 It may come in handy when using a software failing to support
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	262 chunked encoding despite the standard’s requirement.
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	263 </para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	264
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	265 </directive>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	266
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	267
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	268 <directive name="client_body_buffer_size">
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	269
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	270 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	271 <default>8k\|16k</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	272 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	273 <context>server</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	274 <context>location</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	275
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	276 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	277 Sets buffer size for reading client request body.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	278 In case the request body is larger than the buffer,
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	279 the whole body or only its part is written to a
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	280 <link id="client_body_temp_path">temporary file</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	281 By default, buffer size is equal to two memory pages.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	282 This is 8K on x86, other 32-bit platforms, and x86-64.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	283 It is usually 16K on other 64-bit platforms.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	284 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	285
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	286 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	287
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	288
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 <directive name="client_body_in_file_only">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	290 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	291 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	292 <literal>clean</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	293 <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	294 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 Determines whether nginx should save the entire client request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 into a file.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302 This directive can be used during debugging, or when using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 <var>$request_body_file</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 variable, or the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 <link doc="ngx_http_perl_module.xml" id="methods">$r->request_body_file</link>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 method of the module
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <link doc="ngx_http_perl_module.xml">ngx_http_perl_module</link>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	311 When set to the value <literal>on</literal>, temporary files are not
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 removed after request processing.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	316 The value <literal>clean</literal> will cause the temporary files
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 left after request processing to be removed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 <directive name="client_body_in_single_buffer">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	324 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	325 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 Determines whether nginx should save the entire client request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 in a single buffer.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 The directive is recommended when using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 <var>$request_body</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 variable, to save the number of copy operations involved.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	337
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 <directive name="client_body_temp_path">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	342 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	343 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	344 [<value>level1</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	345 [<value>level2</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	346 [<value>level3</value>]]]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	347 <default>client_body_temp</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 Defines a directory for storing temporary files holding client request bodies.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	354 Up to three-level subdirectory hierarchy can be used under the specified
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 directory.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356 For example, in the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 client_body_temp_path /spool/nginx/client_temp 1 2;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	360 a path to a temporary file might look like this:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 /spool/nginx/client_temp/7/45/00000123457
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 <directive name="client_body_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	370 <syntax><value>time</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	371 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 Defines a timeout for reading client request body.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	378 The timeout is set only for a period between two successive read operations,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 not for the transmission of the whole request body.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	380 If a client does not transmit anything within this time, the
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	381 request is terminated with the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 <http-status code="408" text="Request Time-out"/>
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	383 error.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	388
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	389 <directive name="client_header_buffer_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	390 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	391 <default>1k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	395 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396 Sets buffer size for reading client request header.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397 For most requests, a buffer of 1K bytes is enough.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	398 However, if a request includes long cookies, or comes from a WAP client,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399 it may not fit into 1K.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	400 If a request line or a request header field does not fit into
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	401 this buffer then larger buffers, configured by the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	402 <link id="large_client_header_buffers"/> directive,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	403 are allocated.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	409 <directive name="client_header_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	410 <syntax><value>time</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	411 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 Defines a timeout for reading client request header.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	417 If a client does not transmit the entire header within this time, the
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	418 request is terminated with the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 <http-status code="408" text="Request Time-out"/>
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	420 error.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	421 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 <directive name="client_max_body_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	427 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	428 <default>1m</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	429 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	434 Sets the maximum allowed size of the client request body,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 specified in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 <header>Content-Length</header>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	437 request header field.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	438 If the size in a request exceeds the configured value, the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 <http-status code="413" text="Request Entity Too Large"/>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	440 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 Please be aware that
237 48a5c2083270 For now, commented out broken link to /web/upload.html. Ruslan Ermilov <ru@nginx.com> parents: 236 diff changeset	442 <!--link doc="/web/upload.xml"-->browsers cannot correctly display
48a5c2083270 For now, commented out broken link to /web/upload.html. Ruslan Ermilov <ru@nginx.com> parents: 236 diff changeset	443 this error<!--/link-->.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	444 Setting <value>size</value> to 0 disables checking of client
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	445 request body size.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	446 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	449
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	451 <directive name="connection_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	452 <syntax><value>size</value></syntax>
1619 88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	453 <default>256\|512</default>
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	454 <context>http</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	455 <context>server</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	456
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	457 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	458 Allows accurate tuning of per-connection memory allocations.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	459 This directive has minimal impact on performance
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	460 and should not generally be used.
1619 88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	461 By default, the size is equal to
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	462 256 bytes on 32-bit platforms and 512 bytes on 64-bit platforms.
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	463 <note>
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	464 Prior to version 1.9.8, the default value was 256 on all platforms.
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	465 </note>
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	466 </para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	467
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	468 </directive>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	469
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	470
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 <directive name="default_type">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	472 <syntax><value>mime-type</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	473 <default>text/plain</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	474 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	479 Defines the default MIME type of a response.
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	480 Mapping of file name extensions to MIME types can be set
77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	481 with the <link id="types"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	482 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	487 <directive name="directio">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	488 <syntax><value>size</value> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	489 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	490 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	491 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	492 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	493 <appeared-in>0.7.7</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	495 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	496 Enables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 the <c-def>O_DIRECT</c-def> flag (FreeBSD, Linux),
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	498 the <c-def>F_NOCACHE</c-def> flag (macOS),
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	499 or the <c-func>directio</c-func> function (Solaris),
236 9ba4f5333a56 Fixed off-by-one error introduced during an initial translation into English. Ruslan Ermilov <ru@nginx.com> parents: 235 diff changeset	500 when reading files that are larger than or equal to
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	501 the specified <value>size</value>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	502 The directive automatically disables (0.7.15) the use of
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	503 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	504 for a given request.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	505 It can be useful for serving large files:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	506 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	507 directio 4m;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	508 </example>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	509 or when using <link id="aio"/> on Linux.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	510 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	511
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	512 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	513
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	515 <directive name="directio_alignment">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	516 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	517 <default>512</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	518 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	520 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	521 <appeared-in>0.8.11</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	522
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	523 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	524 Sets the alignment for
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	525 <link id="directio"/>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	526 In most cases, a 512-byte alignment is enough.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	527 However, when using XFS under Linux, it needs to be increased to 4K.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	528 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	529
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	530 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	531
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	532
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	533 <directive name="disable_symlinks">
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	534 <syntax><literal>off</literal></syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	535 <syntax>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	536 <literal>on</literal> \|
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	537 <literal>if_not_owner</literal>
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	538 [<literal>from</literal>=<value>part</value>]</syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	539 <default>off</default>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	540 <context>http</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	541 <context>server</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	542 <context>location</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	543 <appeared-in>1.1.15</appeared-in>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	544
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	545 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	546 Determines how symbolic links should be treated when opening files:
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	547 <list type="tag">
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	548
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	549 <tag-name><literal>off</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	550 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	551 Symbolic links in the pathname are allowed and not checked.
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	552 This is the default behavior.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	553 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	554
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	555 <tag-name><literal>on</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	556 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	557 If any component of the pathname is a symbolic link,
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	558 access to a file is denied.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	559 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	560
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	561 <tag-name><literal>if_not_owner</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	562 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	563 Access to a file is denied if any component of the pathname
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	564 is a symbolic link, and the link and object that the link
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	565 points to have different owners.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	566 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	567
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	568 <tag-name><literal>from</literal>=<value>part</value></tag-name>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	569 <tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	570 When checking symbolic links
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	571 (parameters <literal>on</literal> and <literal>if_not_owner</literal>),
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	572 all components of the pathname are normally checked.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	573 Checking of symbolic links in the initial part of the pathname
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	574 may be avoided by specifying additionally the
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	575 <literal>from</literal>=<value>part</value> parameter.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	576 In this case, symbolic links are checked only from
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	577 the pathname component that follows the specified initial part.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	578 If the value is not an initial part of the pathname checked, the whole
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	579 pathname is checked as if this parameter was not specified at all.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	580 If the value matches the whole file name,
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	581 symbolic links are not checked.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	582 The parameter value can contain variables.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	583 </tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	584
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	585 </list>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	586 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	587
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	588 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	589 Example:
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	590 <example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	591 disable_symlinks on from=$document_root;
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	592 </example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	593 </para>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	594
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	595 <para>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	596 This directive is only available on systems that have the
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	597 <c-func>openat</c-func> and <c-func>fstatat</c-func> interfaces.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	598 Such systems include modern versions of FreeBSD, Linux, and Solaris.
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	599 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	600
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	601 <para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	602 Parameters <literal>on</literal> and <literal>if_not_owner</literal>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	603 add a processing overhead.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	604 <note>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	605 On systems that do not support opening of directories only for search,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	606 to use these parameters it is required that worker processes
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	607 have read permissions for all directories being checked.
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	608 </note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	609 </para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	610
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	611 <para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	612 <note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	613 The
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	614 <link doc="ngx_http_autoindex_module.xml">ngx_http_autoindex_module</link>,
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	615 <link doc="ngx_http_random_index_module.xml">ngx_http_random_index_module</link>,
477 c5680571ec09 Unnecessary extensions removed from links. Andrey Belov <defan@nginx.com> parents: 476 diff changeset	616 and <link doc="ngx_http_dav_module.xml">ngx_http_dav_module</link>
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	617 modules currently ignore this directive.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	618 </note>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	619 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	620
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	621 </directive>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	622
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	623
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	624 <directive name="error_page">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	625 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	626 <value>code</value> ...
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	627 [<literal>=</literal>[<value>response</value>]]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	628 <value>uri</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	629 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	630 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	631 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	632 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	633 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	634
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	635 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	636 Defines the URI that will be shown for the specified errors.
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	637 A <value>uri</value> value can contain variables.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	638 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	639
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	640 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	641 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	642 <example>
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	643 error_page 404 /404.html;
1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	644 error_page 500 502 503 504 /50x.html;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	645 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	646 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	647
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	648 <para>
1827 64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	649 This causes an internal redirect to the specified <value>uri</value>
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	650 with the client request method changed to “<literal>GET</literal>”
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	651 (for all methods other than
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	652 “<literal>GET</literal>” and “<literal>HEAD</literal>”).
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	653 </para>
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	654
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	655 <para>
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	656 Furthermore, it is possible to change the response code to another
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	657 using the “<literal>=</literal><value>response</value>” syntax, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	658 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	659 error_page 404 =200 /empty.gif;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	660 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	661 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	662
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	663 <para>
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	664 If an error response is processed by a proxied server
2134 4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	665 or a FastCGI/uwsgi/SCGI/gRPC server,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	666 and the server may return different response codes (e.g., 200, 302, 401
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	667 or 404), it is possible to respond with the code it returns:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	668 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	669 error_page 404 = /404.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	670 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	671 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	672
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	673 <para>
1827 64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	674 If there is no need to change URI and method during internal redirection
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	675 it is possible to pass error processing into a named location:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	676 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	677 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678 error_page 404 = @fallback;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	679 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	680
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	681 location @fallback {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	682 proxy_pass http://backend;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	685 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	686
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	687 <para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	688 <note>
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	689 If <value>uri</value> processing leads to an error,
747 ddec437b692b Fixed a number of typos. Vladimir Homutov <vl@nginx.com> parents: 741 diff changeset	690 the status code of the last occurred error is returned to the client.
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	691 </note>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	692 </para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	693
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	694 <para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	695 It is also possible to use URL redirects for error processing:
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	696 <example>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	697 error_page 403 http://example.com/forbidden.html;
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	698 error_page 404 =301 http://example.com/notfound.html;
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	699 </example>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	700 In this case, by default, the response code 302 is returned to the client.
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	701 It can only be changed to one of the redirect status
1964 2a3c58dcb3e8 Documented support for the 308 Permanent Redirect. Yaroslav Zhuravlev <yar@nginx.com> parents: 1953 diff changeset	702 codes (301, 302, 303, 307, and 308).
2039 d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	703 <note>
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	704 The code 307 was not treated as a redirect until versions 1.1.16 and 1.0.13.
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	705 </note>
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	706
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	707 <note>
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	708 The code 308 was not treated as a redirect until version 1.13.0.
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	709 </note>
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	710 </para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	711
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	712 <para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	713 These directives are inherited from the previous level if and
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	714 only if there are no
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	715 <literal>error_page</literal>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	716 directives defined on the current level.
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	717 </para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	718
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	720
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	721
576 cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	722 <directive name="etag">
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	723 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	724 <default>on</default>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	725 <context>http</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	726 <context>server</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	727 <context>location</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	728 <appeared-in>1.3.3</appeared-in>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	729
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	730 <para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	731 Enables or disables automatic generation of the <header>ETag</header>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	732 response header field for static resources.
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	733 </para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	734
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	735 </directive>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	736
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	737
651 eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	738 <directive name="http">
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	739 <syntax block="yes"/>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	740 <default/>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	741 <context>main</context>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	742
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	743 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	744 Provides the configuration file context in which the HTTP server directives
651 eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	745 are specified.
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	746 </para>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	747
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	748 </directive>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	749
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	750
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	751 <directive name="if_modified_since">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	752 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	753 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	754 <literal>exact</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	755 <literal>before</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	756 <default>exact</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	757 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	758 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	760 <appeared-in>0.7.24</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	761
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	763 Specifies how to compare modification time of a response
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764 with the time in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765 <header>If-Modified-Since</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	766 request header field:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	767
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	768 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	769
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	770 <tag-name><literal>off</literal></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	771 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	772 the
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	773 <header>If-Modified-Since</header> request header field is ignored (0.7.34);
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	774 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	775
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	776 <tag-name><literal>exact</literal></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	777 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	778 exact match;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	779 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	781 <tag-name><literal>before</literal></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	782 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	783 modification time of a response is
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	784 less than or equal to the time in the <header>If-Modified-Since</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	785 request header field.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	786 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	787
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	788 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	791 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	792
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	793
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	794 <directive name="ignore_invalid_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	795 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	796 <default>on</default>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	797 <context>http</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	798 <context>server</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	799
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	800 <para>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	801 Controls whether header fields with invalid names should be ignored.
252 6f710464be38 Applied nitpicking by Maxim Dounin, translated into English. Ruslan Ermilov <ru@nginx.com> parents: 246 diff changeset	802 Valid names are composed of English letters, digits, hyphens, and possibly
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	803 underscores (as controlled by the <link id="underscores_in_headers"/>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	804 directive).
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	805 </para>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	806
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	807 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	808 If the directive is specified on the <link id="server"/> level,
375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	809 its value is only used if a server is a default one.
375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	810 The value specified also applies to all virtual servers
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	811 listening on the same address and port.
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	812 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	813
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	814 </directive>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	815
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	816
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	817 <directive name="internal">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	818 <syntax/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	821
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	823 Specifies that a given location can only be used for internal requests.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	824 For external requests, the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	825 <http-status code="404" text="Not Found"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	826 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	827 Internal requests are the following:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	828
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	830
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	831 <listitem>
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	832 requests redirected by the
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	833 <link id="error_page"/>,
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	834 <link doc="ngx_http_index_module.xml" id="index"/>,
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	835 <link doc="ngx_http_random_index_module.xml" id="random_index"/>, and
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	836 <link id="try_files"/> directives;
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	837 </listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	838
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	839 <listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	840 requests redirected by the <header>X-Accel-Redirect</header>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	841 response header field from an upstream server;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	842 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	843
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	844 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	845 subrequests formed by the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	846 “<command>include virtual</command>”
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	847 command of the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	848 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>
2036 ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	849 module, by the
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	850 <link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link>
2036 ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	851 module directives, and by
ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	852 <link doc="ngx_http_auth_request_module.xml" id="auth_request"/> and
ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	853 <link doc="ngx_http_mirror_module.xml" id="mirror"/> directives;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	854 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	857 requests changed by the
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	858 <link doc="ngx_http_rewrite_module.xml" id="rewrite"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	859 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	860
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	861 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	863
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	864 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	867 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	868
2206 5cacd6fffade Eliminated some examples of unsafe prefix locations. Ruslan Ermilov <ru@nginx.com> parents: 2199 diff changeset	869 location = /404.html {
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	870 internal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	872 </example>
674 c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	873 <note>
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	874 There is a limit of 10 internal redirects per request to prevent
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	875 request processing cycles that can occur in incorrect configurations.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	876 If this limit is reached, the error
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	877 <http-status code="500" text="Internal Server Error"/> is returned.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	878 In such cases, the “rewrite or internal redirection cycle” message
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	879 can be seen in the error log.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	880 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	881 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	882
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	883 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	884
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	885
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	886 <directive name="keepalive_disable">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	887 <syntax><literal>none</literal> \| <value>browser</value> ...</syntax>
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	888 <default>msie6</default>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	889 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	890 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	891 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	892
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	893 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	894 Disables keep-alive connections with misbehaving browsers.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	895 The <value>browser</value> parameters specify which
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	896 browsers will be affected.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	897 The value <literal>msie6</literal> disables keep-alive connections
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	898 with old versions of MSIE, once a POST request is received.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	899 The value <literal>safari</literal> disables keep-alive connections
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	900 with Safari and Safari-like browsers on macOS and macOS-like
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	901 operating systems.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	902 The value <literal>none</literal> enables keep-alive connections
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	903 with all browsers.
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	904 <note>
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	905 Prior to version 1.1.18, the value <literal>safari</literal> matched
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	906 all Safari and Safari-like browsers on all operating systems, and
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	907 keep-alive connections with them were disabled by default.
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	908 </note>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	909 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	910
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	911 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	912
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	913
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	914 <directive name="keepalive_requests">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	915 <syntax><value>number</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	916 <default>100</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	918 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	919 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	920 <appeared-in>0.8.0</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	921
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	922 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	923 Sets the maximum number of requests that can be
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	924 served through one keep-alive connection.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	925 After the maximum number of requests are made, the connection is closed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	926 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	927
2450 a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	928 <para>
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	929 Closing connections periodically is necessary to free
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	930 per-connection memory allocations.
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	931 Therefore, using too high maximum number of requests
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	932 could result in excessive memory usage and not recommended.
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	933 </para>
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	934
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	935 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	936
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938 <directive name="keepalive_timeout">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	939 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	940 <value>timeout</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	941 [<value>header_timeout</value>]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	942 <default>75s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	943 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	944 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	945 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	946
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	947 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	948 The first parameter sets a timeout during which a keep-alive
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	949 client connection will stay open on the server side.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	950 The zero value disables keep-alive client connections.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	951 The optional second parameter sets a value in the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	952 <header>Keep-Alive: timeout=<value>time</value></header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	953 response header field.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	954 Two parameters may differ.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	955 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	956
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	957 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958 The
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	959 <header>Keep-Alive: timeout=<value>time</value></header>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	960 header field is recognized by Mozilla and Konqueror.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	961 MSIE closes keep-alive connections by itself in about 60 seconds.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	962 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	963
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	964 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	966
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 <directive name="large_client_header_buffers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	968 <syntax><value>number</value> <value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	969 <default>4 8k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	971 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	972
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	973 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	974 Sets the maximum <value>number</value> and <value>size</value> of
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	975 buffers used for reading large client request header.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	976 A request line cannot exceed the size of one buffer, or the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	977 <http-status code="414" text="Request-URI Too Large"/>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	978 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 A request header field cannot exceed the size of one buffer as well, or the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 <http-status code="400" text="Bad Request"/>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	981 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982 Buffers are allocated only on demand.
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	983 By default, the buffer size is equal to 8K bytes.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 If after the end of request processing a connection is transitioned
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	985 into the keep-alive state, these buffers are released.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	987
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	989
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	990
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	991 <directive name="limit_except">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	992 <syntax block="yes"><value>method</value> ...</syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	993 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	994 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997 Limits allowed HTTP methods inside a location.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	998 The <value>method</value> parameter can be one of the following:
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	999 <literal>GET</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1000 <literal>HEAD</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1001 <literal>POST</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1002 <literal>PUT</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1003 <literal>DELETE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1004 <literal>MKCOL</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1005 <literal>COPY</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1006 <literal>MOVE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1007 <literal>OPTIONS</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1008 <literal>PROPFIND</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1009 <literal>PROPPATCH</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1010 <literal>LOCK</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1011 <literal>UNLOCK</literal>,
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	1012 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1013 <literal>PATCH</literal>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1014 Allowing the <literal>GET</literal> method makes the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1015 <literal>HEAD</literal> method also allowed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1016 Access to other methods can be limited using the
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2134 diff changeset	1017 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2134 diff changeset	1018 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1019 and
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2134 diff changeset	1020 <link doc="ngx_http_auth_jwt_module.xml">ngx_http_auth_jwt_module</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2134 diff changeset	1021 (1.13.10)
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1022 modules directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1023 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1024 limit_except GET {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1025 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1026 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1027 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1028 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1029 Please note that this will limit access to all methods
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1030 <emphasis>except</emphasis> GET and HEAD.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1031 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1032
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1033 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1034
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1035
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1036 <directive name="limit_rate">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1037 <syntax><value>rate</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1038 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1039 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1040 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1041 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1042 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1043
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1044 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1045 Limits the rate of response transmission to a client.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1046 The <value>rate</value> is specified in bytes per second.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1047 The zero value disables rate limiting.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1048 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1049 The smaller the rate, the more accurate will be the limitation.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1050 -->
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1051 The limit is set per a request, and so if a client simultaneously opens
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1052 two connections, the overall rate will be twice as much
767 1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	1053 as the specified limit.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1054 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1055
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1056 <para>
2391 375a3dfde23b Unified phrase "Parameter value can contain variables". Yaroslav Zhuravlev <yar@nginx.com> parents: 2390 diff changeset	1057 Parameter value can contain variables (1.17.0).
767 1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	1058 It may be useful in cases where rate should be limited
1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	1059 depending on a certain condition:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1060 <example>
2384 144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1061 map $slow $rate {
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1062 1 4k;
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1063 2 8k;
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1064 }
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1065
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1066 limit_rate $rate;
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1067 </example>
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1068 </para>
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1069
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1070 <para>
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1071 Rate limit can also be set in the
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1072 <link id="var_limit_rate"><var>$limit_rate</var></link> variable,
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1073 however, since version 1.17.0, this method is not recommended:
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1074 <example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1075 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1076
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1077 if ($slow) {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078 set $limit_rate 4k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1079 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1086 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1087 Rate limit can also be set in the
767 1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	1088 <header>X-Accel-Limit-Rate</header> header field of a proxied server response.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1089 This capability can be disabled using the
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1090 <link doc="ngx_http_proxy_module.xml" id="proxy_ignore_headers"/>,
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1091 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_ignore_headers"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1092 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_ignore_headers"/>,
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1093 and
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1094 <link doc="ngx_http_scgi_module.xml" id="scgi_ignore_headers"/>
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1095 directives.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1096 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1097
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1098 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	1101 <directive name="limit_rate_after">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1102 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1103 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1104 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1105 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1106 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1107 <context>if in location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	1108 <appeared-in>0.8.0</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1109
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1110 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1111 Sets the initial amount after which the further transmission
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112 of a response to a client will be rate limited.
2391 375a3dfde23b Unified phrase "Parameter value can contain variables". Yaroslav Zhuravlev <yar@nginx.com> parents: 2390 diff changeset	1113 Parameter value can contain variables (1.17.0).
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1114 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1115
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1118 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1119 location /flv/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1120 flv;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1121 limit_rate_after 500k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1122 limit_rate 50k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1123 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1124 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1125 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1126
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1127 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1130 <directive name="lingering_close">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1131 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1132 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1133 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1134 <literal>always</literal></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1135 <default>on</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1136 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1137 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1138 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1139 <appeared-in>1.1.0</appeared-in>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1140 <appeared-in>1.0.6</appeared-in>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1141
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1142 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1143 Controls how nginx closes client connections.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1144 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1145
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1146 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1147 The default value “<literal>on</literal>” instructs nginx to
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1148 <link id="lingering_timeout">wait for</link> and
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1149 <link id="lingering_time">process</link> additional data from a client
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1150 before fully closing a connection, but only
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1151 if heuristics suggests that a client may be sending more data.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1152 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1153
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1154 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1155 The value “<literal>always</literal>” will cause nginx to unconditionally
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1156 wait for and process additional client data.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1157 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1158
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1159 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1160 The value “<literal>off</literal>” tells nginx to never wait for
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1161 more data and close the connection immediately.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1162 This behavior breaks the protocol and should not be used under normal
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1163 circumstances.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1164 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1165
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1166 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1167
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1168
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1169 <directive name="lingering_time">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1170 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1171 <default>30s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1172 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1173 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1174 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1175
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1176 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1177 When <link id="lingering_close"/> is in effect,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1178 this directive specifies the maximum time during which nginx
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1179 will process (read and ignore) additional data coming from a client.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1180 After that, the connection will be closed, even if there will be
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1181 more data.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1182 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1183
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1184 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1185
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1186
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1187 <directive name="lingering_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1188 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1189 <default>5s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1190 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1191 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1192 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1193
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1194 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1195 When <link id="lingering_close"/> is in effect, this directive specifies
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1196 the maximum waiting time for more client data to arrive.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1197 If data are not received during this time, the connection is closed.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1198 Otherwise, the data are read and ignored, and nginx starts waiting
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1199 for more data again.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1200 The “wait-read-ignore” cycle is repeated, but no longer than specified by the
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1201 <link id="lingering_time"/> directive.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1202 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1203
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1204 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1205
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1206
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1207 <directive name="listen">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1208 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1209 <value>address</value>[:<value>port</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1210 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1211 [<literal>ssl</literal>]
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1212 [<literal>http2</literal> \| <literal>spdy</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1213 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1214 [<literal>setfib</literal>=<value>number</value>]
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1215 [<literal>fastopen</literal>=<value>number</value>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1216 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1217 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1218 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1219 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1220 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1221 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1222 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1223 [<literal>reuseport</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1224 [<literal>so_keepalive</literal>=<literal>on</literal>\|<literal>off</literal>\|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1225 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1226 <value>port</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1227 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1228 [<literal>ssl</literal>]
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1229 [<literal>http2</literal> \| <literal>spdy</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1230 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1231 [<literal>setfib</literal>=<value>number</value>]
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1232 [<literal>fastopen</literal>=<value>number</value>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1233 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1234 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1235 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1236 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1237 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1238 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1239 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1240 [<literal>reuseport</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1241 [<literal>so_keepalive</literal>=<literal>on</literal>\|<literal>off</literal>\|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1242 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1243 <literal>unix:</literal><value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1244 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1245 [<literal>ssl</literal>]
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1246 [<literal>http2</literal> \| <literal>spdy</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1247 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1248 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1249 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1250 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1251 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1252 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1253 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1254 [<literal>so_keepalive</literal>=<literal>on</literal>\|<literal>off</literal>\|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1255 <default>:80 \| :8000</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1256 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1257
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1258 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1259 Sets the <value>address</value> and <value>port</value> for IP,
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1260 or the <value>path</value> for a UNIX-domain socket on which
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1261 the server will accept requests.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1262 Both <value>address</value> and <value>port</value>,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1263 or only <value>address</value> or only <value>port</value> can be specified.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1264 An <value>address</value> may also be a hostname, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1265 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1266 listen 127.0.0.1:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1267 listen 127.0.0.1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1268 listen 8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1269 listen *:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1270 listen localhost:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1271 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1272 IPv6 addresses (0.7.36) are specified in square brackets:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1273 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1274 listen [::]:8000;
941 7d1d53d4d293 Removed link-scoped IPv6 addresses from examples. Ruslan Ermilov <ru@nginx.com> parents: 940 diff changeset	1275 listen [::1];
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1276 </example>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1277 UNIX-domain sockets (0.8.21) are specified with the “<literal>unix:</literal>”
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1278 prefix:
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1279 <example>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1280 listen unix:/var/run/nginx.sock;
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1281 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1282 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1283
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1284 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1285 If only <value>address</value> is given, the port 80 is used.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1286 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1287
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1288 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1289 If the directive is not present then either <literal>*:80</literal> is used
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1290 if nginx runs with the superuser privileges, or <literal>*:8000</literal>
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1291 otherwise.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1292 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1293
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1294 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1295 The <literal>default_server</literal> parameter, if present,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 will cause the server to become the default server for the specified
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1297 <value>address</value>:<value>port</value> pair.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1298 If none of the directives have the <literal>default_server</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 parameter then the first server with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1300 <value>address</value>:<value>port</value> pair will be
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1301 the default server for this pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1302 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1303 In versions prior to 0.8.21 this parameter is named simply
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1304 <literal>default</literal>.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1305 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1306 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1307
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1309 The <literal>ssl</literal> parameter (0.7.14) allows specifying that all
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1310 connections accepted on this port should work in SSL mode.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1311 This allows for a more compact <link doc="configuring_https_servers.xml"
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1312 id="single_http_https_server">configuration</link> for the server that
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1313 handles both HTTP and HTTPS requests.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1314 </para>
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1315
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1316 <para>
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1317 The <literal>http2</literal> parameter (1.9.5) configures the port to accept
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1318 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections.
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1319 Normally, for this to work the <literal>ssl</literal> parameter should be
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1320 specified as well, but nginx can also be configured to accept HTTP/2
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1321 connections without SSL.
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1322 </para>
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1323
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1324 <para>
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1325 The <literal>spdy</literal> parameter (1.3.15-1.9.4) allows accepting
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1326 <link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1327 Normally, for this to work the <literal>ssl</literal> parameter should be
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1328 specified as well, but nginx can also be configured to accept SPDY
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1329 connections without SSL.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1330 </para>
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1331
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1332 <para>
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1333 The <literal>proxy_protocol</literal> parameter (1.5.12)
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1334 allows specifying that all connections accepted on this port should use the
1513 88d1a1d36c0c Corrected link to the PROXY protocol specification. Yaroslav Zhuravlev <yar@nginx.com> parents: 1507 diff changeset	1335 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1336 protocol</link>.
2125 b19d5d47c16c Documented ver.2 of the PROXY protocol. Yaroslav Zhuravlev <yar@nginx.com> parents: 2121 diff changeset	1337 <note>
b19d5d47c16c Documented ver.2 of the PROXY protocol. Yaroslav Zhuravlev <yar@nginx.com> parents: 2121 diff changeset	1338 The PROXY protocol version 2 is supported since version 1.13.11.
b19d5d47c16c Documented ver.2 of the PROXY protocol. Yaroslav Zhuravlev <yar@nginx.com> parents: 2121 diff changeset	1339 </note>
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1340 </para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1341
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1342 <para>
1414 5addfab7e171 Corrected article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1279 diff changeset	1343 The <literal>listen</literal> directive
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1344 can have several additional parameters specific to socket-related system calls.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1345 These parameters can be specified in any
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1346 <literal>listen</literal> directive, but only once for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1347 <value>address</value>:<value>port</value> pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1348 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1349 In versions prior to 0.8.21, they could only be
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1350 specified in the <literal>listen</literal> directive together with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1351 <literal>default</literal> parameter.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1352 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1353 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1354
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1355 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1356 <literal>setfib</literal>=<value>number</value>
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1357 </tag-name>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1358 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1359 this parameter (0.8.44) sets the associated routing table, FIB
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1360 (the <c-def>SO_SETFIB</c-def> option) for the listening socket.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1361 This currently works only on FreeBSD.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1362 </tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1363
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1364 <tag-name>
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1365 <literal>fastopen</literal>=<value>number</value>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1366 </tag-name>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1367 <tag-desc>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1368 enables
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1369 “<link url="http://en.wikipedia.org/wiki/TCP_Fast_Open">TCP Fast Open</link>”
1037 3fde5aa256ac Fixed markup. Vladimir Homutov <vl@nginx.com> parents: 1036 diff changeset	1370 for the listening socket (1.5.8) and
1923 66a30a380fba Fixed links to tools.ietf.org. Ruslan Ermilov <ru@nginx.com> parents: 1911 diff changeset	1371 <link url="https://tools.ietf.org/html/rfc7413#section-5.1">limits</link>
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1372 the maximum length for the queue of connections that have not yet completed
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1373 the three-way handshake.
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1374 <note>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1375 Do not enable this feature unless the server can handle
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1376 receiving the
1923 66a30a380fba Fixed links to tools.ietf.org. Ruslan Ermilov <ru@nginx.com> parents: 1911 diff changeset	1377 <link url="https://tools.ietf.org/html/rfc7413#section-6.1">
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1378 same SYN packet with data</link> more than once.
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1379 </note>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1380 </tag-desc>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1381
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1382 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1383 <literal>backlog</literal>=<value>number</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1384 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1385 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1386 sets the <literal>backlog</literal> parameter in the
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1387 <c-func>listen</c-func> call that limits
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1388 the maximum length for the queue of pending connections.
1501 40425063b413 Fixed the default "listen backlog" value on DragonFly BSD. Ruslan Ermilov <ru@nginx.com> parents: 1500 diff changeset	1389 By default,
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	1390 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and macOS,
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1391 and to 511 on other platforms.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1392 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1393
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1394 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1395 <literal>rcvbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1396 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1397 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1398 sets the receive buffer size
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1399 (the <c-def>SO_RCVBUF</c-def> option) for the listening socket.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1400 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1401
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1402 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1403 <literal>sndbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1404 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1405 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1406 sets the send buffer size
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1407 (the <c-def>SO_SNDBUF</c-def> option) for the listening socket.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1408 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1409
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1410 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1411 <literal>accept_filter</literal>=<value>filter</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1412 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1413 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1414 sets the name of accept filter
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1415 (the <c-def>SO_ACCEPTFILTER</c-def> option) for the listening socket
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1416 that filters incoming connections before passing them to
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1417 <c-func>accept</c-func>.
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1418 This works only on FreeBSD and NetBSD 5.0+.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1419 Possible values are
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1420 <link url="http://man.freebsd.org/accf_data">dataready</link>
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1421 and
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1422 <link url="http://man.freebsd.org/accf_http">httpready</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1423 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1424
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1425 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1426 <literal>deferred</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1427 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1429 instructs to use a deferred <c-func>accept</c-func>
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1430 (the <c-def>TCP_DEFER_ACCEPT</c-def> socket option) on Linux.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1431 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1432
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1434 <literal>bind</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1435 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1436 <tag-desc>
240 472e88bf177e Slightly better wording for the "bind" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 237 diff changeset	1437 instructs to make a separate <c-func>bind</c-func> call for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1438 <value>address</value>:<value>port</value> pair.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1439 This is useful because if there are several <literal>listen</literal>
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1440 directives with the same port but different addresses, and one of the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1441 <literal>listen</literal> directives listens on all addresses
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1442 for the given port (<literal>*:</literal><value>port</value>), nginx
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1443 will <c-func>bind</c-func> only to <literal>*:</literal><value>port</value>.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1444 It should be noted that the <c-func>getsockname</c-func> system call will be
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1445 made in this case to determine the address that accepted the connection.
1035 e9c485d6cc0c Documented that "listen setfib=" implies "bind". Ruslan Ermilov <ru@nginx.com> parents: 1031 diff changeset	1446 If the <literal>setfib</literal>,
e9c485d6cc0c Documented that "listen setfib=" implies "bind". Ruslan Ermilov <ru@nginx.com> parents: 1031 diff changeset	1447 <literal>backlog</literal>, <literal>rcvbuf</literal>,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1448 <literal>sndbuf</literal>, <literal>accept_filter</literal>,
1279 7261e621dd4a Documented that "listen ipv6only=" implies "bind". Maxim Dounin <mdounin@mdounin.ru> parents: 1257 diff changeset	1449 <literal>deferred</literal>, <literal>ipv6only</literal>,
7261e621dd4a Documented that "listen ipv6only=" implies "bind". Maxim Dounin <mdounin@mdounin.ru> parents: 1257 diff changeset	1450 or <literal>so_keepalive</literal> parameters
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1451 are used then for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1452 <value>address</value>:<value>port</value> pair
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1453 a separate <c-func>bind</c-func> call will always be made.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1454 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1455
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1456 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1457 <literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1458 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1459 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1460 this parameter (0.7.42) determines
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1461 (via the <c-def>IPV6_V6ONLY</c-def> socket option)
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1462 whether an IPv6 socket listening on a wildcard address <literal>[::]</literal>
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1463 will accept only IPv6 connections or both IPv6 and IPv4 connections.
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1464 This parameter is turned on by default.
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1465 It can only be set once on start.
615 f3ef5b77d22a Documented that "ipv6only" is now turned on by default for Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	1466 <note>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1467 Prior to version 1.3.4,
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1468 if this parameter was omitted then the operating system’s settings were
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1469 in effect for the socket.
615 f3ef5b77d22a Documented that "ipv6only" is now turned on by default for Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	1470 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1471 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1472
1507 14180fa9a518 Added ids for reuseport, mentioned reuseport in news. Yaroslav Zhuravlev <yar@nginx.com> parents: 1501 diff changeset	1473 <tag-name id="reuseport">
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1474 <literal>reuseport</literal>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1475 </tag-name>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1476 <tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1477 this parameter (1.9.1) instructs to create an individual listening socket
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1478 for each worker process
2199 1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1479 (using the
1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1480 <c-def>SO_REUSEPORT</c-def> socket option on Linux 3.9+ and DragonFly BSD,
1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1481 or <c-def>SO_REUSEPORT_LB</c-def> on FreeBSD 12+), allowing a kernel
1496 99ce48c8cce3 Corrected the "reuseport" description of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1493 diff changeset	1482 to distribute incoming connections between worker processes.
2199 1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1483 This currently works only on Linux 3.9+, DragonFly BSD,
1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1484 and FreeBSD 12+ (1.15.1).
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1485 <note>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1486 Inappropriate use of this option may have its security
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1487 <link url="http://man7.org/linux/man-pages/man7/socket.7.html">implications</link>.
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1488 </note>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1489 </tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1490
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1491 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1492 <literal>so_keepalive</literal>=<literal>on</literal>\|<literal>off</literal>\|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1493 </tag-name>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1494 <tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1495 this parameter (1.1.11) configures the “TCP keepalive” behavior
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1496 for the listening socket.
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1497 If this parameter is omitted then the operating system’s settings will be
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1498 in effect for the socket.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1499 If it is set to the value “<literal>on</literal>”, the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1500 <c-def>SO_KEEPALIVE</c-def> option is turned on for the socket.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1501 If it is set to the value “<literal>off</literal>”, the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1502 <c-def>SO_KEEPALIVE</c-def> option is turned off for the socket.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1503 Some operating systems support setting of TCP keepalive parameters on
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1504 a per-socket basis using the <c-def>TCP_KEEPIDLE</c-def>,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1505 <c-def>TCP_KEEPINTVL</c-def>, and <c-def>TCP_KEEPCNT</c-def> socket options.
397 f1c0ae9c1c48 FreeBSD 10.0-CURRENT supports the TCP_KEEPIDLE, TCP_KEEPINTVL, and Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1506 On such systems (currently, Linux 2.4+, NetBSD 5+, and
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1507 FreeBSD 9.0-STABLE), they can be configured
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1508 using the <value>keepidle</value>, <value>keepintvl</value>, and
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1509 <value>keepcnt</value> parameters.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1510 One or two parameters may be omitted, in which case the system default setting
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1511 for the corresponding socket option will be in effect.
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1512 For example,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1513 <example>so_keepalive=30m::10</example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1514 will set the idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1515 leave the probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1516 and set the probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes.
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1517 </tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1518
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1519 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1520 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1521
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1522 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1523 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1524 <example>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1525 listen 127.0.0.1 default_server accept_filter=dataready backlog=1024;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1526 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1527 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1528
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1530
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1531
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1532 <directive name="location">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	1533 <syntax block="yes">[
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1534 <literal>=</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1535 <literal>~</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1536 <literal>~*</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1537 <literal>^~</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1538 ] <value>uri</value></syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1539 <syntax block="yes"><literal>@</literal><value>name</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1540 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1541 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1542 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1543
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1544 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1545 Sets configuration depending on a request URI.
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1546 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1547
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1548 <para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1549 The matching is performed against a normalized URI,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1550 after decoding the text encoded in the “<literal>%XX</literal>” form,
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1551 resolving references to relative path components “<literal>.</literal>”
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1552 and “<literal>..</literal>”, and possible
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1553 <link id="merge_slashes">compression</link> of two or more
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1554 adjacent slashes into a single slash.
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1555 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1556
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1557 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1558 A location can either be defined by a prefix string, or by a regular expression.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1559 Regular expressions are specified with the preceding
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1560 “<literal>~*</literal>” modifier (for case-insensitive matching), or the
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1561 “<literal>~</literal>” modifier (for case-sensitive matching).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1562 To find location matching a given request, nginx first checks
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1563 locations defined using the prefix strings (prefix locations).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1564 Among them, the location with the longest matching
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1565 prefix is selected and remembered.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1566 Then regular expressions are checked, in the order of their appearance
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1567 in the configuration file.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1568 The search of regular expressions terminates on the first match,
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1569 and the corresponding configuration is used.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1570 If no match with a regular expression is found then the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1571 configuration of the prefix location remembered earlier is used.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1572 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1573
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1574 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1575 <literal>location</literal> blocks can be nested, with some exceptions
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1576 mentioned below.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1577 </para>
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1578
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1579 <para>
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	1580 For case-insensitive operating systems such as macOS and Cygwin,
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1581 matching with prefix strings ignores a case (0.7.7).
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1582 However, comparison is limited to one-byte locales.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1583 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1584
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1585 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1586 Regular expressions can contain captures (0.7.40) that can later
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1587 be used in other directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1588 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1589
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1590 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1591 If the longest matching prefix location has the “<literal>^~</literal>” modifier
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1592 then regular expressions are not checked.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1593 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1594
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1595 <para>
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1596 Also, using the “<literal>=</literal>” modifier it is possible to define
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1597 an exact match of URI and location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1598 If an exact match is found, the search terminates.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1599 For example, if a “<literal>/</literal>” request happens frequently,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1600 defining “<literal>location = /</literal>” will speed up the processing
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1601 of these requests, as search terminates right after the first
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1602 comparison.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1603 Such a location cannot obviously contain nested locations.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1604 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1605
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1606 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1607 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1608 In versions from 0.7.1 to 0.8.41, if a request matched the prefix
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1609 location without the “<literal>=</literal>” and “<literal>^~</literal>”
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1610 modifiers, the search also terminated and regular expressions were
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1611 not checked.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1612 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1613 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1614
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1615 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1616 Let’s illustrate the above by an example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1617 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1618 location = / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1619 [ configuration A ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1620 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1621
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1622 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1623 [ configuration B ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1624 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1625
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1626 location /documents/ {
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1627 [ configuration C ]
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1628 }
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1629
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1630 location ^~ /images/ {
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1631 [ configuration D ]
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1632 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1633
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1634 location ~* \.(gif\|jpg\|jpeg)$ {
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1635 [ configuration E ]
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1636 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1637 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1638 The “<literal>/</literal>” request will match configuration A,
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1639 the “<literal>/index.html</literal>” request will match configuration B,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1640 the “<literal>/documents/document.html</literal>” request will match
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1641 configuration C,
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1642 the “<literal>/images/1.gif</literal>” request will match configuration D, and
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1643 the “<literal>/documents/1.jpg</literal>” request will match configuration E.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1644 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1645
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1646 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1647 The “<literal>@</literal>” prefix defines a named location.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1648 Such a location is not used for a regular request processing, but instead
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1649 used for request redirection.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1650 They cannot be nested, and cannot contain nested locations.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1651 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1652
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1653 <para>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1654 If a location is defined by a prefix string that ends with the slash character,
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1655 and requests are processed by one of
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1656 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>,
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1657 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1658 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>,
2134 4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	1659 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>,
4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	1660 <link doc="ngx_http_memcached_module.xml" id="memcached_pass"/>, or
4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	1661 <link doc="ngx_http_grpc_module.xml" id="grpc_pass"/>,
1257 ac7a5ee98768 Split long sentence into two. Ruslan Ermilov <ru@nginx.com> parents: 1194 diff changeset	1662 then the special processing is performed.
ac7a5ee98768 Split long sentence into two. Ruslan Ermilov <ru@nginx.com> parents: 1194 diff changeset	1663 In response to a request with URI equal to this string,
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1664 but without the trailing slash,
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1665 a permanent redirect with the code 301 will be returned to the requested URI
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1666 with the slash appended.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1667 If this is not desired, an exact match of the URI and location could be
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1668 defined like this:
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1669 <example>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1670 location /user/ {
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1671 proxy_pass http://user.example.com;
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1672 }
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1673
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1674 location = /user {
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1675 proxy_pass http://login.example.com;
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1676 }
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1677 </example>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1678 </para>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1679
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1680 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1681 <migration from="Apache" directive="Location" />
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1682 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1683
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1684 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1685
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1686
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1687 <directive name="log_not_found">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1688 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1689 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1690 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1691 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1692 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1693
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1694 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1695 Enables or disables logging of errors about not found files into
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1696 <link doc="../ngx_core_module.xml" id="error_log"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1697 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1698
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1699 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1700
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1701
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1702 <directive name="log_subrequest">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1703 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1704 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1705 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1706 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1707 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1708
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1709 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1710 Enables or disables logging of subrequests into
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1711 <link doc="ngx_http_log_module.xml" id="access_log"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1712 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1713
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1714 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1715
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1716
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1717 <directive name="max_ranges">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1718 <syntax><value>number</value></syntax>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1719 <default/>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1720 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1721 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1722 <context>location</context>
499 76a8eca844d0 Documented that "max_ranges" appeared in 1.1.2. Ruslan Ermilov <ru@nginx.com> parents: 477 diff changeset	1723 <appeared-in>1.1.2</appeared-in>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1724
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1725 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1726 Limits the maximum allowed number of ranges in byte-range requests.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1727 Requests that exceed the limit are processed as if there were no
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1728 byte ranges specified.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1729 By default, the number of ranges is not limited.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1730 The zero value disables the byte-range support completely.
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1731 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1732
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1733 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1734
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1735
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1736 <directive name="merge_slashes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1737 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1738 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1739 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1740 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1741
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1742 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1743 Enables or disables compression of two or more adjacent slashes
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1744 in a URI into a single slash.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1745 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1746
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1747 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1748 Note that compression is essential for the correct matching of prefix string
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1749 and regular expression locations.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1750 Without it, the “<literal>//scripts/one.php</literal>” request would not match
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1751 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1752 location /scripts/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1753 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1754 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1755 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1756 and might be processed as a static file.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1757 So it gets converted to “<literal>/scripts/one.php</literal>”.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1758 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1759
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1760 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1761 Turning the compression <literal>off</literal> can become necessary if a URI
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1762 contains base64-encoded names, since base64 uses the “<literal>/</literal>”
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1763 character internally.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1764 However, for security considerations, it is better to avoid turning
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1765 the compression off.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1766 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1767
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1768 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	1769 If the directive is specified on the <link id="server"/> level,
375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	1770 its value is only used if a server is a default one.
375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	1771 The value specified also applies to all virtual servers
442 b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	1772 listening on the same address and port.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1773 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1774
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1775 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1776
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1777
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1778 <directive name="msie_padding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1779 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1780 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1781 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1782 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1783 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1784
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1785 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1786 Enables or disables adding comments to responses for MSIE clients with status
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1787 greater than 400 to increase the response size to 512 bytes.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1788 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1789
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1790 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1791
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1792
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1793 <directive name="msie_refresh">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1794 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1795 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1796 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1797 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1798 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1799
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1800 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1801 Enables or disables issuing refreshes instead of redirects for MSIE clients.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1802 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1803
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1804 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1805
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1806
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1807 <directive name="open_file_cache">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1808 <syntax><literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1809 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1810 <literal>max</literal>=<value>N</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1811 [<literal>inactive</literal>=<value>time</value>]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1812 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1813 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1814 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1815 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1816
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1817 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1818 Configures a cache that can store:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1819 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1820
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1821 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1822 open file descriptors, their sizes and modification times;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1823 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1824
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1825 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1826 information on existence of directories;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1827 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1828
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1829 <listitem>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1830 file lookup errors, such as “file not found”, “no read permission”,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1831 and so on.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1832 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1833 Caching of errors should be enabled separately by the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1834 <link id="open_file_cache_errors"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1835 directive.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1836 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1837 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1838
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1839 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1840 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1841
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1842 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1843 The directive has the following parameters:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1844 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1845
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1846 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1847 <literal>max</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1848 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1849 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1850 sets the maximum number of elements in the cache;
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1851 on cache overflow the least recently used (LRU) elements are removed;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1852 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1853
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1854 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1855 <literal>inactive</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1856 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1857 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1858 defines a time after which an element is removed from the cache
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1859 if it has not been accessed during this time;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1860 by default, it is 60 seconds;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1861 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1862
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1863 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1864 <literal>off</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1865 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1866 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867 disables the cache.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1868 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1869
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1870 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1871 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1872
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1873 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1874 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1875 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1876 open_file_cache max=1000 inactive=20s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1877 open_file_cache_valid 30s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1878 open_file_cache_min_uses 2;
270 945d7299c26c Spaces are now preserved here, so removed all the hacks. Ruslan Ermilov <ru@nginx.com> parents: 252 diff changeset	1879 open_file_cache_errors on;<!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1880 open_file_cache_events on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1881 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1882 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1883 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1884
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1885 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1886
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1887
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1888 <directive name="open_file_cache_errors">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1889 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1890 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1891 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1892 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1893 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1894
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1895 <para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1896 Enables or disables caching of file lookup errors by
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1897 <link id="open_file_cache"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1898 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1899
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1900 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1901
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1902
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1903 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1904
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1905 <directive name="open_file_cache_events">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1906 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1907 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1908 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1909 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1910 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1911
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1912 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1913 Enables to use kernel events to validate
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1914 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1915 elements.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1916 This directive works with the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1917 <link doc="../events.xml" id="kqueue"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1918 method only.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1919 Note that only NetBSD 2.0+ and FreeBSD 6.0+
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1920 support events for arbitrary file system types.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1921 Other operating systems support events only for essential
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1922 file systems such as UFS or FFS.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1923 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1924
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1925 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1926
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1928
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1929
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1930 <directive name="open_file_cache_min_uses">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1931 <syntax><value>number</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1932 <default>1</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1933 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1934 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1935 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1936
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1937 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1938 Sets the minimum <value>number</value> of file accesses during
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1939 the period configured by the <literal>inactive</literal> parameter
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1940 of the <link id="open_file_cache"/> directive, required for a file
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1941 descriptor to remain open in the cache.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1942 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1943
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1944 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1945
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1946
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1947 <directive name="open_file_cache_valid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1948 <syntax><value>time</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1949 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1950 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1951 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1952 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1953
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1954 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955 Sets a time after which
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1956 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1957 elements should be validated.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1958 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1959 When
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1960 <link id="open_file_cache_events"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1961 is enabled, open file descriptors
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1962 are checked only once, and then updated right after they get changed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1963 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1964 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1965
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1966 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1967
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1968
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1969 <directive name="output_buffers">
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1970 <syntax><value>number</value> <value>size</value></syntax>
1576 7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	1971 <default>2 32k</default>
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1972 <context>http</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1973 <context>server</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1974 <context>location</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1975
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1976 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	1977 Sets the <value>number</value> and <value>size</value> of the
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1978 buffers used for reading a response from a disk.
1576 7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	1979 <note>
7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	1980 Prior to version 1.9.5, the default value was 1 32k.
7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	1981 </note>
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1982 </para>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1983
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1984 </directive>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1985
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1986
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1987 <directive name="port_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1988 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1989 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1990 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1993
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994 <para>
1879 3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	1995 Enables or disables specifying the port in
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	1996 <link id="absolute_redirect">absolute</link> redirects issued by nginx.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1997 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1998
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1999 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2000 The use of the primary server name in redirects is controlled by
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2001 the <link id="server_name_in_redirect"/> directive.
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2002 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2003
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2004 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2005
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2006
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2007 <directive name="postpone_output">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2008 <syntax><value>size</value></syntax>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2009 <default>1460</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2010 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2011 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2012 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2013
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2014 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2015 If possible, the transmission of client data will be postponed until
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2016 nginx has at least <value>size</value> bytes of data to send.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2017 The zero value disables postponing data transmission.
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2018 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2019
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2020 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2021
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2022
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2023 <directive name="read_ahead">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2024 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2025 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2026 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2028 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2029
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2030 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2031 Sets the amount of pre-reading for the kernel when working with file.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2032 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2033
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035 On Linux, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2036 <literal>posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL)</literal>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2037 system call is used, and so the <value>size</value> parameter is ignored.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2038 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2039
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2040 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2041 On FreeBSD, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2042 <literal>fcntl(O_READAHEAD,</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2043 <value>size</value><literal>)</literal>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2044 system call, supported since FreeBSD 9.0-CURRENT, is used.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2045 FreeBSD 7 has to be
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2046 <link url="http://sysoev.ru/freebsd/patch.readahead.txt">patched</link>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2047 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2050
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2052 <directive name="recursive_error_pages">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2053 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2054 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2055 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2056 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2057 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2058
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2059 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2060 Enables or disables doing several redirects using the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2061 <link id="error_page"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2062 directive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2063 The number of such redirects is <link id="internal">limited</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2064 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2065
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2066 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2067
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2068
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2069 <directive name="request_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2070 <syntax><value>size</value></syntax>
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2071 <default>4k</default>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2072 <context>http</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2073 <context>server</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2074
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2075 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2076 Allows accurate tuning of per-request memory allocations.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2077 This directive has minimal impact on performance
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2078 and should not generally be used.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2079 </para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2080
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2081 </directive>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2082
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2083
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 <directive name="reset_timedout_connection">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2085 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2086 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2087 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2088 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2089 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2090
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2091 <para>
2390 655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2092 Enables or disables resetting timed out connections
655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2093 and connections
655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2094 <link doc="ngx_http_rewrite_module.xml" id="return">closed</link>
655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2095 with the non-standard code 444 (1.15.2).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2096 The reset is performed as follows.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2097 Before closing a socket, the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2098 <c-def>SO_LINGER</c-def>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2099 option is set on it with a timeout value of 0.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2100 When the socket is closed, TCP RST is sent to the client, and all memory
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2101 occupied by this socket is released.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2102 This helps avoid keeping an already closed socket with filled buffers
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2103 in a FIN_WAIT1 state for a long time.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2105
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2106 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2107 It should be noted that timed out keep-alive connections are
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2108 closed normally.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2109 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2110
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2111 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2112
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2113
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2114 <directive name="resolver">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2115 <syntax>
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2116 <value>address</value> ...
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2117 [<literal>valid</literal>=<value>time</value>]
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2118 [<literal>ipv6</literal>=<literal>on</literal>\|<literal>off</literal>]
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2119 [<literal>status_zone</literal>=<value>zone</value>]</syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2120 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2121 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2122 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2123 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2124
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2125 <para>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2126 Configures name servers used to resolve names of upstream servers
58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2127 into addresses, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2128 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2129 resolver 127.0.0.1 [::1]:5353;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2130 </example>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2131 The address can be specified as a domain name or IP address,
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2132 with an optional port (1.3.1, 1.2.2).
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2133 If port is not specified, the port 53 is used.
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	2134 Name servers are queried in a round-robin fashion.
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	2135 <note>
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	2136 Before version 1.1.7, only a single name server could be configured.
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2137 Specifying name servers using IPv6 addresses is supported
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	2138 starting from versions 1.3.1 and 1.2.2.
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	2139 </note>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2140 </para>
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2141
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2142 <para id="resolver_ipv6">
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2143 By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2144 If looking up of IPv6 addresses is not desired,
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2145 the <literal>ipv6=off</literal> parameter can be specified.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2146 <note>
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2147 Resolving of names into IPv6 addresses is supported
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2148 starting from version 1.5.8.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2149 </note>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2150 </para>
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2151
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2152 <para id="resolver_valid">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2153 By default, nginx caches answers using the TTL value of a response.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2154 An optional <literal>valid</literal> parameter allows overriding it:
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2155 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2156 resolver 127.0.0.1 [::1]:5353 valid=30s;
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2157 </example>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2158 <note>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2159 Before version 1.1.9, tuning of caching time was not possible,
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2160 and nginx always cached answers for the duration of 5 minutes.
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2161 </note>
1770 ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2162 <note>
ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2163 To prevent DNS spoofing, it is recommended
ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2164 configuring DNS servers in a properly secured trusted local network.
ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2165 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2166 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2167
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2168 <para id="resolver_status_zone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2169 The optional <literal>status_zone</literal> parameter (1.17.1)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2170 enables
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2171 <link doc="ngx_http_api_module.xml" id="resolvers_">collection</link>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2172 of DNS server statistics of requests and responses
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2173 in the specified <value>zone</value>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2174 The parameter is available as part of our
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2175 <commercial_version>commercial subscription</commercial_version>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2176 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2391 diff changeset	2177
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2179
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2180
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2181 <directive name="resolver_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2182 <syntax><value>time</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2183 <default>30s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2184 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2185 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2186 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2187
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2188 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189 Sets a timeout for name resolution, for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2190 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2191 resolver_timeout 5s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2192 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2193 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2194
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2195 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2196
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2197
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2198 <directive name="root">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2199 <syntax><value>path</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2200 <default>html</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2201 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2202 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2203 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2204 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2205
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2206 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2207 Sets the root directory for requests.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2208 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2209 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2210 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2211 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2212 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2213 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2214 The <path>/data/w3/i/top.gif</path> file will be sent in response to
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2215 the “<literal>/i/top.gif</literal>” request.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2216 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2217
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2218 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2219 The <value>path</value> value can contain variables,
69 935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	2220 except <var>$document_root</var> and <var>$realpath_root</var>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2221 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2222
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2223 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2224 A path to the file is constructed by merely adding a URI to the value
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2225 of the <literal>root</literal> directive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2226 If a URI has to be modified, the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2227 <link id="alias"/> directive should be used.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2228 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2229
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2230 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2231
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2232
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2233 <directive name="satisfy">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2234 <syntax><literal>all</literal> \| <literal>any</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2235 <default>all</default>
69 935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	2236 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	2237 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2238 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2239
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2240 <para>
971 6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2241 Allows access if all (<literal>all</literal>) or at least one
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2242 (<literal>any</literal>) of the
971 6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2243 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>,
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1732 diff changeset	2244 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>,
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1732 diff changeset	2245 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>,
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1732 diff changeset	2246 or
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1732 diff changeset	2247 <link doc="ngx_http_auth_jwt_module.xml">ngx_http_auth_jwt_module</link>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2248 modules allow access.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2249 </para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2250
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2251 <para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2252 Example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2253 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2254 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2255 satisfy any;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2256
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2257 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2258 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2259
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2260 auth_basic "closed site";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2261 auth_basic_user_file conf/htpasswd;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2262 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2263 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2264 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2265
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2266 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2267
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2268
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2269 <directive name="send_lowat">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2270 <syntax><value>size</value></syntax>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2271 <default>0</default>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2272 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2273 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2274 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2275
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2276 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2277 If the directive is set to a non-zero value, nginx will try to minimize
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2278 the number of send operations on client sockets by using either
553 6330ca27a485 Translated "events" into English. Ruslan Ermilov <ru@nginx.com> parents: 541 diff changeset	2279 <c-def>NOTE_LOWAT</c-def> flag of the
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2280 <link doc="../events.xml" id="kqueue"/> method
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2281 or the <c-def>SO_SNDLOWAT</c-def> socket option.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2282 In both cases the specified <value>size</value> is used.
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2283 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2284
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2285 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2286 This directive is ignored on Linux, Solaris, and Windows.
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2287 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2288
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2289 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2290
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2291
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2292 <directive name="send_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2293 <syntax><value>time</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2294 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2295 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2296 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2297 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2298
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2299 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2300 Sets a timeout for transmitting a response to the client.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1132 diff changeset	2301 The timeout is set only between two successive write operations,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2302 not for the transmission of the whole response.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1132 diff changeset	2303 If the client does not receive anything within this time,
1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1132 diff changeset	2304 the connection is closed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2305 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2306
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2307 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2308
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2309
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2310 <directive name="sendfile">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2311
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2312 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2313 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2314 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2315 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2316 <context>location</context>
69 935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	2317 <context>if in location</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2318
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2319 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2320 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2321 <c-func>sendfile</c-func>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2322 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2323
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2324 <para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2325 Starting from nginx 0.8.12 and FreeBSD 5.2.1,
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2326 <link id="aio"/> can be used to pre-load data
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2327 for <c-func>sendfile</c-func>:
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2328 <example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2329 location /video/ {
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2330 sendfile on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2331 tcp_nopush on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2332 aio on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2333 }
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2334 </example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2335 In this configuration, <c-func>sendfile</c-func> is called with
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2336 the <c-def>SF_NODISKIO</c-def> flag which causes it not to block on disk I/O,
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2337 but, instead, report back that the data are not in memory.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2338 nginx then initiates an asynchronous data load by reading one byte.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2339 On the first read, the FreeBSD kernel loads the first 128K bytes
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2340 of a file into memory, although next reads will only load data in 16K chunks.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2341 This can be changed using the
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2342 <link id="read_ahead"/> directive.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2343 <note>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2344 Before version 1.7.11, pre-loading could be enabled with
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2345 <literal>aio sendfile;</literal>.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2346 </note>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2347 </para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2348
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2349 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2350
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2351
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2352 <directive name="sendfile_max_chunk">
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2353
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2354 <syntax><value>size</value></syntax>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2355 <default>0</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2356 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2357 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2358 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2359
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2360 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2361 When set to a non-zero value, limits the amount of data that can be
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2362 transferred in a single <c-func>sendfile</c-func> call.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2363 Without the limit, one fast connection may seize the worker process entirely.
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2364 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2365
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2366 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2367
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2368
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2369 <directive name="server">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2370 <syntax block="yes"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2371 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2372 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2373
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2374 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2375 Sets configuration for a virtual server.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2376 There is no clear separation between IP-based (based on the IP address)
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2377 and name-based (based on the <header>Host</header> request header field)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2378 virtual servers.
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2379 Instead, the <link id="listen"/> directives describe all
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2380 addresses and ports that should accept connections for the server, and the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2381 <link id="server_name"/> directive lists all server names.
522 ef11546f75ee Translated "request_processing" into Russian, removed "virtual_hosts" Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	2382 Example configurations are provided in the
ef11546f75ee Translated "request_processing" into Russian, removed "virtual_hosts" Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	2383 “<link doc="request_processing.xml"/>” document.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2384 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2385
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2386 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2387
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2388
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2389 <directive name="server_name">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2390 <syntax><value>name</value> ...</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2391 <default>""</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2392 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2393
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2394 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2395 Sets names of a virtual server, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2396 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2397 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2398 server_name example.com www.example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2399 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2400 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2401 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2402
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2403 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2404 The first name becomes the primary server name.
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2405 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2406
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2407 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2408 Server names can include an asterisk (“<literal>*</literal>”)
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2409 replacing the first or last part of a name:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2410 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2411 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2412 server_name example.com .example.com www.example.;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2413 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2414 </example>
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2415 Such names are called wildcard names.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2416 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2417
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2418 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2419 The first two of the names mentioned above can be combined in one:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2420 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2421 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2422 server_name .example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2423 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2424 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2425 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2426
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2427 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2428 It is also possible to use regular expressions in server names,
1101 ebe027a963f4 Typo fixed. Andrei Belov <defan@nginx.com> parents: 1097 diff changeset	2429 preceding the name with a tilde (“<literal>~</literal>”):
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2430 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2431 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2432 server_name www.example.com ~^www\d+\.example\.com$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2433 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2434 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2435 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2436
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2437 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2438 Regular expressions can contain captures (0.7.40) that can later
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2439 be used in other directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2440 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2441 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2442 server_name ~^(www\.)?(.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2443
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2444 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2445 root /sites/$2;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2446 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2447 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2448
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2449 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2450 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2451
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2452 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2453 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2454 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2455 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2456 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2457 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2458
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2459 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2460 Named captures in regular expressions create variables (0.8.25)
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2461 that can later be used in other directives:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2462 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2463 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2464 server_name ~^(www\.)?(?<domain>.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2465
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2466 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2467 root /sites/$domain;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2468 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2469 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2470
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2471 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2472 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2473
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2474 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2475 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2476 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2477 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2478 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2479 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2480
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2481 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2482 If the directive’s parameter is set to “<var>$hostname</var>” (0.9.4), the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2483 machine’s hostname is inserted.
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2484 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2485
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2486 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2487 It is also possible to specify an empty server name (0.7.11):
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2488 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2489 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2490 server_name www.example.com "";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2491 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2492 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2493 It allows this server to process requests without the <header>Host</header>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2494 header field — instead of the default server — for the given address:port pair.
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2495 This is the default setting.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2496 <note>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2497 Before 0.8.48, the machine’s hostname was used by default.
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2498 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2499 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2500
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2501 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2502 During searching for a virtual server by name,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2503 if the name matches more than one of the specified variants,
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2504 (e.g. both a wildcard name and regular expression match), the first matching
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2505 variant will be chosen, in the following order of priority:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2506 <list type="enum">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2507
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2508 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2509 the exact name
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2510 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2511
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2512 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2513 the longest wildcard name starting with an asterisk,
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2514 e.g. “<literal>*.example.com</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2515 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2516
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2517 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2518 the longest wildcard name ending with an asterisk,
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2519 e.g. “<literal>mail.*</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2520 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2521
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2522 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2523 the first matching regular expression
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2524 (in order of appearance in the configuration file)
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2525 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2526
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2527 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2529
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2530 <para>
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2531 Detailed description of server names is provided in a separate
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2532 <link doc="server_names.xml"/> document.
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2533 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2534
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2535 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2536
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2537
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2538 <directive name="server_name_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2539 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2540 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2541 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2542 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2543 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2544
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2545 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2546 Enables or disables the use of the primary server name, specified by the
1879 3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	2547 <link id="server_name"/> directive,
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	2548 in <link id="absolute_redirect">absolute</link> redirects issued by nginx.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2549 When the use of the primary server name is disabled, the name from the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2550 <header>Host</header> request header field is used.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2551 If this field is not present, the IP address of the server is used.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2552 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2553
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2554 <para>
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2555 The use of a port in redirects is controlled by
77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2556 the <link id="port_in_redirect"/> directive.
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2557 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2558
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2559 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2560
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2561
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2562 <directive name="server_names_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2563 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2564 <default>32\|64\|128</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2565 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2566
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2567 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2568 Sets the bucket size for the server names hash tables.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2569 The default value depends on the size of the processor’s cache line.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2570 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2571 <link doc="../hash.xml">document</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2572 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2573
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2574 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2575
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2576
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2577 <directive name="server_names_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2578 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2579 <default>512</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2580 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2581
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2582 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2583 Sets the maximum <value>size</value> of the server names hash tables.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2584 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2585 <link doc="../hash.xml">document</link>.
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2586 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2587
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2588 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2589
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2590
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2591 <directive name="server_tokens">
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2592 <syntax>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2593 <literal>on</literal> \|
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2594 <literal>off</literal> \|
1904 d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2595 <literal>build</literal> \|
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2596 <value>string</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2597 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2598 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2599 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2600 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2601
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2602 <para>
1903 da00a2526415 Replaced "error messages" with "error pages" in server_tokens. Yaroslav Zhuravlev <yar@nginx.com> parents: 1879 diff changeset	2603 Enables or disables emitting nginx version on error pages and in the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2604 <header>Server</header> response header field.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2605 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2606
1904 d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2607 <para id="server_tokens_build">
1953 408eed0bf491 Clarified description of server_tokens build. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	2608 The <literal>build</literal> parameter (1.11.10) enables emitting
408eed0bf491 Clarified description of server_tokens build. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	2609 a <link doc="../configure.xml" id="build">build name</link>
408eed0bf491 Clarified description of server_tokens build. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	2610 along with nginx version.
1904 d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2611 </para>
d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2612
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2613 <para>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2614 Additionally, as part of our
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2615 <commercial_version>commercial subscription</commercial_version>,
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2616 starting from version 1.9.13
1903 da00a2526415 Replaced "error messages" with "error pages" in server_tokens. Yaroslav Zhuravlev <yar@nginx.com> parents: 1879 diff changeset	2617 the signature on error pages and
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2618 the <header>Server</header> response header field value
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2619 can be set explicitly using the <value>string</value> with variables.
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2620 An empty string disables the emission of the <header>Server</header> field.
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2621 </para>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2622
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2623 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2624
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2625
2118 0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2626 <directive name="subrequest_output_buffer_size">
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2627 <syntax><value>size</value></syntax>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2628 <default>4k\|8k</default>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2629 <context>http</context>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2630 <context>server</context>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2631 <context>location</context>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2632 <appeared-in>1.13.10</appeared-in>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2633
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2634 <para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2635 Sets the <value>size</value> of the buffer used for
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2636 storing the response body of a subrequest.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2637 By default, the buffer size is equal to one memory page.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2638 This is either 4K or 8K, depending on a platform.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2639 It can be made smaller, however.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2640 </para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2641
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2642 <para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2643 The directive is applicable only for subrequests
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2644 with response bodies saved into memory.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2645 For example, such subrequests are created by
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2646 <link doc="ngx_http_ssi_module.xml" id="ssi_include_set">SSI</link>.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2647 </para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2648
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2649 </directive>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2650
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2651
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2652 <directive name="tcp_nodelay">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2653 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2654 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2655 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2656 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2657 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2658
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2659 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2660 Enables or disables the use of the <c-def>TCP_NODELAY</c-def> option.
2121 cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2661 The option is enabled when a connection is transitioned into the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2662 keep-alive state.
2121 cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2663 Additionally, it is enabled on SSL connections,
cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2664 for unbuffered proxying,
cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2665 and for <link doc="websocket.xml">WebSocket</link> proxying.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2666 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2667
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2668 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2669
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2670
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2671 <directive name="tcp_nopush">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2672 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2673 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2674 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2675 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2676 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2677
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2678 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2679 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 the <c-def>TCP_NOPUSH</c-def> socket option on FreeBSD
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2681 or the <c-def>TCP_CORK</c-def> socket option on Linux.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2682 The options are enabled only when <link id="sendfile"/> is used.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2683 Enabling the option allows
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2684 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2685
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2686 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2687 sending the response header and the beginning of a file in one packet,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2688 on Linux and FreeBSD 4.*;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2689 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2690
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2691 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2692 sending a file in full packets.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2693 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2694
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2695 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2696 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2697
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2698 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2699
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2700
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2701 <directive name="try_files">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2702 <syntax><value>file</value> ... <value>uri</value></syntax>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2703 <syntax><value>file</value> ... =<value>code</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2704 <default/>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2705 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2706 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2707
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2708 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2709 Checks the existence of files in the specified order and uses
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2710 the first found file for request processing; the processing
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2711 is performed in the current context.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2712 The path to a file is constructed from the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2713 <value>file</value> parameter
174 69c131b0ebe0 Rephrased a sentence about "try_files" so that "alias" isn't called a prefix. Ruslan Ermilov <ru@nginx.com> parents: 173 diff changeset	2714 according to the
69c131b0ebe0 Rephrased a sentence about "try_files" so that "alias" isn't called a prefix. Ruslan Ermilov <ru@nginx.com> parents: 173 diff changeset	2715 <link id="root"/> and <link id="alias"/> directives.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2716 It is possible to check directory’s existence by specifying
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2717 a slash at the end of a name, e.g. “<literal>$uri/</literal>”.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2718 If none of the files were found, an internal redirect to the
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2719 <value>uri</value> specified in the last parameter is made.
173 6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2720 For example:
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2721 <example>
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2722 location /images/ {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2723 try_files $uri /images/default.gif;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2724 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2725
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2726 location = /images/default.gif {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2727 expires 30s;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2728 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2729 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2730 The last parameter can also point to a named location,
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2731 as shown in examples below.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2732 Starting from version 0.7.51, the last parameter can also be a
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2733 <value>code</value>:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2734 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2735 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2736 try_files $uri $uri/index.html $uri.html =404;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2737 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2738 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2739 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2740
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2741 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2742 Example in proxying Mongrel:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2743 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2744 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2745 try_files /system/maintenance.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2746 $uri $uri/index.html $uri.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2747 @mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2748 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2749
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2750 location @mongrel {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2751 proxy_pass http://mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2752 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2753 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2754 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2755
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2756 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2757 Example for Drupal/FastCGI:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2758 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2759 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2760 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2761 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2762
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2763 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2764 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2765
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2766 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2767
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2768 fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2769 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2770 fastcgi_param QUERY_STRING $args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2771
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2772 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2773 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2774
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2775 location @drupal {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2776 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2777
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2778 fastcgi_param SCRIPT_FILENAME /path/to/index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2779 fastcgi_param SCRIPT_NAME /index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2780 fastcgi_param QUERY_STRING q=$uri&$args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2781
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2782 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2783 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2784 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2785 In the following example,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2786 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2787 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2788 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2789 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2790 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2791 the <literal>try_files</literal> directive is equivalent to
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2792 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2793 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2794 error_page 404 = @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2795 log_not_found off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2796 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2797 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2798 And here,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2799 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2800 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2801 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2802
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2803 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2804
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2805 fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2806
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2807 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2808 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2809 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2810 <literal>try_files</literal> checks the existence of the PHP file
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2811 before passing the request to the FastCGI server.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2812 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2813
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2814 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2815 Example for Wordpress and Joomla:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2816 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2817 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2818 try_files $uri $uri/ @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2819 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2820
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2821 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2822 try_files $uri @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2823
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2824 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2825
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2826 fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2827 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2828 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2829
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2830 location @wordpress {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2831 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2832
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2833 fastcgi_param SCRIPT_FILENAME /path/to/index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2834 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2835 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2836 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2837 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2838
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2839 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2840
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2841
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2842 <directive name="types">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2843 <syntax block="yes"/>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2844 <default>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2845 text/html html;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2846 image/gif gif;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2847 image/jpeg jpg;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2848 </default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2849 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2850 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2851 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2852
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2853 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2854 Maps file name extensions to MIME types of responses.
160 0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2855 Extensions are case-insensitive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2856 Several extensions can be mapped to one type, for example:
160 0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2857 <example>
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2858 types {
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2859 application/octet-stream bin exe dll;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2860 application/octet-stream deb;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2861 application/octet-stream dmg;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2862 }
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2863 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2864 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2865
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2866 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2867 A sufficiently full mapping table is distributed with nginx in the
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	2868 <path>conf/mime.types</path> file.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2869 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2870
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2871 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2872 To make a particular location emit the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2873 “<literal>application/octet-stream</literal>”
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2874 MIME type for all requests, the following configuration can be used:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2875 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2876 location /download/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2877 types { }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2878 default_type application/octet-stream;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2879 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2880 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2881 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2882
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2883 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2884
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2885
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2886 <directive name="types_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2887 <syntax><value>size</value></syntax>
1132 8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2888 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2889 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2890 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2891 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2892
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2893 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2894 Sets the bucket size for the types hash tables.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2895 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2896 <link doc="../hash.xml">document</link>.
1132 8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2897 <note>
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2898 Prior to version 1.5.13,
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2899 the default value depended on the size of the processor’s cache line.
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2900 </note>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2901 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2902
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2903 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2904
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2905
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2906 <directive name="types_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2907 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2908 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2909 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2910 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2911 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2912
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2913 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2914 Sets the maximum <value>size</value> of the types hash tables.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2915 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2916 <link doc="../hash.xml">document</link>.
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2917 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2918
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2919 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2920
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2921
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2922 <directive name="underscores_in_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2923 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2924 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2925 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2926 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2927
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2928 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2929 Enables or disables the use of underscores in client request header fields.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2930 When the use of underscores is disabled, request header fields whose names
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2931 contain underscores are
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2932 marked as invalid and become subject to the
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2933 <link id="ignore_invalid_headers"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2934 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2935
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2936 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	2937 If the directive is specified on the <link id="server"/> level,
375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	2938 its value is only used if a server is a default one.
375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	2939 The value specified also applies to all virtual servers
442 b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	2940 listening on the same address and port.
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2941 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2942
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2943 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2944
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2945
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2946 <directive name="variables_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2947 <syntax><value>size</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2948 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2949 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2950
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2951 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2952 Sets the bucket size for the variables hash table.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2953 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2954 <link doc="../hash.xml">document</link>.
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2955 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2956
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2957 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2958
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2959
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2960 <directive name="variables_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2961 <syntax><value>size</value></syntax>
1108 a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	2962 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2963 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2964
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2965 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2966 Sets the maximum <value>size</value> of the variables hash table.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2967 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2968 <link doc="../hash.xml">document</link>.
1108 a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	2969 <note>
a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	2970 Prior to version 1.5.13, the default value was 512.
a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	2971 </note>
1110 4a4fe2d79d14 a0543e9213e7 nit fixed: "note" block moved inside "para". Maxim Konovalov <maxim@nginx.com> parents: 1108 diff changeset	2972 </para>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2973
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2974 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2975
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2976 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2977
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2978
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2979 <section id="variables" name="Embedded Variables">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2980
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2981 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2982 The <literal>ngx_http_core_module</literal> module supports embedded variables
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2983 with names matching the Apache Server variables.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2984 First of all, these are variables representing client request header
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2985 fields, such as <var>$http_user_agent</var>, <var>$http_cookie</var>,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2986 and so on.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2987 Also there are other variables:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2988 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2989
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2990 <tag-name id="var_arg_"><var>$arg_</var><value>name</value></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2991 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2992 argument <value>name</value> in the request line
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2993 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2994
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2995 <tag-name id="var_args"><var>$args</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2996 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2997 arguments in the request line
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2998 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2999
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3000 <tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3001 <tag-desc>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3002 client address in a binary form, value’s length is always 4 bytes
1699 6c96a644b0b3 Corrected description of $binary_remote_addr and saved state. Yaroslav Zhuravlev <yar@nginx.com> parents: 1692 diff changeset	3003 for IPv4 addresses or 16 bytes for IPv6 addresses
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3004 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3005
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3006 <tag-name id="var_body_bytes_sent"><var>$body_bytes_sent</var></tag-name>
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3007 <tag-desc>
769 d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3008 number of bytes sent to a client, not counting the response header;
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3009 this variable is compatible with the “<literal>%B</literal>” parameter of the
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3010 <literal>mod_log_config</literal>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3011 Apache module
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3012 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3013
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3014 <tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3015 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3016 number of bytes sent to a client (1.3.8, 1.2.5)
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3017 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3018
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3019 <tag-name id="var_connection"><var>$connection</var></tag-name>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3020 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3021 connection serial number (1.3.8, 1.2.5)
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3022 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3023
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3024 <tag-name id="var_connection_requests"><var>$connection_requests</var></tag-name>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3025 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3026 current number of requests made through a connection (1.3.8, 1.2.5)
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3027 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3028
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3029 <tag-name id="var_content_length"><var>$content_length</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3030 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3031 <header>Content-Length</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3032 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3033
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3034 <tag-name id="var_content_type"><var>$content_type</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3035 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3036 <header>Content-Type</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3037 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3038
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3039 <tag-name id="var_cookie_"><var>$cookie_</var><value>name</value></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3040 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3041 the <value>name</value> cookie
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3042 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3043
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3044 <tag-name id="var_document_root"><var>$document_root</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3045 <tag-desc>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3046 <link id="root"/> or <link id="alias"/> directive’s value
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	3047 for the current request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3048 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3049
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3050 <tag-name id="var_document_uri"><var>$document_uri</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3051 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3052 same as <var>$uri</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3053 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3054
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3055 <tag-name id="var_host"><var>$host</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3056 <tag-desc>
940 ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3057 in this order of precedence:
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3058 host name from the request line, or
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3059 host name from the <header>Host</header> request header field, or
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3060 the server name matching a request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3061 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3062
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3063 <tag-name id="var_hostname"><var>$hostname</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3064 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3065 host name
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3066 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3067
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3068 <tag-name id="var_http_"><var>$http_</var><value>name</value></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3069 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3070 arbitrary request header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3071 the last part of a variable name is the field name converted
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3072 to lower case with dashes replaced by underscores
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3073 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3074
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3075 <tag-name id="var_https"><var>$https</var></tag-name>
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3076 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3077 “<literal>on</literal>”
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3078 if connection operates in SSL mode,
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3079 or an empty string otherwise
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3080 </tag-desc>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3081
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3082 <tag-name id="var_is_args"><var>$is_args</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3083 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3084 “<literal>?</literal>” if a request line has arguments,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3085 or an empty string otherwise
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3086 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3087
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3088 <tag-name id="var_limit_rate"><var>$limit_rate</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3089 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3090 setting this variable enables response rate limiting;
767 1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	3091 see <link id="limit_rate"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3092 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3093
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3094 <tag-name id="var_msec"><var>$msec</var></tag-name>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3095 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3096 current time in seconds with the milliseconds resolution (1.3.9, 1.2.6)
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3097 </tag-desc>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3098
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3099 <tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3100 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3101 nginx version
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3102 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3103
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3104 <tag-name id="var_pid"><var>$pid</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3105 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3106 PID of the worker process
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3107 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3108
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3109 <tag-name id="var_pipe"><var>$pipe</var></tag-name>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3110 <tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3111 “<literal>p</literal>” if request was pipelined, “<literal>.</literal>”
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3112 otherwise (1.3.12, 1.2.7)
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3113 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3114
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3115 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3116 <tag-desc>
2457 3896055c397e Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	3117 client address from the PROXY protocol header (1.5.12)
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3118 <para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3119 The PROXY protocol must be previously enabled by setting the
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3120 <literal>proxy_protocol</literal> parameter
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3121 in the <link id="listen"/> directive.
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3122 </para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3123 </tag-desc>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3124
1704 792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3125 <tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3126 <tag-desc>
2457 3896055c397e Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	3127 client port from the PROXY protocol header (1.11.0)
1704 792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3128 <para>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3129 The PROXY protocol must be previously enabled by setting the
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3130 <literal>proxy_protocol</literal> parameter
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3131 in the <link id="listen"/> directive.
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3132 </para>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3133 </tag-desc>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3134
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3135 <tag-name id="var_query_string"><var>$query_string</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3136 <tag-desc>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3137 same as <var>$args</var>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3138 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3139
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3140 <tag-name id="var_realpath_root"><var>$realpath_root</var></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3141 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	3142 an absolute pathname corresponding to the
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3143 <link id="root"/> or <link id="alias"/> directive’s value
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	3144 for the current request,
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	3145 with all symbolic links resolved to real paths
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3146 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3147
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3148 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3149 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3150 client address
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3151 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3152
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3153 <tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3154 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3155 client port
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3156 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3157
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3158 <tag-name id="var_remote_user"><var>$remote_user</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3159 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3160 user name supplied with the Basic authentication
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3161 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3162
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3163 <tag-name id="var_request"><var>$request</var></tag-name>
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3164 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3165 full original request line
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3166 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3167
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3168 <tag-name id="var_request_body"><var>$request_body</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3169 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3170 request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3171 <para>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3172 The variable’s value is made available in locations
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3173 processed by the
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3174 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>,
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3175 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3176 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3177 and
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3178 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>
1732 5eb54b170c74 Clarified cases when $request_body is not empty. Yaroslav Zhuravlev <yar@nginx.com> parents: 1721 diff changeset	3179 directives when the request body was read to
5eb54b170c74 Clarified cases when $request_body is not empty. Yaroslav Zhuravlev <yar@nginx.com> parents: 1721 diff changeset	3180 a <link id="client_body_buffer_size">memory buffer</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3181 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3182 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3183
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3184 <tag-name id="var_request_body_file"><var>$request_body_file</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3185 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3186 name of a temporary file with the request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3187 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3188 At the end of processing, the file needs to be removed.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3189 To always write the request body to a file,
406 98dac2bd7598 Links with mixed underscores and spaces were hard to read, eliminated them. Ruslan Ermilov <ru@nginx.com> parents: 400 diff changeset	3190 <link id="client_body_in_file_only"/> needs to be enabled.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3191 When the name of a temporary file is passed in a proxied request
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3192 or in a request to a FastCGI/uwsgi/SCGI server,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3193 passing the request body should be disabled by the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3194 <link doc="ngx_http_proxy_module.xml" id="proxy_pass_request_body">
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3195 proxy_pass_request_body off</link>,
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3196 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass_request_body">
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3197 fastcgi_pass_request_body off</link>,
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3198 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass_request_body">
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3199 uwsgi_pass_request_body off</link>, or
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3200 <link doc="ngx_http_scgi_module.xml" id="scgi_pass_request_body">
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3201 scgi_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3202 directives, respectively.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3203 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3204 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3205
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3206 <tag-name id="var_request_completion"><var>$request_completion</var></tag-name>
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3207 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3208 “<literal>OK</literal>” if a request has completed,
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3209 or an empty string otherwise
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3210 </tag-desc>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3211
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3212 <tag-name id="var_request_filename"><var>$request_filename</var></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3213 <tag-desc>
530 d8c7160527ae query -> request Ruslan Ermilov <ru@nginx.com> parents: 527 diff changeset	3214 file path for the current request, based on the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3215 <link id="root"/> or <link id="alias"/>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3216 directives, and the request URI
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3217 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3218
1692 4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3219 <tag-name id="var_request_id"><var>$request_id</var></tag-name>
4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3220 <tag-desc>
1721 737c86e8b316 Clarified meaning of the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1704 diff changeset	3221 unique request identifier
737c86e8b316 Clarified meaning of the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1704 diff changeset	3222 generated from 16 random bytes, in hexadecimal (1.11.0)
1692 4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3223 </tag-desc>
4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3224
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3225 <tag-name id="var_request_length"><var>$request_length</var></tag-name>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3226 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3227 request length (including request line, header, and request body)
9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3228 (1.3.12, 1.2.7)
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3229 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3230
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3231 <tag-name id="var_request_method"><var>$request_method</var></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3232 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3233 request method, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3234 “<literal>GET</literal>” or “<literal>POST</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3235 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3236
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3237 <tag-name id="var_request_time"><var>$request_time</var></tag-name>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3238 <tag-desc>
779 32b8498cfb40 $msec and $request_time have become generic variables in 1.2.6. Ruslan Ermilov <ru@nginx.com> parents: 771 diff changeset	3239 request processing time in seconds with a milliseconds resolution
32b8498cfb40 $msec and $request_time have become generic variables in 1.2.6. Ruslan Ermilov <ru@nginx.com> parents: 771 diff changeset	3240 (1.3.9, 1.2.6);
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3241 time elapsed since the first bytes were read from the client
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3242 </tag-desc>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3243
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3244 <tag-name id="var_request_uri"><var>$request_uri</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3245 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3246 full original request URI (with arguments)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3247 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3248
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3249 <tag-name id="var_scheme"><var>$scheme</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3250 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3251 request scheme, “<literal>http</literal>” or “<literal>https</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3252 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3253
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3254 <tag-name id="var_sent_http_"><var>$sent_http_</var><value>name</value></tag-name>
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3255 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3256 arbitrary response header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3257 the last part of a variable name is the field name converted
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3258 to lower case with dashes replaced by underscores
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3259 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3260
2003 be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3261 <tag-name id="var_sent_trailer_"><var>$sent_trailer_</var><value>name</value></tag-name>
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3262 <tag-desc>
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3263 arbitrary field sent at the end of the response (1.13.2);
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3264 the last part of a variable name is the field name converted
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3265 to lower case with dashes replaced by underscores
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3266 </tag-desc>
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3267
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3268 <tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3269 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3270 an address of the server which accepted a request
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3271 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3272 Computing a value of this variable usually requires one system call.
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	3273 To avoid a system call, the <link id="listen"/> directives
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3274 must specify addresses and use the <literal>bind</literal> parameter.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3275 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3276 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3277
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3278 <tag-name id="var_server_name"><var>$server_name</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3279 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3280 name of the server which accepted a request
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3281 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3282
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3283 <tag-name id="var_server_port"><var>$server_port</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3284 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3285 port of the server which accepted a request
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3286 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3287
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3288 <tag-name id="var_server_protocol"><var>$server_protocol</var></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3289 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3290 request protocol, usually
1597 8b97ba73129b Added HTTP/2.0 to the "server_protocol" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1576 diff changeset	3291 “<literal>HTTP/1.0</literal>”,
1614 1bab8e5f53c6 Added Oxford comma to "$server_protocol". Yaroslav Zhuravlev <yar@nginx.com> parents: 1597 diff changeset	3292 “<literal>HTTP/1.1</literal>”,
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3293 or
1597 8b97ba73129b Added HTTP/2.0 to the "server_protocol" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1576 diff changeset	3294 “<link doc="ngx_http_v2_module.xml">HTTP/2.0</link>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3295 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3296
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3297 <tag-name id="var_status"><var>$status</var></tag-name>
541 a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3298 <tag-desc>
769 d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3299 response status (1.3.2, 1.2.2)
541 a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3300 </tag-desc>
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3301
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3302 <tag-name id="var_tcpinfo_">
453 98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3303 <var>$tcpinfo_rtt</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3304 <var>$tcpinfo_rttvar</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3305 <var>$tcpinfo_snd_cwnd</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3306 <var>$tcpinfo_rcv_space</var>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3307 </tag-name>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3308 <tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3309 information about the client TCP connection; available on systems
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3310 that support the <c-def>TCP_INFO</c-def> socket option
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3311 </tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3312
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3313 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3314 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3315 local time in the ISO 8601 standard format (1.3.12, 1.2.7)
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3316 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3317
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3318 <tag-name id="var_time_local"><var>$time_local</var></tag-name>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3319 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3320 local time in the Common Log Format (1.3.12, 1.2.7)
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3321 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3322
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3323 <tag-name id="var_uri"><var>$uri</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3324 <tag-desc>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3325 current URI in request, <link id="location">normalized</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3326 <para>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3327 The value of <var>$uri</var> may change during request processing,
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3328 e.g. when doing internal redirects, or when using index files.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3329 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3330 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3331
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3332 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3333 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3334
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3335 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3336
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3337 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_core_module.xml @ 2457:3896055c397e