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

annotate xml/en/docs/http/ngx_http_core_module.xml @ 1561:ed420c318557

Updated docs for the upcoming NGINX Plus release.

author	Ruslan Ermilov <ru@nginx.com>
date	Thu, 10 Sep 2015 15:50:32 +0300
parents	88d1a1d36c0c
children	695999bdd4a5

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"
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	13 rev="46">
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
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	17 <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	18 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	19 <literal>on</literal> \|
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	20 <literal>off</literal> \|
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	21 <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	22 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	26 <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	27
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 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	30 on FreeBSD and Linux:
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	31 <example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	32 location /video/ {
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	33 aio on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	34 output_buffers 1 64k;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	35 }
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	36 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	40 On FreeBSD, AIO can be used starting from FreeBSD 4.3.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 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	42 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 options VFS_AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 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	46 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 kldload aio
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	51 <!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53 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	54 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	55 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	56 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	57 FreeBSD 7.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 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	59 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	60 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	61 after the kernel has booted.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 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	63 <path>/var/log/messages</path>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 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	66 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	67 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 and can safely be ignored.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 <note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 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	71 fact that FreeBSD supports asynchronous calls
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72 <c-func>aio_read</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 <c-func>aio_write</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 when working with sockets.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	76 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	77 </note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 </para>
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	79 -->
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	82 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	83 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	84 <link id="directio"/>,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	85 or otherwise reading will be blocking:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 directio 512;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 output_buffers 1 128k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 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	97 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 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	99 boundaries (or 4K for XFS).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	100 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	101 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	102 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	103 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	104 </para>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	105
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	106 <para>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	107 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	108 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	109 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	110 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	111 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	112 <example>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	113 location /video/ {
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	114 sendfile on;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	115 aio on;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	116 directio 8m;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	117 }
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	118 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	121 <para>
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	122 Finally, files can be read and <link id="sendfile">sent</link>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	123 using multi-threading (1.7.11),
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	124 without blocking a worker process:
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	125 <example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	126 location /video/ {
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	127 sendfile on;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	128 aio threads;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	129 }
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	130 </example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	131 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	132 <link doc="../ngx_core_module.xml" id="thread_pool">pool</link>.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	133 If the pool name is omitted,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	134 the pool with the name “<literal>default</literal>” is used.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	135 The pool name can also be set with variables:
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	136 <example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	137 aio threads=pool$disk;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	138 </example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	139 By default, multi-threading is disabled, it should be
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	140 enabled with the
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	141 <literal>--with-threads</literal> configuration parameter.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	142 Currently, multi-threading is compatible only with the
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	143 <link doc="../events.xml" id="epoll"/>,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	144 <link doc="../events.xml" id="kqueue"/>,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	145 and
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	146 <link doc="../events.xml" id="eventport"/> methods.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	147 Multi-threaded sending of files is only supported on Linux.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	148 </para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	149
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	150 <para>
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	151 See also the <link id="sendfile"/> directive.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	152 </para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	153
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 <directive name="alias">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	158 <syntax><value>path</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 Defines a replacement for the specified location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	170 on request of
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	171 “<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	172 <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	173 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	176 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	177 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	178 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	181 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	182 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	183 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	184 these captures (0.7.40), for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 location ~ ^/users/(.+\.(?:gif\|jpe?g\|png))$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 alias /data/w3/images/$1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 <para>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	193 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	194 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 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	200 <link id="root"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201 directive instead:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	212 <directive name="chunked_transfer_encoding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	213 <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	214 <default>on</default>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	215 <context>http</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	216 <context>server</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	217 <context>location</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	218
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	219 <para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	220 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	221 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	222 chunked encoding despite the standard’s requirement.
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	223 </para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	224
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	225 </directive>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	226
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	227
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	228 <directive name="client_body_buffer_size">
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	229
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	230 <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	231 <default>8k\|16k</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	232 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	233 <context>server</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	234 <context>location</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	235
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	236 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	237 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	238 In case the request body is larger than the buffer,
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	239 the whole body or only its part is written to a
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	240 <link id="client_body_temp_path">temporary file</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	241 By default, buffer size is equal to two memory pages.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	242 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	243 It is usually 16K on other 64-bit platforms.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	244 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	245
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	246 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	247
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	248
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 <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	250 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	251 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	252 <literal>clean</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	253 <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	254 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	257 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 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	261 into a file.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 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	263 <var>$request_body_file</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 variable, or the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <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	266 method of the module
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 <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	268 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	271 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	272 removed after request processing.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	276 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	277 left after request processing to be removed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 <directive name="client_body_in_single_buffer">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	284 <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	285 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 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	292 in a single buffer.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 The directive is recommended when using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 <var>$request_body</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 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	296 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 <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	302 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	303 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	304 [<value>level1</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	305 [<value>level2</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	306 [<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	307 <default>client_body_temp</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 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	314 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	315 directory.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 For example, in the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 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	319 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	320 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	321 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 /spool/nginx/client_temp/7/45/00000123457
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 <directive name="client_body_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	330 <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	331 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335
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 Defines a timeout for reading client request body.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	338 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	339 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	340 If a client does not transmit anything within this time, the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 <http-status code="408" text="Request Time-out"/>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	342 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	344
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 <directive name="client_header_buffer_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	349 <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	350 <default>1k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 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	356 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	357 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	358 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	359 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	360 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	361 <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	362 are allocated.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366
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 <directive name="client_header_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	369 <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	370 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 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	376 If a client does not transmit the entire header within this time, the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 <http-status code="408" text="Request Time-out"/>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	378 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 <directive name="client_max_body_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	385 <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	386 <default>1m</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	388 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	389 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	391 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 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	393 specified in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394 <header>Content-Length</header>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	395 request header field.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	396 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	397 <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	398 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399 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	400 <!--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	401 this error<!--/link-->.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	402 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	403 request body size.
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
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	409 <directive name="connection_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	410 <syntax><value>size</value></syntax>
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	411 <default>256</default>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	412 <context>http</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	413 <context>server</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	414
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	415 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	416 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	417 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	418 and should not generally be used.
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	419 </para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	420
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	421 </directive>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	422
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	423
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 <directive name="default_type">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	425 <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	426 <default>text/plain</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	428 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	429 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	432 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	433 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	434 with the <link id="types"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	437 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	440 <directive name="directio">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	441 <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	442 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	446 <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	447
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	449 Enables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450 the <c-def>O_DIRECT</c-def> flag (FreeBSD, Linux),
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 the <c-def>F_NOCACHE</c-def> flag (Mac OS X),
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 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	453 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	454 the specified <value>size</value>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	455 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	456 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 for a given request.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	458 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	459 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 directio 4m;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461 </example>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	462 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	463 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	468 <directive name="directio_alignment">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	469 <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	470 <default>512</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	474 <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	475
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	477 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	478 <link id="directio"/>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	479 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	480 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	481 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	482
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	486 <directive name="disable_symlinks">
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	487 <syntax><literal>off</literal></syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	488 <syntax>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	489 <literal>on</literal> \|
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	490 <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	491 [<literal>from</literal>=<value>part</value>]</syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	492 <default>off</default>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	493 <context>http</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	494 <context>server</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	495 <context>location</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	496 <appeared-in>1.1.15</appeared-in>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	497
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	498 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	499 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	500 <list type="tag">
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	501
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	502 <tag-name><literal>off</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	503 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	504 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	505 This is the default behavior.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	506 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	507
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	508 <tag-name><literal>on</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	509 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	510 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	511 access to a file is denied.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	512 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	513
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	514 <tag-name><literal>if_not_owner</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	515 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	516 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	517 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	518 points to have different owners.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	519 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	520
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	521 <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	522 <tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	523 When checking symbolic links
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	524 (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	525 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	526 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	527 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	528 <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	529 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	530 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	531 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	532 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	533 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	534 symbolic links are not checked.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	535 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	536 </tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	537
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	538 </list>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	539 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	540
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	541 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	542 Example:
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	543 <example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	544 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	545 </example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	546 </para>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	547
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	548 <para>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	549 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	550 <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	551 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	552 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	553
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	554 <para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	555 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	556 add a processing overhead.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	557 <note>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	558 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	559 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	560 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	561 </note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	562 </para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	563
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	564 <para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	565 <note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	566 The
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	567 <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	568 <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	569 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	570 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	571 </note>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	572 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	573
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	574 </directive>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	575
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	576
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	577 <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	578 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	579 <value>code</value> ...
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	580 [<literal>=</literal>[<value>response</value>]]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	581 <value>uri</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	582 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	583 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	584 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	585 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	586 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	587
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	588 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	589 Defines the URI that will be shown for the specified errors.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	590 <literal>error_page</literal> directives are inherited from the previous
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	591 level only if there are no <literal>error_page</literal>
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	592 directives defined on the current level.
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	593 A <literal>uri</literal> value can contain variables.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	594 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	595
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	596 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	597 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	598 <example>
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	599 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	600 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	601 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	602 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	603
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	604 <para>
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	605 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	606 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	607 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	608 error_page 404 =200 /empty.gif;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	609 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	610 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	611
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	612 <para>
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	613 If an error response is processed by a proxied server
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	614 or a FastCGI/uwsgi/SCGI server,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	615 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	616 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	617 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	618 error_page 404 = /404.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	619 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	620 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	621
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	622 <para>
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	623 It is also possible to use redirects for error processing:
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	624 <example>
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	625 error_page 403 http://example.com/forbidden.html;
1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	626 error_page 404 =301 http://example.com/notfound.html;
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	627 </example>
871 96839d165b8a Clarify the description of error_page example. Sergey Kandaurov <pluknet@nginx.com> parents: 869 diff changeset	628 In this case, by default, the response code 302 is returned to the client.
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	629 It can only be changed to one of the redirect status
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	630 codes (301, 302, 303, and 307).
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	631 </para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	632
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	633 <para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	634 If there is no need to change URI during internal redirection it is
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	635 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	636 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	637 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	638 error_page 404 = @fallback;
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	641 location @fallback {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	642 proxy_pass http://backend;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	643 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	644 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	645 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	646
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	647 <para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	648 <note>
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	649 If <literal>uri</literal> processing leads to an error,
747 ddec437b692b Fixed a number of typos. Vladimir Homutov <vl@nginx.com> parents: 741 diff changeset	650 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	651 </note>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	652 </para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	653
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	654 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656
576 cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	657 <directive name="etag">
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	658 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	659 <default>on</default>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	660 <context>http</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	661 <context>server</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	662 <context>location</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	663 <appeared-in>1.3.3</appeared-in>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	664
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	665 <para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	666 Enables or disables automatic generation of the <header>ETag</header>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	667 response header field for static resources.
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	668 </para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	669
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	670 </directive>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	671
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	672
651 eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	673 <directive name="http">
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	674 <syntax block="yes"/>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	675 <default/>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	676 <context>main</context>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	677
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	678 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	679 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	680 are specified.
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	681 </para>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	682
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	683 </directive>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	684
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	685
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	686 <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	687 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	688 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	689 <literal>exact</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	690 <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	691 <default>exact</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	692 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	693 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	694 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	695 <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	696
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	697 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	698 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	699 with the time in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	700 <header>If-Modified-Since</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	701 request header field:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	702
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	703 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	704
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	705 <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	706 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	707 the
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	708 <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	709 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	710
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	711 <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	712 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	713 exact match;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	714 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	715
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	716 <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	717 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718 modification time of a response is
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 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	720 request header field.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	721 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	722
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	723 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	724 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	725
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	726 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	727
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	728
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	729 <directive name="ignore_invalid_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	730 <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	731 <default>on</default>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	732 <context>http</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	733 <context>server</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	734
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	735 <para>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	736 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	737 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	738 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	739 directive).
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	740 </para>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	741
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	742 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	743 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	744 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	745 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	746 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	747 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	748
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	749 </directive>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	750
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	751
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	752 <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	753 <syntax/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	754 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	755 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	756
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	757 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	758 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	759 For external requests, the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	760 <http-status code="404" text="Not Found"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	761 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 Internal requests are the following:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	763
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766 <listitem>
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	767 requests redirected by the
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	768 <link id="error_page"/>,
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	769 <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	770 <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	771 <link id="try_files"/> directives;
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	772 </listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	773
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	774 <listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	775 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	776 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	777 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	778
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	779 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780 subrequests formed by the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	781 “<command>include virtual</command>”
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	782 command of the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	783 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	784 module and by the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	785 <link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	786 module directives;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	787 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	788
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790 requests changed by the
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	791 <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	792 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	793
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	794 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	796
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	797 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	798 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	802 location /404.html {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	803 internal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	804 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 </example>
674 c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	806 <note>
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	807 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	808 request processing cycles that can occur in incorrect configurations.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	809 If this limit is reached, the error
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	810 <http-status code="500" text="Internal Server Error"/> is returned.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	811 In such cases, the “rewrite or internal redirection cycle” message
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	812 can be seen in the error log.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	813 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	814 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	815
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	816 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	817
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	818
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	819 <directive name="keepalive_disable">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	820 <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	821 <default>msie6</default>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	822 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	823 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	824 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	825
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	826 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	827 Disables keep-alive connections with misbehaving browsers.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	828 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	829 browsers will be affected.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	830 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	831 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	832 The value <literal>safari</literal> disables keep-alive connections
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	833 with Safari and Safari-like browsers on Mac OS X and Mac OS X-like
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	834 operating systems.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	835 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	836 with all browsers.
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	837 <note>
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	838 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	839 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	840 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	841 </note>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	842 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	843
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	844 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	845
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	846
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	847 <directive name="keepalive_requests">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	848 <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	849 <default>100</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	850 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	851 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	852 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	853 <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	854
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 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	857 served through one keep-alive connection.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	858 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	859 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862
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 <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	865 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	866 <value>timeout</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	867 [<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	868 <default>75s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	869 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	870 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	872
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	873 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	874 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	875 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	876 The zero value disables keep-alive client connections.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	877 The optional second parameter sets a value in the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	878 <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	879 response header field.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	880 Two parameters may differ.
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	884 The
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	885 <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	886 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	887 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	888 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	889
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	890 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	891
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	892
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	893 <directive name="large_client_header_buffers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	894 <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	895 <default>4 8k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	896 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	897 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	898
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	899 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	900 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	901 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	902 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	903 <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	904 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905 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	906 <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	907 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	908 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	909 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	910 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	911 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	912 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	913
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	914 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	915
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	916
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 <directive name="limit_except">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	918 <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	919 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	920 <context>location</context>
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 Limits allowed HTTP methods inside a location.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	924 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	925 <literal>GET</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	926 <literal>HEAD</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	927 <literal>POST</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	928 <literal>PUT</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	929 <literal>DELETE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	930 <literal>MKCOL</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	931 <literal>COPY</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	932 <literal>MOVE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	933 <literal>OPTIONS</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	934 <literal>PROPFIND</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	935 <literal>PROPPATCH</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	936 <literal>LOCK</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	937 <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	938 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	939 <literal>PATCH</literal>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	940 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	941 <literal>HEAD</literal> method also allowed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	942 Access to other methods can be limited using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	943 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	944 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	945 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	946 modules directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	947 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	948 limit_except GET {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	949 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	950 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	951 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	952 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	953 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	954 <emphasis>except</emphasis> GET and HEAD.
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	959
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960 <directive name="limit_rate">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	961 <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	962 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	963 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	964 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	966 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	968 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	969 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	970 The <value>rate</value> is specified in bytes per second.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	971 The zero value disables rate limiting.
57 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 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	974 -->
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	975 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	976 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	977 as the specified limit.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	978 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 <para>
767 1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	981 Rate limit can also be set in the <var>$limit_rate</var> variable.
1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	982 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	983 depending on a certain condition:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	985 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	987 if ($slow) {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 set $limit_rate 4k;
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 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	992 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	993 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	994 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	996 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	997 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	998 <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	999 This capability can be disabled using the
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1000 <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	1001 <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	1002 <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	1003 and
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1004 <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	1005 directives.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1006 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1007
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1008 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1009
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1010
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	1011 <directive name="limit_rate_after">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1012 <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	1013 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1014 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1015 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1016 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1017 <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	1018 <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	1019
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1020 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1021 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	1022 of a response to a client will be rate limited.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1023 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1024
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1025 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1026 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1027 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1028 location /flv/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1029 flv;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1030 limit_rate_after 500k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1031 limit_rate 50k;
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1034 </para>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1037
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1038
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1039 <directive name="lingering_close">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1040 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1041 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1042 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1043 <literal>always</literal></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1044 <default>on</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1045 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1046 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1047 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1048 <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	1049 <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	1050
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1051 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1052 Controls how nginx closes client connections.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1053 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1054
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1055 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1056 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	1057 <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	1058 <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	1059 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	1060 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	1061 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1062
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1063 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1064 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	1065 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	1066 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1067
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1068 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1069 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	1070 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	1071 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	1072 circumstances.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1073 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1074
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1075 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1076
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1077
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1078 <directive name="lingering_time">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1079 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1080 <default>30s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1081 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1082 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1083 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1084
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1085 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1086 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	1087 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	1088 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	1089 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	1090 more data.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1091 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1092
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1093 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1094
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1095
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1096 <directive name="lingering_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1097 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1098 <default>5s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1099 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1100 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1101 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1102
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1103 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1104 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	1105 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	1106 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	1107 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	1108 for more data again.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1109 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	1110 <link id="lingering_time"/> directive.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1111 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1112
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1113 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1114
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1115
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 <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	1117 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1118 <value>address</value>[:<value>port</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1119 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1120 [<literal>ssl</literal>]
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1121 [<literal>spdy</literal> \| <literal>http2</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1122 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1123 [<literal>setfib</literal>=<value>number</value>]
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1124 [<literal>fastopen</literal>=<value>number</value>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1125 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1126 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1127 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1128 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1129 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1130 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1131 [<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	1132 [<literal>reuseport</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1133 [<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	1134 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1135 <value>port</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1136 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1137 [<literal>ssl</literal>]
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1138 [<literal>spdy</literal> \| <literal>http2</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1139 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1140 [<literal>setfib</literal>=<value>number</value>]
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1141 [<literal>fastopen</literal>=<value>number</value>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1142 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1143 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1144 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1145 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1146 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1147 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1148 [<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	1149 [<literal>reuseport</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1150 [<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	1151 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1152 <literal>unix:</literal><value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1153 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1154 [<literal>ssl</literal>]
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1155 [<literal>spdy</literal> \| <literal>http2</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1156 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1157 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1158 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1159 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1160 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1161 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1162 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1163 [<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	1164 <default>:80 \| :8000</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1166
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1167 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1168 Sets the <value>address</value> and <value>port</value> for IP,
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1169 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	1170 the server will accept requests.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1171 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	1172 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	1173 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	1174 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1175 listen 127.0.0.1:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1176 listen 127.0.0.1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177 listen 8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 listen *:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179 listen localhost:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1180 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1181 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	1182 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1183 listen [::]:8000;
941 7d1d53d4d293 Removed link-scoped IPv6 addresses from examples. Ruslan Ermilov <ru@nginx.com> parents: 940 diff changeset	1184 listen [::1];
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1185 </example>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1186 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	1187 prefix:
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1188 <example>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1189 listen unix:/var/run/nginx.sock;
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1190 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1191 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1192
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1194 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	1195 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1196
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1197 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1198 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	1199 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	1200 otherwise.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1201 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1202
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1203 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1204 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	1205 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	1206 <value>address</value>:<value>port</value> pair.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1207 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	1208 parameter then the first server with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1209 <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	1210 the default server for this pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1211 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1212 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	1213 <literal>default</literal>.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1214 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1215 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1216
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1217 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1218 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	1219 connections accepted on this port should work in SSL mode.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1220 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	1221 id="single_http_https_server">configuration</link> for the server that
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1222 handles both HTTP and HTTPS requests.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1223 </para>
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1224
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1225 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1226 The <literal>spdy</literal> parameter (1.3.15) allows accepting
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1227 <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	1228 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	1229 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	1230 connections without SSL.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1231 </para>
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1232
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1233 <para>
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1234 The <literal>http2</literal> parameter configures the port to accept
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1235 HTTP/2 connections.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1236 Normally, for this to work the <literal>ssl</literal> parameter should be
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1237 specified as well, but nginx can also be configured to accept HTTP/2
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1238 connections without SSL.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1239 <note>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1240 The <literal>http2</literal> parameter is only available in the
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1241 <literal>nginx-plus-http2</literal> package (NGINX Plus release 7).
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1242 Since HTTP/2 supersedes SPDY, the <literal>nginx-plus-http2</literal>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1243 package does not support the <literal>spdy</literal> parameter.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1244 </note>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1245 </para>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1246
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1513 diff changeset	1247 <para>
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1248 The <literal>proxy_protocol</literal> parameter (1.5.12)
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1249 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	1250 <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	1251 protocol</link>.
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1252 </para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1253
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1254 <para>
1414 5addfab7e171 Corrected article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1279 diff changeset	1255 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	1256 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	1257 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	1258 <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	1259 <value>address</value>:<value>port</value> pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1260 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1261 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	1262 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	1263 <literal>default</literal> parameter.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1264 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1265 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1266
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1267 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1268 <literal>setfib</literal>=<value>number</value>
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1269 </tag-name>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1270 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1271 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	1272 (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	1273 This currently works only on FreeBSD.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1274 </tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1275
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1276 <tag-name>
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1277 <literal>fastopen</literal>=<value>number</value>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1278 </tag-name>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1279 <tag-desc>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1280 enables
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1281 “<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	1282 for the listening socket (1.5.8) and
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1283 <link url="http://tools.ietf.org/html/draft-ietf-tcpm-fastopen#section-5.1">limits</link>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1284 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	1285 the three-way handshake.
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1286 <note>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1287 Do not enable this feature unless the server can handle
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1288 receiving the
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1289 <link url="http://tools.ietf.org/html/draft-ietf-tcpm-fastopen#section-6.1">
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1290 same SYN packet with data</link> more than once.
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1291 </note>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1292 </tag-desc>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1293
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1294 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1295 <literal>backlog</literal>=<value>number</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1298 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	1299 <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	1300 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	1301 By default,
40425063b413 Fixed the default "listen backlog" value on DragonFly BSD. Ruslan Ermilov <ru@nginx.com> parents: 1500 diff changeset	1302 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and Mac OS X,
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1303 and to 511 on other platforms.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1304 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1306 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1307 <literal>rcvbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1309 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1310 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	1311 (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	1312 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1313
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1314 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1315 <literal>sndbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1316 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1317 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1318 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	1319 (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	1320 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1321
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1322 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1323 <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	1324 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1325 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1326 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	1327 (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	1328 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	1329 <c-func>accept</c-func>.
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1330 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	1331 Possible values are
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1332 <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	1333 and
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1334 <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	1335 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1336
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1337 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1338 <literal>deferred</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1339 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1340 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1341 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	1342 (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	1343 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1344
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1345 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1346 <literal>bind</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1348 <tag-desc>
240 472e88bf177e Slightly better wording for the "bind" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 237 diff changeset	1349 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	1350 <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	1351 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	1352 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	1353 <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	1354 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	1355 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	1356 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	1357 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	1358 If the <literal>setfib</literal>,
e9c485d6cc0c Documented that "listen setfib=" implies "bind". Ruslan Ermilov <ru@nginx.com> parents: 1031 diff changeset	1359 <literal>backlog</literal>, <literal>rcvbuf</literal>,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1360 <literal>sndbuf</literal>, <literal>accept_filter</literal>,
1279 7261e621dd4a Documented that "listen ipv6only=" implies "bind". Maxim Dounin <mdounin@mdounin.ru> parents: 1257 diff changeset	1361 <literal>deferred</literal>, <literal>ipv6only</literal>,
7261e621dd4a Documented that "listen ipv6only=" implies "bind". Maxim Dounin <mdounin@mdounin.ru> parents: 1257 diff changeset	1362 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	1363 are used then for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1364 <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	1365 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	1366 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1367
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1368 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1369 <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	1370 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1371 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1372 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	1373 (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	1374 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	1375 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	1376 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	1377 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	1378 <note>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1379 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	1380 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	1381 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	1382 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1383 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1384
1507 14180fa9a518 Added ids for reuseport, mentioned reuseport in news. Yaroslav Zhuravlev <yar@nginx.com> parents: 1501 diff changeset	1385 <tag-name id="reuseport">
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1386 <literal>reuseport</literal>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1387 </tag-name>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1388 <tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1389 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	1390 for each worker process
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1391 (using the <c-def>SO_REUSEPORT</c-def> socket option), allowing a kernel
1496 99ce48c8cce3 Corrected the "reuseport" description of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1493 diff changeset	1392 to distribute incoming connections between worker processes.
1500 cd534da03d02 Added Linux kernel version in reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 1496 diff changeset	1393 This currently works only on Linux 3.9+ and DragonFly BSD.
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1394 <note>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1395 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	1396 <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	1397 </note>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1398 </tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1399
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1400 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1401 <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	1402 </tag-name>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1403 <tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1404 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	1405 for the listening socket.
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1406 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	1407 in effect for the socket.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1408 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	1409 <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	1410 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	1411 <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	1412 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	1413 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	1414 <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	1415 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	1416 FreeBSD 9.0-STABLE), they can be configured
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1417 using the <value>keepidle</value>, <value>keepintvl</value>, and
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1418 <value>keepcnt</value> parameters.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1419 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	1420 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	1421 For example,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1422 <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	1423 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	1424 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	1425 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	1426 </tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1427
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1429 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1430
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1431 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1432 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433 <example>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1434 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	1435 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1436 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1437
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1438 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1439
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1440
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1441 <directive name="location">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	1442 <syntax block="yes">[
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1443 <literal>=</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1444 <literal>~</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1445 <literal>~*</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1446 <literal>^~</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1447 ] <value>uri</value></syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1448 <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	1449 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1450 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1451 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1452
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1453 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1454 Sets configuration depending on a request URI.
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1455 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1456
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1457 <para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1458 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	1459 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	1460 resolving references to relative path components “<literal>.</literal>”
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1461 and “<literal>..</literal>”, and possible
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1462 <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	1463 adjacent slashes into a single slash.
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1464 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1465
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1466 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1467 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	1468 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	1469 “<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	1470 “<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	1471 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	1472 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	1473 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	1474 prefix is selected and remembered.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1475 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	1476 in the configuration file.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1477 The search of regular expressions terminates on the first match,
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1478 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	1479 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	1480 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	1481 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1482
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1483 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1484 <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	1485 mentioned below.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1486 </para>
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1487
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1488 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1489 For case-insensitive operating systems such as Mac OS X and Cygwin,
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1490 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	1491 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	1492 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1493
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1494 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1495 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	1496 be used in other directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1498
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1499 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1500 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	1501 then regular expressions are not checked.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1502 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1503
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1504 <para>
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1505 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	1506 an exact match of URI and location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507 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	1508 For example, if a “<literal>/</literal>” request happens frequently,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1509 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	1510 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	1511 comparison.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1512 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	1513 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1514
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1515 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1516 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1517 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	1518 location without the “<literal>=</literal>” and “<literal>^~</literal>”
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1519 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	1520 not checked.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1521 </note>
57 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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1524 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1525 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	1526 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1527 location = / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1528 [ configuration A ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 }
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 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1532 [ configuration B ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1533 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1534
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1535 location /documents/ {
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1536 [ configuration C ]
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1537 }
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1538
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1539 location ^~ /images/ {
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1540 [ configuration D ]
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1541 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1542
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1543 location ~* \.(gif\|jpg\|jpeg)$ {
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1544 [ configuration E ]
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1545 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1546 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1547 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	1548 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	1549 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	1550 configuration C,
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1551 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	1552 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	1553 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1554
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1555 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1556 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	1557 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	1558 used for request redirection.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1559 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	1560 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1561
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1562 <para>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1563 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	1564 and requests are processed by one of
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1565 <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	1566 <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	1567 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>,
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1568 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>, or
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1569 <link doc="ngx_http_memcached_module.xml" id="memcached_pass"/>,
1257 ac7a5ee98768 Split long sentence into two. Ruslan Ermilov <ru@nginx.com> parents: 1194 diff changeset	1570 then the special processing is performed.
ac7a5ee98768 Split long sentence into two. Ruslan Ermilov <ru@nginx.com> parents: 1194 diff changeset	1571 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	1572 but without the trailing slash,
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1573 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	1574 with the slash appended.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1575 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	1576 defined like this:
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1577 <example>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1578 location /user/ {
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1579 proxy_pass http://user.example.com;
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1580 }
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1581
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1582 location = /user {
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1583 proxy_pass http://login.example.com;
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1584 }
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1585 </example>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1586 </para>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1587
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1588 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1589 <migration from="Apache" directive="Location" />
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1590 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1591
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1592 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1593
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 <directive name="log_not_found">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1596 <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	1597 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1598 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1599 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1600 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1601
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1602 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1603 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	1604 <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	1605 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1606
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1607 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1608
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1609
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1610 <directive name="log_subrequest">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1611 <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	1612 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1613 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1614 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1615 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1616
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1617 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1618 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	1619 <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	1620 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1623
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1624
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1625 <directive name="max_ranges">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1626 <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	1627 <default/>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1628 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1629 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1630 <context>location</context>
499 76a8eca844d0 Documented that "max_ranges" appeared in 1.1.2. Ruslan Ermilov <ru@nginx.com> parents: 477 diff changeset	1631 <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	1632
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1633 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1634 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	1635 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	1636 byte ranges specified.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1637 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	1638 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	1639 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1640
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1641 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1642
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1643
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1644 <directive name="merge_slashes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1645 <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	1646 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1647 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1648 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1649
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1650 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1651 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	1652 in a URI into a single slash.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1653 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1654
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1655 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1656 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	1657 and regular expression locations.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1658 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	1659 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1660 location /scripts/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1661 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1662 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1663 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1664 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	1665 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	1666 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1667
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1668 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1669 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	1670 contains base64-encoded names, since base64 uses the “<literal>/</literal>”
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1671 character internally.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1672 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	1673 the compression off.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1674 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1675
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1676 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	1677 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	1678 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	1679 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	1680 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	1681 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1684
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 <directive name="msie_padding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1687 <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	1688 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1689 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1690 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1691 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1692
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1693 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1694 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	1695 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	1696 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1697
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1698 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1699
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 <directive name="msie_refresh">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1702 <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	1703 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1704 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1705 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1706 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1707
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1708 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1709 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	1710 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1711
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1712 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1715 <directive name="open_file_cache">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1716 <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	1717 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1718 <literal>max</literal>=<value>N</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1719 [<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	1720 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1721 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1722 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1723 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1724
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1725 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1726 Configures a cache that can store:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1727 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1728
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1729 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1730 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	1731 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1732
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1733 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1734 information on existence of directories;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1735 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1736
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1737 <listitem>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1738 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	1739 and so on.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1740 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1741 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	1742 <link id="open_file_cache_errors"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1743 directive.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1744 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1745 </listitem>
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 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1748 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1749
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1750 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1751 The directive has the following parameters:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1752 <list type="tag">
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 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1755 <literal>max</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1756 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1757 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1758 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	1759 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	1760 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1761
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1762 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1763 <literal>inactive</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1764 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1765 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1766 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	1767 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	1768 by default, it is 60 seconds;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1769 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1770
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1771 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1772 <literal>off</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1773 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1774 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1775 disables the cache.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1776 </tag-desc>
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 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1779 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1780
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1781 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1782 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1783 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1784 open_file_cache max=1000 inactive=20s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1785 open_file_cache_valid 30s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1786 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	1787 open_file_cache_errors on;<!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1788 open_file_cache_events on;
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1791 </para>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1794
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1795
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1796 <directive name="open_file_cache_errors">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1797 <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	1798 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1799 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1800 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1801 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1802
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1803 <para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1804 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	1805 <link id="open_file_cache"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1806 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1807
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1808 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1809
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1810
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1811 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1812
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1813 <directive name="open_file_cache_events">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1814 <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	1815 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1816 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1817 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1818 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1819
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1820 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1821 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	1822 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1823 elements.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1824 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	1825 <link doc="../events.xml" id="kqueue"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1826 method only.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1827 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	1828 support events for arbitrary file system types.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1829 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	1830 file systems such as UFS or FFS.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1831 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1832
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1833 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1834
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1835 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1836
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1837
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1838 <directive name="open_file_cache_min_uses">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1839 <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	1840 <default>1</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1841 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1842 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1843 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1844
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1845 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1846 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	1847 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	1848 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	1849 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	1850 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1851
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1852 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1855 <directive name="open_file_cache_valid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1856 <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	1857 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1858 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1859 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1860 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1861
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1862 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1863 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	1864 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1865 elements should be validated.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1866 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867 When
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1868 <link id="open_file_cache_events"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1869 is enabled, open file descriptors
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1870 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	1871 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1872 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1873
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1874 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1875
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1876
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1877 <directive name="output_buffers">
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1878 <syntax><value>number</value> <value>size</value></syntax>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1879 <default>1 32k</default>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1880 <context>http</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1881 <context>server</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1882 <context>location</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1883
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1884 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	1885 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	1886 buffers used for reading a response from a disk.
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1887 </para>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1888
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1889 </directive>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1890
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	1891
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1892 <directive name="port_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1893 <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	1894 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1895 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1896 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1897 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1898
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1899 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1900 Enables or disables specifying the port in redirects issued by nginx.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1901 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1902
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1903 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1904 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	1905 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	1906 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1907
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1908 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1909
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1910
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1911 <directive name="postpone_output">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1912 <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	1913 <default>1460</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1914 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1915 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1916 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1917
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1918 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1919 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	1920 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	1921 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	1922 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1923
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1924 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1925
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1926
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 <directive name="read_ahead">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1928 <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	1929 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1930 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1931 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1932 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1933
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1934 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1935 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	1936 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1937
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1938 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1939 On Linux, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1940 <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	1941 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	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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1945 On FreeBSD, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1946 <literal>fcntl(O_READAHEAD,</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1947 <value>size</value><literal>)</literal>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1948 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	1949 FreeBSD 7 has to be
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1950 <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	1951 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1952
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1953 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1954
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1956 <directive name="recursive_error_pages">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1957 <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	1958 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1959 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1960 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1961 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1962
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1963 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1964 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	1965 <link id="error_page"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1966 directive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1967 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	1968 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1969
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1970 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1971
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1972
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1973 <directive name="request_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1974 <syntax><value>size</value></syntax>
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1975 <default>4k</default>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1976 <context>http</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1977 <context>server</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1978
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1979 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1980 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	1981 This directive has minimal impact on performance
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1982 and should not generally be used.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1983 </para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1984
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1985 </directive>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1986
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1987
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1988 <directive name="reset_timedout_connection">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1989 <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	1990 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1993 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1995 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1996 Enables or disables resetting timed out connections.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1997 The reset is performed as follows.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1998 Before closing a socket, the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1999 <c-def>SO_LINGER</c-def>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2000 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	2001 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	2002 occupied by this socket is released.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2003 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	2004 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	2005 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2006
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2007 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2008 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	2009 closed normally.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2010 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2011
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2012 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2013
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2014
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2015 <directive name="resolver">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2016 <syntax>
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2017 <value>address</value> ...
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2018 [<literal>valid</literal>=<value>time</value>]
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2019 [<literal>ipv6</literal>=<literal>on</literal>\|<literal>off</literal>]</syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2020 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2021 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2022 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2023 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2024
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2025 <para>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2026 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	2027 into addresses, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2028 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2029 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	2030 </example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2031 An address can be specified as a domain name or IP address,
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	2032 and 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	2033 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	2034 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	2035 <note>
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	2036 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	2037 Specifying name servers using IPv6 addresses is supported
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	2038 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	2039 </note>
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2040 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	2041 If looking up of IPv6 addresses is not desired,
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2042 the <literal>ipv6=off</literal> parameter can be specified.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2043 <note>
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2044 Resolving of names into IPv6 addresses is supported
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2045 starting from version 1.5.8.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2046 </note>
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2047 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	2048 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	2049 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2050 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	2051 </example>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2052 <note>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2053 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	2054 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	2055 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2056 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2057
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2058 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2059
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2060
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2061 <directive name="resolver_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2062 <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	2063 <default>30s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2064 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2065 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2066 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2069 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	2070 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2071 resolver_timeout 5s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2072 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2073 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2074
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2075 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2076
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2077
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2078 <directive name="root">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2079 <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	2080 <default>html</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2081 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2082 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2083 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2085
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2086 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2087 Sets the root directory for requests.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2088 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2089 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2090 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2091 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2092 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2093 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2094 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	2095 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	2096 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2097
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2098 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2099 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	2100 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	2101 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2102
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2103 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 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	2105 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	2106 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	2107 <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	2108 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2109
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2110 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2111
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 <directive name="satisfy">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2114 <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	2115 <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	2116 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	2117 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2118 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2119
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2120 <para>
971 6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2121 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	2122 (<literal>any</literal>) of the
971 6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2123 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>,
6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2124 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link> or
6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2125 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2126 modules allow access.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2127 </para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2128
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2129 <para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2130 Example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2131 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2132 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2133 satisfy any;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2134
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2135 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2137
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2138 auth_basic "closed site";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2139 auth_basic_user_file conf/htpasswd;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2140 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2141 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2142 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2143
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2144 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2145
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2146
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2147 <directive name="send_lowat">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2148 <syntax><value>size</value></syntax>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2149 <default>0</default>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2150 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2151 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2152 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2153
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2154 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2155 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	2156 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	2157 <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	2158 <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	2159 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	2160 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	2161 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2162
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2163 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2164 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	2165 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2166
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2167 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2168
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2169
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2170 <directive name="send_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2171 <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	2172 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2173 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2174 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2175 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2176
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2177 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178 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	2179 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	2180 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	2181 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	2182 the connection is closed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2183 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2184
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2185 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2186
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 <directive name="sendfile">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2190 <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	2191 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2192 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2193 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2194 <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	2195 <context>if in location</context>
57 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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2198 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2199 <c-func>sendfile</c-func>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2200 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2201
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2202 <para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2203 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	2204 <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	2205 for <c-func>sendfile</c-func>:
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2206 <example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2207 location /video/ {
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2208 sendfile on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2209 tcp_nopush on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2210 aio on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2211 }
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2212 </example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2213 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	2214 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	2215 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	2216 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	2217 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	2218 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	2219 This can be changed using the
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2220 <link id="read_ahead"/> directive.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2221 <note>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2222 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	2223 <literal>aio sendfile;</literal>.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2224 </note>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2225 </para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2226
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2227 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2228
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2229
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2230 <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	2231
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2232 <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	2233 <default>0</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2234 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2235 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2236 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2237
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2238 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2239 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	2240 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	2241 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	2242 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2243
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2244 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2245
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2246
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2247 <directive name="server">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2248 <syntax block="yes"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2249 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2250 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2251
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2252 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2253 Sets configuration for a virtual server.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2254 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	2255 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	2256 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	2257 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	2258 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	2259 <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	2260 Example configurations are provided in the
ef11546f75ee Translated "request_processing" into Russian, removed "virtual_hosts" Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	2261 “<link doc="request_processing.xml"/>” document.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2262 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2263
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2264 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2267 <directive name="server_name">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2268 <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	2269 <default>""</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2270 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2271
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2272 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2273 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	2274 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2275 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2276 server_name example.com www.example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2277 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2278 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2279 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2280
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2281 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2282 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	2283 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2284
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2285 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2286 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	2287 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	2288 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2289 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2290 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	2291 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2292 </example>
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2293 Such names are called wildcard names.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2294 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2295
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2296 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2297 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	2298 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2299 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2300 server_name .example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2301 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2302 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2303 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2304
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 It is also possible to use regular expressions in server names,
1101 ebe027a963f4 Typo fixed. Andrei Belov <defan@nginx.com> parents: 1097 diff changeset	2307 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	2308 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2309 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2310 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	2311 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2312 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2313 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2314
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2315 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2316 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	2317 be used in other directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2318 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2319 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2320 server_name ~^(www\.)?(.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2321
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2322 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2323 root /sites/$2;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2324 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2325 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2326
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2327 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2328 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2329
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2330 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2331 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2332 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2333 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2334 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2335 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2336
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2337 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2338 Named captures in regular expressions create variables (0.8.25)
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2339 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	2340 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2341 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2342 server_name ~^(www\.)?(?<domain>.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2343
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2344 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2345 root /sites/$domain;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2346 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2347 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2348
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2349 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2350 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2351
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2352 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2353 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2354 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2355 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2356 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2357 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2358
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2359 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2360 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	2361 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	2362 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2363
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2364 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2365 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	2366 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2367 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2368 server_name www.example.com "";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2369 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2370 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2371 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	2372 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	2373 This is the default setting.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2374 <note>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2375 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	2376 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2377 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2378
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2379 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2380 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	2381 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	2382 (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	2383 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	2384 <list type="enum">
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 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2387 the exact name
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2388 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2389
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2390 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2391 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	2392 e.g. “<literal>*.example.com</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2393 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2394
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2395 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2396 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	2397 e.g. “<literal>mail.*</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2398 </listitem>
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 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2401 the first matching regular expression
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2402 (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	2403 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2404
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2405 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2406 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2407
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2408 <para>
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2409 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	2410 <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	2411 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2412
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2413 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2414
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2415
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2416 <directive name="server_name_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2417 <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	2418 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2419 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2420 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2421 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2422
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2423 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2424 Enables or disables the use of the primary server name, specified 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	2425 <link id="server_name"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2426 directive, in redirects issued by nginx.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2427 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	2428 <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	2429 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	2430 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2431
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2432 <para>
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2433 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	2434 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	2435 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2436
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2437 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2438
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2439
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2440 <directive name="server_names_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2441 <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	2442 <default>32\|64\|128</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2443 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2444
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2445 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2446 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	2447 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	2448 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	2449 <link doc="../hash.xml">document</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2450 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2453
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2454
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2455 <directive name="server_names_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2456 <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	2457 <default>512</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2458 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2459
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2460 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2461 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	2462 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	2463 <link doc="../hash.xml">document</link>.
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2464 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2465
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2466 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2467
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2468
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2469 <directive name="server_tokens">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2470 <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	2471 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2472 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2473 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2474 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2475
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2476 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2477 Enables or disables emitting nginx version in error messages and in the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2478 <header>Server</header> response header field.
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2482
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2483
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2484 <directive name="tcp_nodelay">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2485 <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	2486 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2487 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2488 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2489 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2490
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2491 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2492 Enables or disables the use of the <c-def>TCP_NODELAY</c-def> option.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2493 The option is enabled only when a connection is transitioned into the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2494 keep-alive state.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2495 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2496
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2497 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2498
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2499
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2500 <directive name="tcp_nopush">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2501 <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	2502 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2503 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2504 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2505 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2506
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2507 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2508 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2509 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	2510 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	2511 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	2512 Enabling the option allows
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2513 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2514
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2515 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2516 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	2517 on Linux and FreeBSD 4.*;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2518 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2519
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2520 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2521 sending a file in full packets.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2522 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2523
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2524 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2525 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2529
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2530 <directive name="try_files">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2531 <syntax><value>file</value> ... <value>uri</value></syntax>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2532 <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	2533 <default/>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2534 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2535 <context>location</context>
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 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2538 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	2539 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	2540 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	2541 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	2542 <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	2543 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	2544 <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	2545 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	2546 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	2547 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	2548 <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	2549 For example:
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2550 <example>
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2551 location /images/ {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2552 try_files $uri /images/default.gif;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2553 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2554
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2555 location = /images/default.gif {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2556 expires 30s;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2557 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2558 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2559 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	2560 as shown in examples below.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2561 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	2562 <value>code</value>:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2563 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2564 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2565 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	2566 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2567 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2568 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2569
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2570 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2571 Example in proxying Mongrel:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2572 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2573 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2574 try_files /system/maintenance.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2575 $uri $uri/index.html $uri.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2576 @mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2577 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2578
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2579 location @mongrel {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2580 proxy_pass http://mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2581 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2582 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2583 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2584
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2585 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2586 Example for Drupal/FastCGI:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2587 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2588 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2589 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2590 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2591
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2592 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2593 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2594
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2595 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2596
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2597 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	2598 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2599 fastcgi_param QUERY_STRING $args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2600
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2601 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2602 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2603
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2604 location @drupal {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2605 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2606
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2607 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	2608 fastcgi_param SCRIPT_NAME /index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2609 fastcgi_param QUERY_STRING q=$uri&$args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2610
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2611 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2612 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2613 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2614 In the following example,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2615 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2616 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2617 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2618 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2619 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2620 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	2621 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2622 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2623 error_page 404 = @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2624 log_not_found off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2625 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2626 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2627 And here,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2628 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2629 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2630 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2631
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2632 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2633
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2634 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	2635
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2636 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2637 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2638 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2639 <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	2640 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	2641 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2642
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2643 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2644 Example for Wordpress and Joomla:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2645 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2646 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2647 try_files $uri $uri/ @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2648 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2649
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2650 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2651 try_files $uri @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2652
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2653 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2654
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2655 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	2656 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2657 }
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 location @wordpress {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2660 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2661
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2662 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	2663 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2664 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2665 </example>
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="types">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2672 <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	2673 <default>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2674 text/html html;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2675 image/gif gif;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2676 image/jpeg jpg;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2677 </default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2678 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2679 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2681
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2682 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2683 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	2684 Extensions are case-insensitive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2685 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	2686 <example>
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2687 types {
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2688 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	2689 application/octet-stream deb;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2690 application/octet-stream dmg;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2691 }
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2692 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2693 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2696 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	2697 <path>conf/mime.types</path> file.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2698 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2701 To make a particular location emit the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2702 “<literal>application/octet-stream</literal>”
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2703 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	2704 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2705 location /download/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2706 types { }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2707 default_type application/octet-stream;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2708 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2709 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2710 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2711
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2712 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2713
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2714
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2715 <directive name="types_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2716 <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	2717 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2718 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2719 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2720 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2721
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2722 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2723 Sets the bucket size for the types hash tables.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2724 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	2725 <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	2726 <note>
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2727 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	2728 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	2729 </note>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2730 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2731
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2732 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2733
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2734
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2735 <directive name="types_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2736 <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	2737 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2738 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2739 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2740 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2741
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2742 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2743 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	2744 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	2745 <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	2746 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2747
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2748 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2749
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2750
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2751 <directive name="underscores_in_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2752 <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	2753 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2754 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2755 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2756
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2757 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2758 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	2759 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	2760 contain underscores are
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2761 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	2762 <link id="ignore_invalid_headers"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2763 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2764
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2765 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	2766 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	2767 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	2768 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	2769 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	2770 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2771
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2772 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2773
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2774
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2775 <directive name="variables_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2776 <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	2777 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2778 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2779
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2780 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2781 Sets the bucket size for the variables hash table.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2782 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	2783 <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	2784 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2785
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2786 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2787
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2788
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2789 <directive name="variables_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2790 <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	2791 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2792 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2793
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2794 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2795 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	2796 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	2797 <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	2798 <note>
a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	2799 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	2800 </note>
1110 4a4fe2d79d14 a0543e9213e7 nit fixed: "note" block moved inside "para". Maxim Konovalov <maxim@nginx.com> parents: 1108 diff changeset	2801 </para>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2802
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2803 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2804
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2805 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2806
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2807
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2808 <section id="variables" name="Embedded Variables">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2809
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2810 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2811 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	2812 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	2813 First of all, these are variables representing client request header
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2814 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	2815 and so on.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2816 Also there are other variables:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2817 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2818
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2819 <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	2820 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2821 argument <value>name</value> in the request line
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2822 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2823
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2824 <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	2825 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2826 arguments in the request line
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2827 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2828
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2829 <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	2830 <tag-desc>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2831 client address in a binary form, value’s length is always 4 bytes
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2832 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2833
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2834 <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	2835 <tag-desc>
769 d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2836 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	2837 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	2838 <literal>mod_log_config</literal>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2839 Apache module
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2840 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2841
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2842 <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	2843 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2844 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	2845 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2846
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2847 <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	2848 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2849 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	2850 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2851
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2852 <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	2853 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	2854 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	2855 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2856
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2857 <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	2858 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2859 <header>Content-Length</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2860 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2861
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2862 <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	2863 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2864 <header>Content-Type</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2865 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2866
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2867 <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	2868 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2869 the <value>name</value> cookie
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2870 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2871
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2872 <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	2873 <tag-desc>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2874 <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	2875 for the current request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2876 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2877
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2878 <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	2879 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2880 same as <var>$uri</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2881 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2882
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2883 <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	2884 <tag-desc>
940 ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	2885 in this order of precedence:
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	2886 host name from the request line, or
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	2887 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	2888 the server name matching a request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2889 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2890
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2891 <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	2892 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2893 host name
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2894 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2895
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2896 <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	2897 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2898 arbitrary request header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2899 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	2900 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	2901 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2902
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2903 <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	2904 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2905 “<literal>on</literal>”
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2906 if connection operates in SSL mode,
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2907 or an empty string otherwise
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2908 </tag-desc>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2909
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2910 <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	2911 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2912 “<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	2913 or an empty string otherwise
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2914 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2915
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2916 <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	2917 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2918 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	2919 see <link id="limit_rate"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2920 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2921
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	2922 <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	2923 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2924 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	2925 </tag-desc>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	2926
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2927 <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	2928 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2929 nginx version
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2930 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2931
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2932 <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	2933 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2934 PID of the worker process
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2935 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2936
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	2937 <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	2938 <tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	2939 “<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	2940 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	2941 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	2942
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2943 <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	2944 <tag-desc>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2945 client address from the PROXY protocol header, or an empty string otherwise
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2946 (1.5.12)
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2947 <para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2948 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	2949 <literal>proxy_protocol</literal> parameter
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2950 in the <link id="listen"/> directive.
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2951 </para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2952 </tag-desc>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	2953
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2954 <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	2955 <tag-desc>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2956 same as <var>$args</var>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2957 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2958
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2959 <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	2960 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2961 an absolute pathname corresponding to the
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2962 <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	2963 for the current request,
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2964 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	2965 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2966
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2967 <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	2968 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2969 client address
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2970 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2971
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2972 <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	2973 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2974 client port
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2975 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2976
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2977 <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	2978 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2979 user name supplied with the Basic authentication
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2980 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2981
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2982 <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	2983 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2984 full original request line
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2985 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2986
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	2987 <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	2988 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2989 request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2990 <para>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2991 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	2992 processed by the
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	2993 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>,
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	2994 <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	2995 <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	2996 and
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	2997 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2998 directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2999 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3000 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3001
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3002 <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	3003 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3004 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	3005 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3006 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	3007 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	3008 <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	3009 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	3010 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	3011 passing the request body should be disabled by the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3012 <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	3013 proxy_pass_request_body off</link>,
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3014 <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	3015 fastcgi_pass_request_body off</link>,
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3016 <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	3017 uwsgi_pass_request_body off</link>, or
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3018 <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	3019 scgi_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3020 directives, respectively.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3021 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3022 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3023
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3024 <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	3025 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3026 “<literal>OK</literal>” if a request has completed,
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3027 or an empty string otherwise
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3028 </tag-desc>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3029
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3030 <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	3031 <tag-desc>
530 d8c7160527ae query -> request Ruslan Ermilov <ru@nginx.com> parents: 527 diff changeset	3032 file path for the current request, based on the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3033 <link id="root"/> or <link id="alias"/>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3034 directives, and the request URI
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3035 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3036
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3037 <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	3038 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3039 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	3040 (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	3041 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3042
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3043 <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	3044 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3045 request method, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3046 “<literal>GET</literal>” or “<literal>POST</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3047 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3048
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3049 <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	3050 <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	3051 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	3052 (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	3053 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	3054 </tag-desc>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3055
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3056 <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	3057 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3058 full original request URI (with arguments)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3059 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3060
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3061 <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	3062 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3063 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	3064 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3065
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3066 <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	3067 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3068 arbitrary response header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3069 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	3070 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	3071 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3072
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3073 <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	3074 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3075 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	3076 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3077 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	3078 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	3079 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	3080 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3081 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3082
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3083 <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	3084 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3085 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	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_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	3089 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3090 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	3091 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3092
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3093 <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	3094 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3095 request protocol, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3096 “<literal>HTTP/1.0</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3097 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3098 “<literal>HTTP/1.1</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3099 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3100
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3101 <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	3102 <tag-desc>
769 d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3103 response status (1.3.2, 1.2.2)
541 a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3104 </tag-desc>
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3105
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3106 <tag-name id="var_tcpinfo_">
453 98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3107 <var>$tcpinfo_rtt</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3108 <var>$tcpinfo_rttvar</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3109 <var>$tcpinfo_snd_cwnd</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3110 <var>$tcpinfo_rcv_space</var>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3111 </tag-name>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3112 <tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3113 information about the client TCP connection; available on systems
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3114 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	3115 </tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3116
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3117 <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	3118 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3119 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	3120 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3121
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3122 <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	3123 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3124 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	3125 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3126
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3127 <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	3128 <tag-desc>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3129 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	3130 <para>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3131 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	3132 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	3133 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3134 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3135
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3136 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3137 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3138
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3139 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3140
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3141 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_core_module.xml @ 1561:ed420c318557