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

annotate xml/en/docs/http/ngx_http_core_module.xml @ 406:98dac2bd7598

Links with mixed underscores and spaces were hard to read, eliminated them.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 13 Feb 2012 11:09:13 +0000
parents	eb993ee8c230
children	2638f67205ee

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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4
89 f451dc5c5c82 Module names corrected. Ruslan Ermilov <ru@nginx.com> parents: 88 diff changeset	5 <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	6 link="/en/docs/http/ngx_http_core_module.html"
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 lang="en">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <section id="directives" name="Directives">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	11 <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	12 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	13 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	14 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	15 <literal>sendfile</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	16 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	20 <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	21
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 Enables or disables the use of asynchronous file I/O (AIO)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 on FreeBSD and Linux.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 On FreeBSD, AIO is usable starting from FreeBSD 4.3.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 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	30 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 options VFS_AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 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	34 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 kldload aio
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 </example>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 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	41 when booting the kernel, will cause the entire networking subsystem
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 to use the Giant lock that can impact overall performance negatively.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 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	44 FreeBSD 7.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 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	46 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	47 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	48 after the kernel has booted.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 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	50 <path>/var/log/messages</path>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 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	53 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	54 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 and can safely be ignored.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 <note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 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	58 fact that FreeBSD supports asynchronous calls
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 <c-func>aio_read</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 <c-func>aio_write</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 when working with sockets.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 However, since nginx only uses AIO for disk I/O, no problems should arise.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 </note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 For AIO to work,
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	69 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 needs to be disabled:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 sendfile off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 output_buffers 1 64k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 In addition, starting from FreeBSD 5.2.1 and nginx 0.8.12, AIO can
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 also be used to pre-load data for <c-func>sendfile</c-func>:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 sendfile on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 tcp_nopush on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 aio sendfile;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 In this configuration, <c-func>sendfile</c-func> is called with
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 the <c-def>SF_NODISKIO</c-def> flag which causes it not to
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 block on disk I/O and instead report back when the data are not in
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 memory; nginx then initiates an asynchronous data load by reading
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	94 one byte.
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	95 The FreeBSD kernel then loads the first 128K bytes
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 of a file into memory, however next reads will only load data
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	97 in 16K chunks.
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	98 This can be tuned 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	99 <link id="read_ahead"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 directive.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 On Linux, AIO is usable starting from kernel version 2.6.22;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 plus, it is also 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	106 <link id="directio"/>,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 otherwise reading will be blocking:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 directio 512;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 output_buffers 1 128k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 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	119 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 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	121 boundaries (or 4K for XFS).
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122 Reading of unaligned file's end is still made in blocking mode.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 The same holds true for byte range requests, and for FLV requests
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 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	125 beginning and end of a file will be blocking.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 There is no need to turn off
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	127 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 explicitly as it is turned off automatically when
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	129 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 is used.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 <directive name="alias">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	137 <syntax><value>path</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 Defines a replacement for the specified location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 the request of
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	150 “<literal>/i/top.gif</literal>” will be responded
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 with the file
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	152 <path>/data/w3/images/top.gif</path>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	156 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	157 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	158 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	161 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	162 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	163 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	164 these captures (0.7.40), for example:
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 ~ ^/users/(.+\.(?:gif\|jpe?g\|png))$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 alias /data/w3/images/$1;
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 When location matches the last part of the directive's value:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 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	180 <link id="root"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 directive instead:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	192 <directive name="chunked_transfer_encoding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	193 <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	194 <default>on</default>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	195 <context>http</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	196 <context>server</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	197 <context>location</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	198
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	199 <para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	200 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	201 It may come in handy when using a software failing to support
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	202 chunked encoding though the standard requires it.
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	203 </para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	204
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	205 </directive>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	206
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	207
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	208 <directive name="client_body_buffer_size">
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	209
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	210 <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	211 <default>8k\|16k</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	212 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	213 <context>server</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	214 <context>location</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	215
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	216 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	217 Sets buffer size for reading client request body.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	218 In case request body is larger than the buffer,
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	219 the whole body or only its part is written to a
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	220 <link id="client_body_temp_path">temporary file</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	221 By default, buffer size is equal to two memory pages.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	222 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	223 It is usually 16K on other 64-bit platforms.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	224 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	225
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	226 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	227
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	228
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 <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	230 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	231 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	232 <literal>clean</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	233 <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	234 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240 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	241 into a file.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 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	243 <var>$request_body_file</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 variable, or the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 <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	246 method of the module
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 <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	248 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	251 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	252 removed after request processing.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	256 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	257 left after request processing to be removed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 <directive name="client_body_in_single_buffer">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	264 <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	265 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 <context>location</context>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 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	272 in a single buffer.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 The directive is recommended when using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 <var>$request_body</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 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	276 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 <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	282 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	283 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	284 [<value>level1</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	285 [<value>level2</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	286 [<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	287 <default>client_body_temp</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 Defines a directory for storing temporary files holding client request bodies.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 Up to three-level subdirectory hierarchy can be used underneath the specified
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 directory.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 For example, in the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 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	299 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 a temporary file might look like this:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302 /spool/nginx/client_temp/7/45/00000123457
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 <directive name="client_body_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	310 <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	311 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 Defines a timeout for reading client request body.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 A timeout is only set between two successive read operations,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 not for the transmission of the whole request body.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 If a client does not transmit anything within this time,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 <http-status code="408" text="Request Time-out"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 is returned.
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_header_buffer_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	330 <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	331 <default>1k</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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 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	337 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	338 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	339 it may not fit into 1K.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340 If a request line, or a request header field do not fit entirely into
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 this buffer then larger buffers are allocated, configured 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	342 <link id="large_client_header_buffers"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 directive.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	344 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 <directive name="client_header_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	350 <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	351 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356 Defines a timeout for reading client request header.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 If a client does not transmit the entire header within this time,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 <http-status code="408" text="Request Time-out"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 <directive name="client_max_body_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	367 <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	368 <default>1m</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374 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	375 specified in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 <header>Content-Length</header>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 request header field.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378 If it exceeds the configured value, the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 <http-status code="413" text="Request Entity Too Large"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 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	382 <!--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	383 this error<!--/link-->.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	384 Setting <value>size</value> to 0 disables client
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	385 request body size checking.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	388 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	389
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	391 <directive name="connection_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	392 <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	393 <default>256</default>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	394 <context>http</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	395 <context>server</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	396
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	397 <para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	398 Allows to fine tune per-connection memory allocations.
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	399 This directive has minimal impact on performance,
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	400 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	401 </para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	402
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	403 </directive>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	404
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	405
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 <directive name="default_type">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	407 <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	408 <default>text/plain</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	409 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 Defines a default MIME-type of a response.
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	415 See also the <link id="types"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	417
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	418 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	420
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	421 <directive name="directio">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	422 <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	423 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	427 <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	428
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	429 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 Enables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 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	432 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	433 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	434 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	435 the specified <value>size</value>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 It 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	437 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438 for a given request.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 It could be useful for serving large files:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 directio 4m;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 </example>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	443 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	444 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	446 </directive>
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
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	449 <directive name="directio_alignment">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	450 <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	451 <default>512</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	455 <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	456
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 Sets an 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	459 <link id="directio"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 In most cases, a 512-byte alignment is enough, however, when
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461 using XFS under Linux, it needs to be increased to 4K.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465
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 <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	468 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	469 <value>code</value> ...
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	470 [<literal>=</literal>[<value>response</value>]]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	471 <value>uri</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	474 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	479 Defines the URI that will be shown for the specified errors.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480 These directives are inherited from the previous level if and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	481 only if there are no
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	482 <literal>error_page</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483 directives on
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484 the current level.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485 A URI value can contain variables.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	487
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	488 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	489 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	490 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	491 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	492 error_page 502 503 504 /50x.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	493 error_page 403 http://example.com/forbidden.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	495 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	496
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	498 Furthermore, it is possible to change the response code to another, for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	499 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	500 error_page 404 =200 /empty.gif;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	501 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	502 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	503
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	504 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	505 If an error response is processed by a proxied server, or a FastCGI server,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	506 and the server may return different response codes (e.g., 200, 302, 401
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	507 or 404), it is possible to respond with a returned code:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	508 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	509 error_page 404 = /404.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	510 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	511 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	512
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	513 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514 If there is no need to change URI during redirection it is possible to redirect
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	515 error processing into a named location:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	516 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	517 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	518 error_page 404 = @fallback;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	520
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	521 location @fallback {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	522 proxy_pass http://backend;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	523 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	524 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	525 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	526
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	527 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	528
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	529
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	530 <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	531 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	532 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	533 <literal>exact</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	534 <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	535 <default>exact</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	536 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	537 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	538 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	539 <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	540
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	541 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	542 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	543 with the time in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	544 <header>If-Modified-Since</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	545 request header field:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	546
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	547 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	548
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	549 <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	550 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	551 the
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	552 <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	553 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	554
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	555 <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	556 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	557 exact match;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	558 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	559
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	560 <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	561 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	562 modification time of a response is
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	563 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	564 request header field.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	565 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	566
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	567 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	568 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	569
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	570 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	571
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	572
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	573 <directive name="ignore_invalid_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	574 <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	575 <default>on</default>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	576 <context>http</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	577 <context>server</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	578
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	579 <para>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	580 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	581 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	582 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	583 directive).
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	584 </para>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	585
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	586 </directive>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	587
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	588
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	589 <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	590 <syntax/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	591 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	592 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	593
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 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	596 For external requests, the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	597 <http-status code="404" text="Not Found"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	598 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	599 Internal requests are the following:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	600
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	601 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	602
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	603 <listitem>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	604 requests redirected by the <link id="error_page"/> directive;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	605 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	606
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	607 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	608 subrequests formed by the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	609 “<command>include virtual</command>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	610 command of the module
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	611 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	612 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	613
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	614 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	615 requests changed 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	616 <link doc="ngx_http_rewrite_module.xml" id="rewrite"/>
400 eb993ee8c230 Internal requests include those redirected by "X-Accel-Redirect". Ruslan Ermilov <ru@nginx.com> parents: 397 diff changeset	617 directive;
eb993ee8c230 Internal requests include those redirected by "X-Accel-Redirect". Ruslan Ermilov <ru@nginx.com> parents: 397 diff changeset	618 </listitem>
eb993ee8c230 Internal requests include those redirected by "X-Accel-Redirect". Ruslan Ermilov <ru@nginx.com> parents: 397 diff changeset	619
eb993ee8c230 Internal requests include those redirected by "X-Accel-Redirect". Ruslan Ermilov <ru@nginx.com> parents: 397 diff changeset	620 <listitem>
eb993ee8c230 Internal requests include those redirected by "X-Accel-Redirect". Ruslan Ermilov <ru@nginx.com> parents: 397 diff changeset	621 requests redirected by the <header>X-Accel-Redirect</header>
eb993ee8c230 Internal requests include those redirected by "X-Accel-Redirect". Ruslan Ermilov <ru@nginx.com> parents: 397 diff changeset	622 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	623 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	624
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	625 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	626 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	627
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	628 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	629 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	630 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	631 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	632
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	633 location /404.html {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	634 internal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	635 }
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 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	638
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	639 </directive>
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
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	642 <directive name="keepalive_disable">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	643 <syntax><literal>none</literal> \| <value>browser</value> ...</syntax>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	644 <default>msie6 safari</default>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	645 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	646 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	647 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	648
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	649 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	650 Disables keep-alive connections with misbehaving browsers.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	651 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	652 browsers will be affected.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	653 The value <literal>msie6</literal> disables keep-alive connections
252 6f710464be38 Applied nitpicking by Maxim Dounin, translated into English. Ruslan Ermilov <ru@nginx.com> parents: 246 diff changeset	654 with old versions of MSIE, after seeing a POST request.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	655 The value <literal>safari</literal> disables keep-alive connections
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	656 with Safari browsers.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	657 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	658 with all browsers.
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	659 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	660
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	661 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	662
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	663
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	664 <directive name="keepalive_requests">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	665 <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	666 <default>100</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	667 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	668 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	669 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	670 <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	671
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	672 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	673 Sets the maximum number of requests that can be
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	674 made through one keep-alive connection.
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	675 After this many 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	676 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	677
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	679
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	680
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	681 <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	682 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	683 <value>timeout</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	684 [<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	685 <default>75s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	686 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	687 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	688 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	689
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	690 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	691 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	692 client connection will stay open on the server side.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	693 The optional second parameter sets a value in the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	694 <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	695 response header field.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	696 Two parameters may differ.
57 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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	699 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	700 The
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	701 <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	702 header field is understood by Mozilla and Konqueror.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	703 MSIE will close keep-alive connection in about 60 seconds.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	704 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	705
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	706 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	707
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	708
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	709 <directive name="large_client_header_buffers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	710 <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	711 <default>4 8k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	712 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	713 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	714
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	715 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	716 Sets the maximum <value>number</value> and <value>size</value> of
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	717 buffers used when reading large client request header.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718 A request line cannot exceed the size of one buffer, or the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 <http-status code="414" text="Request-URI Too Large"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	720 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	721 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	722 client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	723 <http-status code="400" text="Bad Request"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	724 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	725 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	726 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	727 If after the end of request processing a connection is transitioned
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	728 into the keep-alive state, these buffers are freed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	729 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	730
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	731 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	732
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	733
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	734 <directive name="limit_except">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	735 <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	736 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	737 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	738
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	739 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	740 Limits allowed HTTP methods inside a location.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	741 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	742 <literal>GET</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	743 <literal>HEAD</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	744 <literal>POST</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	745 <literal>PUT</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	746 <literal>DELETE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	747 <literal>MKCOL</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	748 <literal>COPY</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	749 <literal>MOVE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	750 <literal>OPTIONS</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	751 <literal>PROPFIND</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	752 <literal>PROPPATCH</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	753 <literal>LOCK</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	754 <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	755 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	756 <literal>PATCH</literal>.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	757 Allowing the <literal>GET</literal> method also allows the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	758 <literal>HEAD</literal> method.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 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	760 <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	761 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 <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	763 modules directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765 limit_except GET {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	767 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	768 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	769 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	770 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	771 <emphasis>except</emphasis> GET and HEAD.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	772 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	773
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	774 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	775
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	776
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	777 <directive name="limit_rate">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	778 <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	779 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	781 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	782 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	783 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	784
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	785 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	786 Rate limits the transmission of a response to a client.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	787 The <value>rate</value> is specified in bytes per second.
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	788 Value 0 (the default) disables rate limiting.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790 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	791 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	792 The limit is per connection, so if a single client opens 2 connections,
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	793 an overall rate will be 2x more than specified by this directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	794 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	796 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	797 This directive is not applicable if one wants to rate limit
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	798 a group of clients on the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	799 <link id="server"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800 level.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801 If that is the case, the desired limit can be specified in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	802 <var>$limit_rate</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	803 variable:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	804 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	806
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	807 if ($slow) {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	808 set $limit_rate 4k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	809 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	810
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	811 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	812 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	813 </example>
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
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	819 <directive name="limit_rate_after">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	820 <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	821 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	823 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	824 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	825 <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	826 <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	827
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	828 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 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	830 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	831 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	832
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	833 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	834 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	835 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	836 location /flv/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	837 flv;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	838 limit_rate_after 500k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839 limit_rate 50k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	840 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	841 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	842 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	843
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	844 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	845
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	846
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	847 <directive name="lingering_close">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	848 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	849 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	850 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	851 <literal>always</literal></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	852 <default>on</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	853 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	854 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	855 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	856 <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	857 <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	858
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	859 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	860 Controls how nginx closes client connections.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	861 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	862
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	863 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	864 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	865 <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	866 <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	867 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	868 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	869 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	870
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	871 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	872 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	873 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	874 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	875
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	876 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	877 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	878 more data and close the connection immediately.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	879 This breaks the protocol and should not be used under normal circumstances.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	880 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	881
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	882 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	883
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	884
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	885 <directive name="lingering_time">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	886 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	887 <default>30s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	888 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	889 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	890 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	891
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	892 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	893 When <link id="lingering_close"/> is in effect,
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	894 this directive specifies a maximum time during which nginx
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	895 will process (read and ignore) additional data coming from a client.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	896 After that, the connection is closed, even if there are more data.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	897 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	898
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	899 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	900
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	901
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	902 <directive name="lingering_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	903 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	904 <default>5s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	905 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	906 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	907 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	908
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	909 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	910 When <link id="lingering_close"/> is in effect, this directive specifies
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	911 a maximum waiting time for more client data to arrive.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	912 If data are not received during this time, the connection is closed.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	913 Otherwise, data are read and ignored, then nginx waits again for more data.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	914 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	915 <link id="lingering_time"/> directive.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	916 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	917
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	918 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	919
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	920
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	921 <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	922 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	923 <value>address</value>[:<value>port</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	924 [<literal>default_server</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	925 [<literal>setfib</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	926 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	927 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	928 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	929 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	930 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	931 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	932 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	933 [<literal>ssl</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	934 [<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	935 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	936 <value>port</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	937 [<literal>default_server</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	938 [<literal>setfib</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	939 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	940 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	941 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	942 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	943 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	944 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	945 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	946 [<literal>ssl</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	947 [<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	948 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	949 <literal>unix:</literal><value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	950 [<literal>default_server</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	951 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	952 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	953 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	954 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	955 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	956 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	957 [<literal>ssl</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	958 [<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	959 <default>:80 \| :8000</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	961
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	962 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	963 Sets an <value>address</value> and a <value>port</value> for IP,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	964 or a <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	965 the server will accept requests.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	966 Only one of <value>address</value> or <value>port</value> may be
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 specified.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	968 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	969 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 listen 127.0.0.1:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	971 listen 127.0.0.1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	972 listen 8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	973 listen *:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	974 listen localhost:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976 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	977 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	978 listen [::]:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 listen [fe80::1];
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 </example>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	981 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	982 prefix:
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	983 <example>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	984 listen unix:/var/run/nginx.sock;
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	985 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	987
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	988 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	989 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	990 </para>
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 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	993 If directive is not present then either the <literal>*:80</literal> is used
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	994 if nginx runs with superuser privileges, or <literal>*:8000</literal> otherwise.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	995 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	996
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	997 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	998 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	999 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	1000 <value>address</value>:<value>port</value> pair.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1001 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	1002 parameter then the first server with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1003 <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	1004 the default server for this pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1005 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1006 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	1007 <literal>default</literal>.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1008 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1009 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1010
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1011 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1012 A <literal>listen</literal> directive
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1013 can have several additional parameters specific to system calls
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1014 <c-func>listen</c-func> and <c-func>bind</c-func>.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1015 They can be specified in any
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1016 <literal>listen</literal> directive, but only once for the given
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1017 <value>address</value>:<value>port</value> pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1018 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1019 In versions prior to 0.8.21, they could only be
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1020 specified in the <literal>listen</literal> directive with the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1021 <literal>default</literal> parameter.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1022 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1023 <list type="tag">
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 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1026 <literal>setfib</literal>=<value>number</value>
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1027 </tag-name>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1028 <tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1029 this parameter (0.8.44) sets the associated FIB (routing table)
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1030 for the listening socket.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1031 This currently works only on FreeBSD.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1032 </tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1033
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1034 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1035 <literal>backlog</literal>=<value>number</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1036 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1037 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1038 sets the <literal>backlog</literal> parameter in the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1039 <c-func>listen</c-func> call.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1040 By default, <literal>backlog</literal> equals -1 on FreeBSD
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1041 and 511 on other platforms.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1042 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1043
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1044 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1045 <literal>rcvbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1046 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1047 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1048 sets the <c-def>SO_RCVBUF</c-def> parameter for the listening socket.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1049 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1050
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1051 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1052 <literal>sndbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1053 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1054 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1055 sets the <c-def>SO_SNDBUF</c-def> parameter for the listening socket.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1056 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1057
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1058 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1059 <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	1060 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1061 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1062 sets the name of the accept filter.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1063 This works only on FreeBSD, acceptable values are <literal>dataready</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1064 and <literal>httpready</literal>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1065 On receipt of the <c-def>SIGHUP</c-def> signal, an accept filter can only be
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1066 changed in recent versions of FreeBSD, starting from 6.0, 5.4-STABLE
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1067 and 4.11-STABLE.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1068 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1069
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1070 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1071 <literal>deferred</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1072 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1073 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1074 instructs to use a deferred <c-func>accept</c-func> on Linux
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1075 using the <c-def>TCP_DEFER_ACCEPT</c-def> option.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1076 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1077
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1079 <literal>bind</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081 <tag-desc>
240 472e88bf177e Slightly better wording for the "bind" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 237 diff changeset	1082 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	1083 <value>address</value>:<value>port</value> pair.
240 472e88bf177e Slightly better wording for the "bind" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 237 diff changeset	1084 This is because nginx will <c-func>bind</c-func> only to
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1085 <literal>*:</literal><value>port</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1086 if there are several <literal>listen</literal> directives with
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1087 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	1088 <literal>listen</literal> directives listens on all addresses
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1089 for the given port (<literal>*:</literal><value>port</value>).
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1090 It should be noted that in this case a <c-func>getsockname</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1091 system call will be made to determine an address that accepted a
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1092 connection.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1093 If parameters <literal>backlog</literal>, <literal>rcvbuf</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1094 <literal>sndbuf</literal>, <literal>accept_filter</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1095 <literal>deferred</literal>, or <literal>so_keepalive</literal>
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1096 are used then for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1097 <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	1098 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	1099 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1101 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1102 <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	1103 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1104 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1105 this parameter (0.7.42) sets the value of the <c-def>IPV6_V6ONLY</c-def>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1106 parameter for the listening socket.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1107 This parameter can only be set once on start.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1108 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1109
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1110 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1111 <literal>ssl</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1113 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1114 this parameter (0.7.14) does not relate to system calls
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1115 <c-func>listen</c-func> and <c-func>bind</c-func>, but allows to
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 specify that all connections accepted on this port should work in
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 the SSL mode.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1118 This allows for a more compact configuration for the server operating
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1119 in both HTTP and HTTPS modes simultaneously.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1120 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1121 listen 80;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1122 listen 443 default ssl;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1123 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1124 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1125
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1126 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1127 <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	1128 </tag-name>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1129 <tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1130 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	1131 for the listening socket.
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1132 If this parameter is omitted then the system default setting will be
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1133 in effect for the socket.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1134 If set to the value “<literal>on</literal>”, the <c-def>SO_KEEPALIVE</c-def>
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1135 socket option is turned on for the socket.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1136 If set to the value “<literal>off</literal>”, the <c-def>SO_KEEPALIVE</c-def>
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1137 socket option is turned off for the socket.
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1138 Some operating systems support tuning TCP keepalive parameters on a per-socket
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1139 basis using the <c-def>TCP_KEEPIDLE</c-def>, <c-def>TCP_KEEPINTVL</c-def>,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1140 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	1141 On such systems (currently, Linux 2.4+, NetBSD 5+, and
f1c0ae9c1c48 FreeBSD 10.0-CURRENT supports the TCP_KEEPIDLE, TCP_KEEPINTVL, and Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	1142 FreeBSD 10.0-CURRENT) they can be configured
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1143 using the <value>keepidle</value>, <value>keepintvl</value>, and
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1144 <value>keepcnt</value> parameters.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1145 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	1146 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	1147 For example,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1148 <example>so_keepalive=30m::10</example>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1149 will set idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1150 leave probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1151 and set probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes.
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1152 </tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1153
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1154 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1155 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1156
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1157 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1158 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1159 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1160 listen 127.0.0.1 default accept_filter=dataready backlog=1024;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1161 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1162 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1163
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1164 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165
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 <directive name="location">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	1168 <syntax block="yes">[
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1169 <literal>=</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1170 <literal>~</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1171 <literal>~*</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1172 <literal>^~</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1173 ] <value>uri</value></syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1174 <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	1175 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1176 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1180 Sets a configuration based on a request URI.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1181 A location can either be defined by a prefix string, or by a regular expression.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1182 Regular expressions are specified by prepending them with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1183 “<literal>~*</literal>” prefix (for case-insensitive matching), or with the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1184 “<literal>~</literal>” prefix (for case-sensitive matching).
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1185 To find a location matching a given request, nginx first checks
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1186 locations defined using the prefix strings (prefix locations).
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	1187 Among them, the most specific one is searched.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1188 Then regular expressions are checked, in the order of their appearance
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1189 in a configuration file.
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1190 A search of regular expressions terminates on the first match,
9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1191 and the corresponding configuration is used.
9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1192 If no match with a regular expression is found then a
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 configuration of the most specific prefix location is used.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1194 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1195
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1196 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1197 Locations can be nested, with some exceptions mentioned below.
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1198 </para>
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1199
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1200 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1201 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	1202 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	1203 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	1204 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1205
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1206 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1207 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	1208 be used in other directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1209 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1210
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1211 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1212 If the most specific prefix location has the “<literal>^~</literal>” prefix
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1213 then regular expressions are not checked.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1214 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1215
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1216 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1217 Also, using the “<literal>=</literal>” prefix it is possible to define
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1218 an exact match of URI and location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1219 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	1220 For example, if a “<literal>/</literal>” request happens frequently,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1221 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	1222 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	1223 comparison.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1224 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	1225 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1226
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1227 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1228 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1229 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	1230 location without the “<literal>=</literal>” and “<literal>^~</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1231 prefixes, the search also terminated and regular expressions were
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1232 not checked.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1233 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1234 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1235
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1236 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1237 Let's illustrate the above by example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1238 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1239 location = / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1240 [ configuration A ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1241 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1242
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1243 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1244 [ configuration B ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1245 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1246
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1247 location ^~ /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1248 [ configuration C ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1249 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1250
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1251 location ~* \.(gif\|jpg\|jpeg)$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1252 [ configuration D ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1253 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1254 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1255 The “<literal>/</literal>” request will match configuration A,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1256 the “<literal>/documents/document.html</literal>” request will match
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1257 configuration B,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1258 the “<literal>/images/1.gif</literal>” request will match configuration C, and
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1259 the “<literal>/documents/1.jpg</literal>” request will match configuration D.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1260 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1261
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1262 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1263 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	1264 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	1265 used for request redirection.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1266 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	1267 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1268
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1269 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1270 <migration from="Apache" directive="Location" />
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1271 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1272
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1273 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1274
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1275
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1276 <directive name="log_not_found">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1277 <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	1278 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1279 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1280 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1281 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1282
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1283 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1284 Enables or disables logging of errors about not found files into the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1285 <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	1286 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1287
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1288 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1289
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1290
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1291 <directive name="log_subrequest">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1292 <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	1293 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1294 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1295 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1298 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 Enables or disables logging of subrequests into the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1300 <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	1301 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1302
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1303 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1304
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1306 <directive name="max_ranges">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1307 <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	1308 <default/>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1309 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1310 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1311 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1312
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1313 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1314 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	1315 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	1316 byte ranges specified.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1317 By default, there is no limit.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1318 The value of zero disables the byte-range support completely.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1319 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1320
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1321 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1322
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1323
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1324 <directive name="merge_slashes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1325 <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	1326 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1327 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1328 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1329
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1330 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1331 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	1332 in a URI into a single slash.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1333 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1334
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1335 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1336 Note that compression is essential for the correct prefix string
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1337 and regular expressions location matching.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1338 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	1339 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1340 location /scripts/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1341 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1342 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1343 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1344 and might be processed as a static file,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1345 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	1346 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1348 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1349 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	1350 contains base64-encoded names, since base64 uses the “<literal>/</literal>”
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1351 character internally.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1352 However, for security considerations, it is better to avoid turning off
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1353 the compression.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1354 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1355
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1356 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1357 If a directive is specified on the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1358 <link id="server"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1359 level, which is also a default server, its value will cover
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1360 all virtual servers listening on the same address and port.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1361 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1362
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1363 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1364
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1365
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1366 <directive name="msie_padding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1367 <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	1368 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1369 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1370 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1371 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1372
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1373 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1374 Enables or disables adding of comments to responses with status
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1375 greater than 400 for MSIE clients, to pad the response size to 512 bytes.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1376 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1377
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1378 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1379
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1380
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1381 <directive name="msie_refresh">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1382 <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	1383 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1384 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1385 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1386 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1387
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1388 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1389 Enables or disables issuing refreshes instead of redirects, for MSIE clients.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1390 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1391
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1392 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1393
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1394
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1395 <directive name="open_file_cache">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1396 <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	1397 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1398 <literal>max</literal>=<value>N</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1399 [<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	1400 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1401 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1402 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1403 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1404
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1405 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1406 Configures a cache that can store:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1407 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1408
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1409 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1410 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	1411 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1412
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1413 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1414 directory lookups;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1415 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1416
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1417 <listitem>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1418 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	1419 and so on.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1420 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1421 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	1422 <link id="open_file_cache_errors"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1423 directive.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1424 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1425 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1426
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1427 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1429
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1430 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1431 The directive has the following parameters:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1432 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1434 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1435 <literal>max</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1436 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1437 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1438 sets the maximum number of elements in the cache;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1439 on cache overflow the least recently used (LRU) elements get removed;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1440 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1441
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1442 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1443 <literal>inactive</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1444 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1445 <tag-desc>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1446 defines a time, after which an element gets removed from the cache
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1447 if there were no accesses to it during this time;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1448 by default, it is 60 seconds;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1449 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1450
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1451 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1452 <literal>off</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1453 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1454 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1455 disables the cache.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1456 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1457
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1458 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1459 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1460
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1461 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1462 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1463 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1464 open_file_cache max=1000 inactive=20s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1465 open_file_cache_valid 30s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1466 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	1467 open_file_cache_errors on;<!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1468 open_file_cache_events on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1469 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1470 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1471 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1472
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1473 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1474
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1475
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1476 <directive name="open_file_cache_errors">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1477 <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	1478 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1479 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1480 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1481 <context>location</context>
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>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1484 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	1485 <link id="open_file_cache"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1486 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1487
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1488 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1489
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1490
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1491 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1492
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1493 <directive name="open_file_cache_events">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1494 <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	1495 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1496 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1498 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1499
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1500 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1501 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	1502 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1503 elements.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1504 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	1505 <link doc="../events.xml" id="kqueue"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1506 method only.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507 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	1508 support events for arbitrary file system types.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1509 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	1510 file systems such as UFS or FFS.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1511 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1512
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1513 </directive>
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 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1516
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1517
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1518 <directive name="open_file_cache_min_uses">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1519 <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	1520 <default>1</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1521 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1522 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1523 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1524
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1525 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1526 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	1527 the period configured by the <literal>inactive</literal> parameter
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1528 of the <link id="open_file_cache"/> directive,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 after which a file descriptor will remain open in the cache.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1530 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1531
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1532 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1535 <directive name="open_file_cache_valid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1536 <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	1537 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1538 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1539 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1540 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1543 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	1544 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1545 elements should be validated.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1546 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1547 When
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1548 <link id="open_file_cache_events"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1549 is enabled, open file descriptors
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1550 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	1551 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1552 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1553
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1554 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1555
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1556
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1557 <directive name="optimize_server_names">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1558 <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	1559 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1560 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1561 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1562
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1563 <para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1564 This directive is made obsolete 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	1565 <link id="server_name_in_redirect"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1566 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1567
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1568 <!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1569 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1570 Enables or disables optimization of hostname checking in name-based
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1571 virtual servers.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1572 In particular, the checking affects hostnames used in redirects.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1573 If optimization is enabled, and all name-based servers listening on
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1574 the same address:port pair have identical configuration, then
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1575 names are not checked during request processing, and the first
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1576 server name is used in redirects.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1577 In case redirects should use hostnames sent by clients,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1578 optimization needs to be disabled.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1579 </para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1580 -->
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1581
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1582 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1583
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1584
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1585 <directive name="port_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1586 <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	1587 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1588 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1589 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1590 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1593 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	1594 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1595
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1596 <para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1597 See also the <link id="server_name_in_redirect"/> directive.
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1598 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1599
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1600 </directive>
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
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1603 <directive name="postpone_output">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1604 <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	1605 <default>1460</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1606 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1607 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1608 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1609
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1610 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1611 If possible, the output of client data will be postponed until
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1612 nginx has at least <value>size</value> bytes of data to send.
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1613 Value of zero disables postponing.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1614 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1615
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1616 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1617
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1618
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1619 <directive name="read_ahead">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1620 <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	1621 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1622 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1623 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1624 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1625
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1626 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1627 Sets the amount of pre-reading when working with files, in the kernel.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1628 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1629
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1630 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1631 On Linux, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1632 <literal>posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL)</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1633 system call is used, 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	1634 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1635
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1636 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1637 On FreeBSD, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1638 <literal>fcntl(O_READAHEAD,</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1639 <value>size</value><literal>)</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1640 system call is used, supported in FreeBSD 9.0-CURRENT.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1641 FreeBSD 7 needs to be
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1642 <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	1643 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1644
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1645 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1646
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1647
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1648 <directive name="recursive_error_pages">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1649 <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	1650 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1651 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1652 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1653 <context>location</context>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1656 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	1657 <link id="error_page"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1658 directive.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1659 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1660
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1661 </directive>
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
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1664 <directive name="request_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1665 <syntax><value>size</value></syntax>
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1666 <default>4k</default>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1667 <context>http</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1668 <context>server</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1669
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1670 <para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1671 Allows to fine tune per-request memory allocations.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1672 This directive has minimal impact on performance,
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1673 and should not generally be used.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1674 </para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1675
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1676 </directive>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1677
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1678
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1679 <directive name="reset_timedout_connection">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1680 <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	1681 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1682 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1683 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1684 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1687 Enables or disables resetting of timed out connections.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1688 The reset is performed as follows: before closing a socket, the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1689 <c-def>SO_LINGER</c-def>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1690 option is set on it with a timeout value of 0.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1691 When the socket is closed, a client is sent TCP RST, and all memory
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1692 occupied by this socket is freed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1693 This avoids keeping of an already closed socket with filled buffers
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1694 for a long time, in a FIN_WAIT1 state.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1695 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1696
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1697 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1698 It should be noted that timed out keep-alive connections are still
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1699 closed normally.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1700 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1701
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1702 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1703
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1704
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1705 <directive name="resolver">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1706 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1707 <value>address</value> ...
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1708 [<literal>valid</literal>=<value>time</value>]</syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1709 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1710 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1711 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1712 <context>location</context>
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 <para>
318 4a0fe9283dc7 Word polishing in the description of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	1715 Configures name servers used to resolve names of upstream servers,
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1716 for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1717 <example>
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1718 resolver 127.0.0.1 192.0.2.1;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1719 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1720 An <value>address</value> parameter may be specified as
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1721 either an IPv4 address or a hostname;
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1722 in the latter case, the first resolved IPv4 address is used.
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1723 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	1724 <note>
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1725 Before version 1.1.7, only a single name server could be configured.
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1726 </note>
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1727 By default, nginx caches answers using the TTL value of a response.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1728 An optional <literal>valid</literal> parameter allows to override it:
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1729 <example>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1730 resolver 127.0.0.1 192.0.2.1 valid=30s;
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1731 </example>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1732 <note>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1733 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	1734 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	1735 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1736 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1737
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1738 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1739
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1740
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1741 <directive name="resolver_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1742 <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	1743 <default>30s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1744 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1745 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1746 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1747
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 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	1750 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1751 resolver_timeout 5s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1752 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1753 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1754
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1755 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1756
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1757
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1758 <directive name="root">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1759 <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	1760 <default>html</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1761 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1762 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1763 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1764 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1765
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1766 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1767 Sets the root directory for requests.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1768 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1769 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1770 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1771 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1772 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1773 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1774 “<literal>/i/top.gif</literal>” will be responded
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1775 with the file
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	1776 <path>/data/w3/i/top.gif</path>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1777 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1778
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1779 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1780 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	1781 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	1782 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1783
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1784 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1785 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	1786 of the <literal>root</literal> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1787 If a URI need 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	1788 <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	1789 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1790
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1791 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1794 <directive name="satisfy">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1795 <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	1796 <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	1797 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	1798 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1799 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1800
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1801 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1802 Allows access if <literal>all</literal> or <literal>any</literal> of the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1803 <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	1804 or <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	1805 modules grant access.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1806 </para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1807
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1808 <para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1809 Example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1810 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1811 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1812 satisfy any;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1813
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1814 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1815 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1816
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1817 auth_basic "closed site";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1818 auth_basic_user_file conf/htpasswd;
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1821 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1822
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1823 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1824
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1825
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1826 <directive name="satisfy_any">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1827 <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	1828 <default>off</default>
69 935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	1829 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	1830 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1831 <context>location</context>
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 <para>
406 98dac2bd7598 Links with mixed underscores and spaces were hard to read, eliminated them. Ruslan Ermilov <ru@nginx.com> parents: 400 diff changeset	1834 This directive has been replaced by the <literal>any</literal>
98dac2bd7598 Links with mixed underscores and spaces were hard to read, eliminated them. Ruslan Ermilov <ru@nginx.com> parents: 400 diff changeset	1835 parameter of the <link id="satisfy"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1836 </para>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1839
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1840
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1841 <directive name="send_lowat">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1842 <syntax><value>size</value></syntax>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1843 <default>0</default>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1844 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1845 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1846 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1847
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1848 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1849 If set to a non-zero value, nginx will try to minimize the number
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1850 of send operations on client sockets by using either
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1851 <c-def>NOTE_LOWAT</c-def> flag of
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1852 <link doc="../events.xml" id="kqueue"/>,
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1853 or the <c-def>SO_SNDLOWAT</c-def> socket option,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1854 with the specified <value>size</value>.
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1855 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1856
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1857 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1858 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	1859 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1860
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1861 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1862
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1863
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1864 <directive name="send_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1865 <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	1866 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1868 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1869 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1870
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1871 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1872 Sets a timeout for transmitting a response to the client.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1873 A timeout is only set between two successive write operations,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1874 not for the transmission of the whole response.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1875 If a client does not receive anything within this time,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1876 a connection is closed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1877 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1878
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1879 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1880
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1881
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1882 <directive name="sendfile">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1883
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1884 <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	1885 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1886 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1887 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1888 <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	1889 <context>if in location</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1890
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1891 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1892 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1893 <c-func>sendfile</c-func>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1894 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1895
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1896 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1897
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1898
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1899 <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	1900
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1901 <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	1902 <default>0</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1903 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1904 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1905 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1906
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1907 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1908 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	1909 transferred in a single <c-func>sendfile</c-func> call.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1910 Without the limit, one fast connection may seize the worker process.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1911 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1912
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1913 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1914
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1915
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1916 <directive name="server">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	1917 <syntax block="yes"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1918 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1919 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1920
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1921 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1922 Sets a configuration for the virtual server.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1923 There is no clean separation between IP-based (based on the IP address)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1924 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	1925 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	1926 Instead, the <link id="listen"/> directives describe all
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 addresses and ports that should accept connections for a 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	1928 <link id="server_name"/> directive lists all server names.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1929 An example configuration is provided in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1930 <link doc="../virtual_hosts.xml">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1931 Setting Up Virtual Servers</link> document.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1932 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1935
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1936
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1937 <directive name="server_name">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1938 <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	1939 <default>""</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1940 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1941
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 Sets names of the virtual server, for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1944 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1945 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1946 server_name example.com www.example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1947 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1948 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1949 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1950
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1951 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	1952 The first name becomes the primary server name.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1953 Server names can include an asterisk (“<literal>*</literal>”)
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1954 to replace the first or last part of a name:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1956 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1957 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	1958 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1959 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1960 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1961
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1962 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1963 The first two of the above mentioned names can be combined:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1964 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1965 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1966 server_name .example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1967 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1968 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1969 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1970
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1971 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1972 If the parameter equals “<var>$hostname</var>” (0.9.4), the
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	1973 machine's hostname is substituted.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	1974 </para>
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	1975
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	1976 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1977 It is also possible to use regular expressions in server names,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1978 prepending 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	1979 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1980 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1981 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	1982 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1983 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1984 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1985
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1986 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1987 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	1988 be used in other directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1989 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1990 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991 server_name ~^(www\.)?(.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1993 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994 root /sites/$2;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1995 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1996 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1997
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1998 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1999 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2000
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2001 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2002 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2003 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2004 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2005 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2006 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2007
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2008 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2009 Named captures in regular expressions create variables (0.8.25)
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2010 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	2011 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2012 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2013 server_name ~^(www\.)?(?<domain>.+)$;
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 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2016 root /sites/$domain;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2017 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2018 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2019
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2020 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2021 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2022
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2023 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2024 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2025 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2026 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2028 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2029
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2030 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2031 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	2032 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2033 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034 server_name www.example.com "";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2036 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2037 It allows this server to process requests without the <header>Host</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	2038 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	2039 This is the default setting.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2040 <note>
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2041 Before 0.8.48, the machine's hostname was used by default.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2042 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2043 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2044
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2045 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2046 The name checking order is as follows:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2047 <list type="enum">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2050 full names
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2052
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2053 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2054 names with the prefix mask, e.g. “<literal>*.example.com</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2055 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2056
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2057 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2058 names with the suffix mask, e.g. “<literal>mail.*</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2059 </listitem>
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 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2062 regular expressions
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2063 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2064
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2065 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2066 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2069
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2070
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2071 <directive name="server_name_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2072 <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	2073 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2074 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2075 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2076 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2079 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	2080 <link id="server_name"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2081 directive, in redirects issued by nginx.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2082 When disabled, the name from the <header>Host</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2083 is used.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 If this field is not present, an IP address of the server is used.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2085 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2086
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2087 <para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2088 See also the <link id="port_in_redirect"/> directive.
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2089 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2090
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2091 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2094 <directive name="server_names_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2095 <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	2096 <default>32\|64\|128</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2097 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2098
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2099 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2100 Sets the bucket size for the server names hash tables.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2101 Default value depends on the size of the processor's cache line.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2102 For more information, please refer to
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2103 <link doc="../hash.xml">Setting Up Hashes</link>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2105
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2106 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2107
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2108
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2109 <directive name="server_names_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2110 <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	2111 <default>512</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2112 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2113
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2114 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2115 Sets the maximum <value>size</value> of the server names hash tables.
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2116 For more information, please refer to
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2117 <link doc="../hash.xml">Setting Up Hashes</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2118 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2119
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2120 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2121
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2122
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2123 <directive name="server_tokens">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2124 <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	2125 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2126 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2127 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2128 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2129
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2130 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2131 Enables or disables emitting of nginx version in error messages and in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2132 <header>Server</header> response header field.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2133 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136
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 <directive name="tcp_nodelay">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2139 <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	2140 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2141 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2142 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2143 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2144
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2145 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2146 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	2147 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	2148 keep-alive state.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2149 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2150
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2151 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2152
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2153
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2154 <directive name="tcp_nopush">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2155 <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	2156 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2157 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2158 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2159 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2160
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2161 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2162 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2163 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	2164 or the <c-def>TCP_CORK</c-def> socket option 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	2165 Options are enabled only when <link id="sendfile"/> is used.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2166 Enabling the option allows to
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2167 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2168
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2169 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2170 send the response header and the beginning of a file in one packet,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2171 on Linux and FreeBSD 4.*;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2172 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2173
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2174 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2175 send a file in full packets.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2176 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2177
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2179 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2180
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2181 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2182
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2183
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2184 <directive name="try_files">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2185 <syntax><value>file</value> ... <value>uri</value></syntax>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2186 <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	2187 <default/>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2188 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2190
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2191 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2192 Checks the existence of files in the specified order, and uses
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2193 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	2194 is performed in the current context.
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	2195 A path to the file is constructed from the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2196 <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	2197 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	2198 <link id="root"/> and <link id="alias"/> directives.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2199 It is possible to check the directory existence by specifying
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2200 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	2201 If none of the files were found, an internal redirect to the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2202 <value>uri</value> specified by the last parameter is made.
173 6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2203 For example:
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2204 <example>
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2205 location /images/ {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2206 try_files $uri /images/default.gif;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2207 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2208
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2209 location = /images/default.gif {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2210 expires 30s;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2211 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2212 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2213 The last parameter can also point to a named location,
173 6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2214 see examples below.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2215 As of version 0.7.51, the last parameter can also be a
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2216 <value>code</value>:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2217 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2218 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2219 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	2220 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2221 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2222 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2223
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2224 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2225 Example when proxying Mongrel:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2226 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2227 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2228 try_files /system/maintenance.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2229 $uri $uri/index.html $uri.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2230 @mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2231 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2232
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2233 location @mongrel {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2234 proxy_pass http://mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2235 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2236 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2237 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2238
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2239 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2240 Example for Drupal/FastCGI:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2241 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2242 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2243 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2244 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2245
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2246 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2247 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2248
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2249 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2250
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2251 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	2252 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2253 fastcgi_param QUERY_STRING $args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2254
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2255 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2256 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2257
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2258 location @drupal {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2259 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2260
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2261 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	2262 fastcgi_param SCRIPT_NAME /index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2263 fastcgi_param QUERY_STRING q=$uri&$args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2264
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2265 ... other fastcgi_param's
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2268 In the following example,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2269 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2270 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2271 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2272 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2273 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2274 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	2275 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2276 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2277 error_page 404 = @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2278 log_not_found off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2279 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2280 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2281 And here,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2282 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2283 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2284 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2285
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2286 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2287
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2288 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	2289
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2290 ...
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>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2293 <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	2294 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	2295 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2296
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2297 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2298 Example for Wordpress and Joomla:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2299 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2300 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2301 try_files $uri $uri/ @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2302 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2303
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2304 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2305 try_files $uri @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2306
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2307 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2308
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2309 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	2310 ... other fastcgi_param's
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2313 location @wordpress {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2314 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2315
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2316 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	2317 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2318 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2319 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2320 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2323
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 <directive name="types">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2326 <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	2327 <default>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2328 text/html html;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2329 image/gif gif;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2330 image/jpeg jpg;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2331 </default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2332 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2333 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2334 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2335
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2336 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2337 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	2338 Extensions are case-insensitive.
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2339 Several extensions can map to one type, for example:
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2340 <example>
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2341 types {
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2342 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	2343 application/octet-stream deb;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2344 application/octet-stream dmg;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2345 }
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2346 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2347 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2350 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	2351 <path>conf/mime.types</path> file.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2352 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2353
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2354 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2355 To make a particular location emit the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2356 “<literal>application/octet-stream</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2357 MIME type for all requests, try the following:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2358 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2359 location /download/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2360 types { }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2361 default_type application/octet-stream;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2362 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2363 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2364 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2365
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2366 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2367
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2368
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2369 <directive name="types_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2370 <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	2371 <default>32\|64\|128</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2372 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2373 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2374 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2375
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2376 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2377 Sets the bucket size for the types hash tables.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2378 Default value depends on the size of the processor's cache line.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2379 For more information, please refer to
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2380 <link doc="../hash.xml">Setting Up Hashes</link>.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2381 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2382
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2383 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2384
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2385
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2386 <directive name="types_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2387 <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	2388 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2389 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2390 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2391 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2392
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2393 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2394 Sets the maximum <value>size</value> of the types hash tables.
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2395 For more information, please refer to
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2396 <link doc="../hash.xml">Setting Up Hashes</link>.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2397 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2398
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2399 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2400
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2401
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2402 <directive name="underscores_in_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2403 <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	2404 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2405 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2406 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2407
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2408 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2409 Enables or disables the use of underscores in client request header fields.
225 46ef98b7513f Expanded on the "underscores_in_headers" relation to "ignore_invalid_headers". Ruslan Ermilov <ru@nginx.com> parents: 223 diff changeset	2410 When disabled, request header fields whose names contain underscores are
46ef98b7513f Expanded on the "underscores_in_headers" relation to "ignore_invalid_headers". Ruslan Ermilov <ru@nginx.com> parents: 223 diff changeset	2411 marked as invalid and are subject to the <link id="ignore_invalid_headers"/>
46ef98b7513f Expanded on the "underscores_in_headers" relation to "ignore_invalid_headers". Ruslan Ermilov <ru@nginx.com> parents: 223 diff changeset	2412 directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2413 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2416
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2417
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2418 <directive name="variables_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2419 <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	2420 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2421 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2422
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2423 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2424 Sets the bucket size for the variables hash table.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2425 For more information, please refer to
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2426 <link doc="../hash.xml">Setting Up Hashes</link>.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2427 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2428
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2429 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2430
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2431
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2432 <directive name="variables_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2433 <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	2434 <default>512</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2435 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2436
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2437 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2438 Sets the maximum <value>size</value> of the variables hash table.
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2439 For more information, please refer to
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2440 <link doc="../hash.xml">Setting Up Hashes</link>.
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2441 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2442
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2443 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2444
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2445 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2446
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2447
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2448 <section id="variables" name="Embedded Variables">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2449
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2450 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2451 The module <literal>ngx_http_core_module</literal> supports embedded variables
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2452 with names matching those of the Apache Server.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2453 First of all, these are variables representing client request header
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2454 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	2455 and so on.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2456 It also supports other variables:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2457 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2458
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2459 <tag-name><var>$arg_</var><value>name</value></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2460 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2461 argument <value>name</value> in the request line
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2462 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2463
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2464 <tag-name><var>$args</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2465 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2466 arguments in the request line
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2467 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2468
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2469 <tag-name><var>$binary_remote_addr</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2470 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2471 client address in a binary form, value's length is always 4 bytes
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2472 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2473
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2474 <tag-name><var>$body_bytes_sent</var></tag-name>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2475 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2476 number of bytes sent to a client, not counting the response header
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2477 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2478
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2479 <tag-name><var>$content_length</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2480 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2481 <header>Content-Length</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2482 </tag-desc>
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 <tag-name><var>$content_type</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2485 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2486 <header>Content-Type</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2487 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2488
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2489 <tag-name><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	2490 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2491 the <value>name</value> cookie
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2492 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2493
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2494 <tag-name><var>$document_root</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2495 <tag-desc>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2496 <link id="root"/> directive's value for the current request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2497 </tag-desc>
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 <tag-name><var>$document_uri</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2500 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2501 same as <var>$uri</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2502 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2503
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2504 <tag-name><var>$host</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2505 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2506 <header>Host</header> request header field,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2507 or the server name matching a request if this field is not present
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2508 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2509
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2510 <tag-name><var>$hostname</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2511 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2512 host name
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2513 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2514
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2515 <tag-name><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	2516 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2517 the <value>name</value> request header field
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2518 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2519
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2520 <tag-name><var>$https</var></tag-name>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2521 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2522 “<literal>on</literal>”
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2523 if connection operates in SSL mode,
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2524 or an empty string otherwise
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2525 </tag-desc>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2526
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2527 <tag-name><var>$is_args</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2529 “<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	2530 or an empty string otherwise
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2531 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2532
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2533 <tag-name><var>$limit_rate</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2534 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2535 allows for connection rate limiting
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2536 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2537
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2538 <tag-name><var>$nginx_version</var></tag-name>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2539 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2540 nginx version
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2541 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2542
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2543 <tag-name><var>$pid</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2544 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2545 PID of the worker process
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2546 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2547
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2548 <tag-name><var>$query_string</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2549 <tag-desc>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2550 same as <var>$args</var>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2551 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2552
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2553 <tag-name><var>$realpath_root</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2554 <tag-desc>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2555 <link id="root"/> directive's value
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2556 for the current request, 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	2557 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2558
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2559 <tag-name><var>$remote_addr</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2560 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2561 client address
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2562 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2563
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2564 <tag-name><var>$remote_port</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2565 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2566 client port
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2567 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2568
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2569 <tag-name><var>$remote_user</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2570 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2571 user name supplied with the Basic authentication
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2572 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2573
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2574 <tag-name><var>$request</var></tag-name>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2575 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2576 full original request line
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2577 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2578
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2579 <tag-name><var>$request_body</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2580 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2581 request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2582 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2583 The variable's value is made available in locations
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2584 processed 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	2585 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2586 and
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2587 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2588 directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2589 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2590 </tag-desc>
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 <tag-name><var>$request_body_file</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2593 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2594 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	2595 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2596 At the end of processing, the file needs to be removed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2597 To always write a 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	2598 <link id="client_body_in_file_only"/> needs to be enabled.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2599 When passing the name of a temporary file in a proxied request,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2600 or in a request to a FastCGI server,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2601 passing of the request body should be disabled by the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2602 <link doc="ngx_http_proxy_module.xml" id="proxy_pass_request_body">
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2603 proxy_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2604 and
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2605 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass_request_body">
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2606 fastcgi_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2607 directives, respectively.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2608 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2609 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2610
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2611 <tag-name><var>$request_completion</var></tag-name>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2612 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2613 “<literal>OK</literal>” if a request has completed,
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2614 or an empty string otherwise
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2615 </tag-desc>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2616
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2617 <tag-name><var>$request_filename</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2618 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2619 file path for the current query, based on the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2620 <link id="root"/> or <link id="alias"/>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2621 directives, and the request URI
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2622 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2623
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2624 <tag-name><var>$request_method</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2625 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2626 request method, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2627 “<literal>GET</literal>” or “<literal>POST</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2628 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2629
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2630 <tag-name><var>$request_uri</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2631 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2632 full original request URI (with arguments)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2633 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2634
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2635 <tag-name><var>$scheme</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2636 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2637 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	2638 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2639
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2640 <tag-name><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	2641 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2642 the <value>name</value> response header field
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2643 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2644
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2645 <tag-name><var>$server_addr</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2646 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2647 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	2648 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2649 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	2650 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	2651 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	2652 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2653 </tag-desc>
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 <tag-name><var>$server_name</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2656 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2657 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	2658 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2659
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2660 <tag-name><var>$server_port</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2661 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2662 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	2663 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2664
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2665 <tag-name><var>$server_protocol</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2666 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2667 request protocol, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2668 “<literal>HTTP/1.0</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2669 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2670 “<literal>HTTP/1.1</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2671 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2672
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2673 <tag-name><var>$uri</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2674 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2675 current URI in request
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2676 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2677 It may differ from an original, e.g. when doing internal redirects,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2678 or when using index files.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2679 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 </tag-desc>
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 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2683 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2684
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2685 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2686
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2687 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_core_module.xml @ 406:98dac2bd7598