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

annotate xml/en/docs/http/ngx_http_core_module.xml @ 589:764fbac1b8b4

Added document revision.

author	Ruslan Ermilov <ru@nginx.com>
date	Tue, 17 Jul 2012 05:02:15 +0000
parents	5bb7716cae7e
children	f3ef5b77d22a

rev	line source
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	3 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	6 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 576 diff changeset	7
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9
89 f451dc5c5c82 Module names corrected. Ruslan Ermilov <ru@nginx.com> parents: 88 diff changeset	10 <module name="Module ngx_http_core_module"
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 link="/en/docs/http/ngx_http_core_module.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 587 diff changeset	12 lang="en"
764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 587 diff changeset	13 rev="1">
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="directives" name="Directives">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	17 <directive name="aio">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	18 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	19 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	20 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	21 <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	22 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	26 <appeared-in>0.8.11</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 Enables or disables the use of asynchronous file I/O (AIO)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 on FreeBSD and Linux.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 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	35 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	36 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 options VFS_AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 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	40 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 kldload aio
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 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	47 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	48 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	49 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	50 FreeBSD 7.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 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	52 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	53 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	54 after the kernel has booted.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 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	56 <path>/var/log/messages</path>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 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	59 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	60 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 and can safely be ignored.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 <note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 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	64 fact that FreeBSD supports asynchronous calls
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 <c-func>aio_read</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 <c-func>aio_write</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 when working with sockets.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 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	70 </note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 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	75 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 needs to be disabled:
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 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 sendfile off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 output_buffers 1 64k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 }
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 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 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	88 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	89 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 sendfile on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 tcp_nopush on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 aio sendfile;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 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	97 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	98 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	99 memory; nginx then initiates an asynchronous data load by reading
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	100 one byte.
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	101 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	102 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	103 in 16K chunks.
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	104 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	105 <link id="read_ahead"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 directive.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 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	111 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	112 <link id="directio"/>,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 otherwise reading will be blocking:
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 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 directio 512;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 output_buffers 1 128k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 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	125 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 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	127 boundaries (or 4K for XFS).
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 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	129 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	130 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	131 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	132 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	133 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 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	135 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 is used.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 <directive name="alias">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	143 <syntax><value>path</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 Defines a replacement for the specified location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 the request of
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	156 “<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	157 with the file
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	158 <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	159 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	162 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	163 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	164 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	167 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	168 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	169 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	170 these captures (0.7.40), for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 location ~ ^/users/(.+\.(?:gif\|jpe?g\|png))$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 alias /data/w3/images/$1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 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	180 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 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	186 <link id="root"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 directive instead:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	198 <directive name="chunked_transfer_encoding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	199 <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	200 <default>on</default>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	201 <context>http</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	202 <context>server</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	203 <context>location</context>
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 <para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	206 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	207 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	208 chunked encoding though the standard requires it.
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	209 </para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	210
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	211 </directive>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	212
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	213
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	214 <directive name="client_body_buffer_size">
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	215
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	216 <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	217 <default>8k\|16k</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	218 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	219 <context>server</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	220 <context>location</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	221
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	222 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	223 Sets buffer size for reading client request body.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	224 In case request body is larger than the buffer,
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	225 the whole body or only its part is written to a
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	226 <link id="client_body_temp_path">temporary file</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	227 By default, buffer size is equal to two memory pages.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	228 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	229 It is usually 16K on other 64-bit platforms.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	230 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	231
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	232 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	233
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	234
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 <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	236 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	237 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	238 <literal>clean</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	239 <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	240 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 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	247 into a file.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 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	249 <var>$request_body_file</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 variable, or the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 <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	252 method of the module
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 <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	254 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	257 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	258 removed after request processing.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	262 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	263 left after request processing to be removed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 <directive name="client_body_in_single_buffer">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	270 <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	271 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275
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 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	278 in a single buffer.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 The directive is recommended when using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 <var>$request_body</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 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	282 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 <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	288 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	289 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	290 [<value>level1</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	291 [<value>level2</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	292 [<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	293 <default>client_body_temp</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 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	300 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	301 directory.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302 For example, in the following configuration
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 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	305 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 a temporary file might look like this:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 /spool/nginx/client_temp/7/45/00000123457
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 <directive name="client_body_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	316 <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	317 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 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	324 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	325 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	326 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	327 the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 <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	329 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333
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 <directive name="client_header_buffer_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	336 <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	337 <default>1k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	342 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	343 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	344 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	345 it may not fit into 1K.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 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	347 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	348 <link id="large_client_header_buffers"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 directive.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 <directive name="client_header_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	356 <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	357 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360
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 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	363 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	364 the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 <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	366 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 <directive name="client_max_body_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	373 <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	374 <default>1m</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 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	381 specified in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 <header>Content-Length</header>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383 request header field.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 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	385 <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	386 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 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	388 <!--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	389 this error<!--/link-->.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	390 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	391 request body size checking.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	395
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	397 <directive name="connection_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	398 <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	399 <default>256</default>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	400 <context>http</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	401 <context>server</context>
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 <para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	404 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	405 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	406 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	407 </para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	408
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	409 </directive>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	410
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	411
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 <directive name="default_type">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	413 <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	414 <default>text/plain</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	417 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	418
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	420 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	421 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	422 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	427 <directive name="directio">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	428 <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	429 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	433 <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	434
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 Enables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	437 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	438 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	439 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	440 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	441 the specified <value>size</value>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 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	443 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444 for a given request.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 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	446 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447 directio 4m;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 </example>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	449 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	450 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	455 <directive name="directio_alignment">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	456 <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	457 <default>512</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	461 <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	462
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 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	465 <link id="directio"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 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	467 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	468 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	473 <directive name="disable_symlinks">
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	474 <syntax><literal>off</literal></syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	475 <syntax>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	476 <literal>on</literal> \|
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	477 <literal>if_not_owner</literal>
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	478 [<literal>from</literal>=<value>part</value>]</syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	479 <default>off</default>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	480 <context>http</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	481 <context>server</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	482 <context>location</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	483 <appeared-in>1.1.15</appeared-in>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	484
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	485 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	486 Determines how symbolic links should be treated when opening files:
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	487 <list type="tag">
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	488
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	489 <tag-name><literal>off</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	490 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	491 Symbolic links in the pathname are allowed and not checked.
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	492 This is the default behavior.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	493 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	494
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	495 <tag-name><literal>on</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	496 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	497 If any component of the pathname is a symbolic link,
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	498 access to a file is denied.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	499 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	500
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	501 <tag-name><literal>if_not_owner</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	502 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	503 Access to a file is denied if any component of the pathname
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	504 is a symbolic link, and the link and object that the link
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	505 points to have different owners.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	506 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	507
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	508 <tag-name><literal>from</literal>=<value>part</value></tag-name>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	509 <tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	510 When checking symbolic links
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	511 (parameters <literal>on</literal> and <literal>if_not_owner</literal>),
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	512 all components of the pathname are normally checked.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	513 Checking of symbolic links in the initial part of the pathname
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	514 may be avoided by also specifying the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	515 <literal>from</literal>=<value>part</value> parameter.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	516 In this case, symbolic links are checked only from
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	517 the component of the pathname following the specified initial part.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	518 If a value is not an initial part of the checked pathname, the whole
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	519 pathname is checked as if this parameter was not specified at all.
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	520 If a value fully matches the file name,
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	521 symbolic links are not checked.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	522 The parameter value can contain variables.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	523 </tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	524
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	525 </list>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	526 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	527
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	528 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	529 Example:
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	530 <example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	531 disable_symlinks on from=$document_root;
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	532 </example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	533 </para>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	534
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	535 <para>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	536 This directive is only available on systems that have the
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	537 <c-func>openat</c-func> and <c-func>fstatat</c-func> interfaces.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	538 This includes modern versions of FreeBSD, Linux, and Solaris.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	539 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	540
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	541 <para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	542 Parameters <literal>on</literal> and <literal>if_not_owner</literal>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	543 add a processing overhead.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	544 <note>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	545 On systems that do not support opening directories for search only,
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	546 the use of these parameters requires that worker processes
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	547 have read permissions for all checked directories.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	548 </note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	549 </para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	550
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	551 <para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	552 <note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	553 The
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	554 <link doc="ngx_http_autoindex_module.xml">ngx_http_autoindex_module</link>,
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	555 <link doc="ngx_http_random_index_module.xml">ngx_http_random_index_module</link>,
477 c5680571ec09 Unnecessary extensions removed from links. Andrey Belov <defan@nginx.com> parents: 476 diff changeset	556 and <link doc="ngx_http_dav_module.xml">ngx_http_dav_module</link>
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	557 modules currently ignore this directive.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	558 </note>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	559 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	560
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	561 </directive>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	562
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	563
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	564 <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	565 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	566 <value>code</value> ...
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	567 [<literal>=</literal>[<value>response</value>]]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	568 <value>uri</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	569 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	570 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	571 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	572 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	573 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	574
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	575 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	576 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	577 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	578 only if there are no
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	579 <literal>error_page</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	580 directives on
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	581 the current level.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	582 A URI value can contain variables.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	583 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	584
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	585 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	586 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	587 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	588 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	589 error_page 502 503 504 /50x.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	590 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	591 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	592 </para>
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 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	596 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	597 error_page 404 =200 /empty.gif;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	598 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	599 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	602 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	603 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	604 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	605 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	606 error_page 404 = /404.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	607 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	608 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	609
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	610 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	611 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	612 error processing into a named location:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	613 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	614 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	615 error_page 404 = @fallback;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	616 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	617
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	618 location @fallback {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	619 proxy_pass http://backend;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	620 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	621 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	622 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	623
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	624 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	625
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	626
576 cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	627 <directive name="etag">
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	628 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	629 <default>on</default>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	630 <context>http</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	631 <context>server</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	632 <context>location</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	633 <appeared-in>1.3.3</appeared-in>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	634
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	635 <para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	636 Enables or disables automatic generation of the <header>ETag</header>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	637 response header field for static resources.
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	638 </para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	639
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	640 </directive>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	641
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	642
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	643 <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	644 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	645 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	646 <literal>exact</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	647 <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	648 <default>exact</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	649 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	650 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	651 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	652 <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	653
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	654 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655 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	656 with the time in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657 <header>If-Modified-Since</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	658 request header field:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	659
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	660 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	661
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	662 <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	663 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	664 the
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	665 <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	666 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	667
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	668 <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	669 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	670 exact match;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	671 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	672
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	673 <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	674 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	675 modification time of a response is
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	676 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	677 request header field.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	678 </tag-desc>
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 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	681 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	682
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	685
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	686 <directive name="ignore_invalid_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	687 <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	688 <default>on</default>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	689 <context>http</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	690 <context>server</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	691
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	692 <para>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	693 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	694 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	695 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	696 directive).
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	697 </para>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	698
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	699 <para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	700 A directive can be specified on the <link id="server"/> level
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	701 in a default server.
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	702 In this case, its value will cover all virtual servers
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	703 listening on the same address and port.
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	704 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	705
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	706 </directive>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	707
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	708
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	709 <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	710 <syntax/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	711 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	712 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	713
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	714 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	715 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	716 For external requests, the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	717 <http-status code="404" text="Not Found"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 Internal requests are the following:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	720
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	721 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	722
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	723 <listitem>
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	724 requests redirected by the
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	725 <link id="error_page"/>,
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	726 <link doc="ngx_http_index_module.xml" id="index"/>,
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	727 <link doc="ngx_http_random_index_module.xml" id="random_index"/>, and
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	728 <link id="try_files"/> directives;
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	729 </listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	730
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	731 <listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	732 requests redirected by the <header>X-Accel-Redirect</header>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	733 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	734 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	735
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	736 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	737 subrequests formed by the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	738 “<command>include virtual</command>”
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	739 command of the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	740 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	741 module and by the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	742 <link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	743 module directives;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	744 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	745
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	746 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	747 requests changed by the
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	748 <link doc="ngx_http_rewrite_module.xml" id="rewrite"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	749 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	750
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	751 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	752 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	753
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	754 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	755 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	756 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	757 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	758
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	759 location /404.html {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	760 internal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	761 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	762 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	763 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	764
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	765 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	766
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	767
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	768 <directive name="keepalive_disable">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	769 <syntax><literal>none</literal> \| <value>browser</value> ...</syntax>
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	770 <default>msie6</default>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	771 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	772 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	773 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	774
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	775 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	776 Disables keep-alive connections with misbehaving browsers.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	777 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	778 browsers will be affected.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	779 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	780 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	781 The value <literal>safari</literal> disables keep-alive connections
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	782 with Safari and Safari-like browsers on Mac OS X and Mac OS X-like
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	783 operating systems.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	784 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	785 with all browsers.
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	786 <note>
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	787 Prior to version 1.1.18, the value <literal>safari</literal> matched
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	788 all Safari and Safari-like browsers on all operating systems, and
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	789 keep-alive connections with them were disabled by default.
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	790 </note>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	791 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	792
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	793 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	794
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	795
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	796 <directive name="keepalive_requests">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	797 <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	798 <default>100</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	802 <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	803
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	804 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 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	806 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	807 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	808 </para>
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 </directive>
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 <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	814 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	815 <value>timeout</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	816 [<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	817 <default>75s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	818 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	819 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	820 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	821
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	822 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	823 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	824 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	825 The optional second parameter sets a value in the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	826 <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	827 response header field.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	828 Two parameters may differ.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	829 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	830
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	831 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	832 The
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	833 <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	834 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	835 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	836 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	837
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	838 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839
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 <directive name="large_client_header_buffers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	842 <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	843 <default>4 8k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	844 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	845 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	846
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	847 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	848 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	849 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	850 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	851 <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	852 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	853 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	854 client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	855 <http-status code="400" text="Bad Request"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	856 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	857 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	858 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	859 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	860 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	861 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	862
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	863 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	864
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 <directive name="limit_except">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	867 <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	868 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	869 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	870
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	871 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	872 Limits allowed HTTP methods inside a location.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	873 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	874 <literal>GET</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	875 <literal>HEAD</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	876 <literal>POST</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	877 <literal>PUT</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	878 <literal>DELETE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	879 <literal>MKCOL</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	880 <literal>COPY</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	881 <literal>MOVE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	882 <literal>OPTIONS</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	883 <literal>PROPFIND</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	884 <literal>PROPPATCH</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	885 <literal>LOCK</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	886 <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	887 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	888 <literal>PATCH</literal>.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	889 Allowing the <literal>GET</literal> method also allows the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	890 <literal>HEAD</literal> method.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	891 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	892 <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	893 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	894 <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	895 modules directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	896 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	897 limit_except GET {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	898 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	899 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	900 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	901 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	902 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	903 <emphasis>except</emphasis> GET and HEAD.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	904 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	906 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	907
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	908
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	909 <directive name="limit_rate">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	910 <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	911 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	912 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	913 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	914 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	915 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	916
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	917 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	918 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	919 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	920 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	921 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	922 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	923 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	924 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	925 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	926 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	927
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	928 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	929 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	930 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	931 <link id="server"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	932 level.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	933 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	934 <var>$limit_rate</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	935 variable:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	936 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	937 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	938
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939 if ($slow) {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940 set $limit_rate 4k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	942
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	943 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	944 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	945 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	946 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	947
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	948 <para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	949 In addition, rate limit can also be set in the
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	950 <header>X-Accel-Limit-Rate</header> response header field.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	951 This ability can be disabled using the
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	952 <link doc="ngx_http_proxy_module.xml" id="proxy_ignore_headers"/>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	953 and
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	954 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_ignore_headers"/>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	955 directives.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	956 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	957
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	958 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	959
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	960
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	961 <directive name="limit_rate_after">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	962 <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	963 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	964 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	966 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	967 <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	968 <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	969
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	970 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	971 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	972 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	973 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	974
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	975 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	976 Example:
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 location /flv/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	979 flv;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	980 limit_rate_after 500k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	981 limit_rate 50k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	982 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	983 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	985
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	986 </directive>
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
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	989 <directive name="lingering_close">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	990 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	991 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	992 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	993 <literal>always</literal></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	994 <default>on</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	995 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	996 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	997 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	998 <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	999 <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	1000
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1001 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1002 Controls how nginx closes client connections.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1003 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1004
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1005 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1006 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	1007 <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	1008 <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	1009 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	1010 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	1011 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1012
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1013 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1014 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	1015 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	1016 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1017
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1018 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1019 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	1020 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	1021 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	1022 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1023
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1024 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1025
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1026
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1027 <directive name="lingering_time">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1028 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1029 <default>30s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1030 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1031 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1032 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1033
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1034 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1035 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	1036 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	1037 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	1038 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	1039 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1040
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1041 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1042
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1043
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1044 <directive name="lingering_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1045 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1046 <default>5s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1047 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1048 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1049 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1050
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1051 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1052 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	1053 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	1054 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	1055 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	1056 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	1057 <link id="lingering_time"/> directive.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1058 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1059
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1060 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1061
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1062
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1063 <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	1064 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1065 <value>address</value>[:<value>port</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1066 [<literal>default_server</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1067 [<literal>setfib</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1068 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1069 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1070 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1071 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1072 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1073 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1074 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1075 [<literal>ssl</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1076 [<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	1077 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1078 <value>port</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1079 [<literal>default_server</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1080 [<literal>setfib</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1081 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1082 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1083 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1084 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1085 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1086 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1087 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1088 [<literal>ssl</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1089 [<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	1090 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1091 <literal>unix:</literal><value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1092 [<literal>default_server</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1093 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1094 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1095 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1096 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1097 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1098 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1099 [<literal>ssl</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1100 [<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	1101 <default>:80 \| :8000</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1102 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1103
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1104 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1105 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	1106 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	1107 the server will accept requests.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1108 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	1109 specified.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1110 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	1111 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1112 listen 127.0.0.1:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1113 listen 127.0.0.1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1114 listen 8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1115 listen *:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1116 listen localhost:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1117 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1118 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	1119 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1120 listen [::]:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1121 listen [fe80::1];
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1122 </example>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1123 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	1124 prefix:
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1125 <example>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1126 listen unix:/var/run/nginx.sock;
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1127 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1130 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1131 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	1132 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1133
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1135 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	1136 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	1137 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1138
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1139 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1140 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	1141 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	1142 <value>address</value>:<value>port</value> pair.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1143 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	1144 parameter then the first server with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1145 <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	1146 the default server for this pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1147 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1148 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	1149 <literal>default</literal>.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1150 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1151 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1152
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1153 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1154 A <literal>listen</literal> directive
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1155 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	1156 <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	1157 They can be specified in any
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1158 <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	1159 <value>address</value>:<value>port</value> pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1160 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1161 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	1162 specified in the <literal>listen</literal> directive with the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1163 <literal>default</literal> parameter.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1164 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165 <list type="tag">
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 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1168 <literal>setfib</literal>=<value>number</value>
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1169 </tag-name>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1170 <tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1171 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	1172 for the listening socket.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1173 This currently works only on FreeBSD.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1174 </tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1175
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1176 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1177 <literal>backlog</literal>=<value>number</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1180 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	1181 <c-func>listen</c-func> call.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1182 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	1183 and 511 on other platforms.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1184 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1185
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1186 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1187 <literal>rcvbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1188 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1189 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1190 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	1191 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1192
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1193 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1194 <literal>sndbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1195 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1196 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1197 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	1198 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1199
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1200 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1201 <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	1202 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1203 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1204 sets the name of the accept filter.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1205 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	1206 and <literal>httpready</literal>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1207 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	1208 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	1209 and 4.11-STABLE.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1210 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1211
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1212 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1213 <literal>deferred</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1214 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1215 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1216 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	1217 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	1218 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1219
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1220 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1221 <literal>bind</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1222 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1223 <tag-desc>
240 472e88bf177e Slightly better wording for the "bind" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 237 diff changeset	1224 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	1225 <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	1226 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	1227 <literal>*:</literal><value>port</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1228 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	1229 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	1230 <literal>listen</literal> directives listens on all addresses
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1231 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	1232 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	1233 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	1234 connection.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1235 If parameters <literal>backlog</literal>, <literal>rcvbuf</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1236 <literal>sndbuf</literal>, <literal>accept_filter</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1237 <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	1238 are used then for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1239 <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	1240 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	1241 </tag-desc>
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 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1244 <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	1245 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1246 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1247 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	1248 parameter for the listening socket.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1249 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	1250 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1251
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1252 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1253 <literal>ssl</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1254 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1255 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1256 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	1257 <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	1258 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	1259 the SSL mode.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1260 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	1261 in both HTTP and HTTPS modes simultaneously.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1262 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1263 listen 80;
476 4070589eebce In "listen", specifying "ssl" doesn't require specifying "default". Ruslan Ermilov <ru@nginx.com> parents: 467 diff changeset	1264 listen 443 ssl;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1265 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1266 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1267
223 09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1268 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1269 <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	1270 </tag-name>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1271 <tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1272 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	1273 for the listening socket.
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1274 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	1275 in effect for the socket.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1276 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	1277 socket option is turned on for the socket.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1278 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	1279 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	1280 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	1281 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	1282 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	1283 On such systems (currently, Linux 2.4+, NetBSD 5+, and
454 daafc5600fc4 FreeBSD 9.0-STABLE supports the TCP_KEEPIDLE, TCP_KEEPINTVL, and Ruslan Ermilov <ru@nginx.com> parents: 453 diff changeset	1284 FreeBSD 9.0-STABLE) they can be configured
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1285 using the <value>keepidle</value>, <value>keepintvl</value>, and
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1286 <value>keepcnt</value> parameters.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1287 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	1288 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	1289 For example,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1290 <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	1291 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	1292 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	1293 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	1294 </tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1295
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1296 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1297 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1298
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1299 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1300 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1301 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1302 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	1303 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1304 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1305
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1306 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1307
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1308
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1309 <directive name="location">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	1310 <syntax block="yes">[
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1311 <literal>=</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1312 <literal>~</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1313 <literal>~*</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1314 <literal>^~</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1315 ] <value>uri</value></syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1316 <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	1317 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1318 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1319 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1320
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1321 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1322 Sets a configuration based on a request URI.
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1323 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1324
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1325 <para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1326 The matching is performed against a normalized URI,
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1327 after decoding a text encoded in the “<literal>%XX</literal>” form,
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1328 resolving references to relative path components “<literal>.</literal>”
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1329 and “<literal>..</literal>”, and possible
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1330 <link id="merge_slashes">compression</link> of two or more
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1331 adjacent slashes into a single slash.
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1332 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1333
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1334 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1335 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	1336 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	1337 “<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	1338 “<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	1339 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	1340 locations defined using the prefix strings (prefix locations).
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	1341 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	1342 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	1343 in a configuration file.
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1344 A search of regular expressions terminates on the first match,
9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1345 and the corresponding configuration is used.
9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1346 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	1347 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	1348 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1349
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1350 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1351 Locations can be nested, with some exceptions mentioned below.
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1352 </para>
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1353
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1354 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1355 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	1356 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	1357 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	1358 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1359
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1360 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1361 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	1362 be used in other directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1363 </para>
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 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1366 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	1367 then regular expressions are not checked.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1368 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1369
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1370 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1371 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	1372 an exact match of URI and location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1373 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	1374 For example, if a “<literal>/</literal>” request happens frequently,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1375 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	1376 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	1377 comparison.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1378 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	1379 </para>
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 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1382 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1383 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	1384 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	1385 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	1386 not checked.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1387 </note>
57 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
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 Let's illustrate the above by example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1392 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1393 location = / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1394 [ configuration A ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1395 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1396
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1397 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1398 [ configuration B ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1399 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1400
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1401 location ^~ /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1402 [ configuration C ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1403 }
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 location ~* \.(gif\|jpg\|jpeg)$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1406 [ configuration D ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1407 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1408 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1409 The “<literal>/</literal>” request will match configuration A,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1410 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	1411 configuration B,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1412 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	1413 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	1414 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1415
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1416 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1417 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	1418 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	1419 used for request redirection.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1420 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	1421 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1422
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1423 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1424 <migration from="Apache" directive="Location" />
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1425 -->
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1428
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 <directive name="log_not_found">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1431 <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	1432 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1433 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1434 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1435 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1436
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1437 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1438 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	1439 <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	1440 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1443
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1444
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1445 <directive name="log_subrequest">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1446 <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	1447 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1448 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1449 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1450 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1451
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1452 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1453 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	1454 <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	1455 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1456
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1457 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1458
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1459
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1460 <directive name="max_ranges">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1461 <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	1462 <default/>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1463 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1464 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1465 <context>location</context>
499 76a8eca844d0 Documented that "max_ranges" appeared in 1.1.2. Ruslan Ermilov <ru@nginx.com> parents: 477 diff changeset	1466 <appeared-in>1.1.2</appeared-in>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1467
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1468 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1469 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	1470 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	1471 byte ranges specified.
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1472 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	1473 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	1474 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1475
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1476 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1477
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1478
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1479 <directive name="merge_slashes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1480 <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	1481 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1482 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1483 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1484
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1485 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1486 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	1487 in a URI into a single slash.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1488 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1491 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	1492 and regular expressions location matching.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1493 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	1494 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1495 location /scripts/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1496 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1498 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1499 and might be processed as a static file,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1500 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	1501 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1502
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1503 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1504 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	1505 contains base64-encoded names, since base64 uses the “<literal>/</literal>”
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1506 character internally.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1507 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	1508 the compression.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1509 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1510
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1511 <para>
442 b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	1512 A directive can be specified on the <link id="server"/> level
b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	1513 in a default server.
b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	1514 In this case, its value will cover all virtual servers
b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	1515 listening on the same address and port.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1516 </para>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1519
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1520
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1521 <directive name="msie_padding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1522 <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	1523 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1524 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1525 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1526 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1527
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1528 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1529 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	1530 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	1531 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1532
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1533 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1536 <directive name="msie_refresh">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1537 <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	1538 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1539 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1540 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1541 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1542
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1543 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1544 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	1545 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1548
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1549
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1550 <directive name="open_file_cache">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1551 <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	1552 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1553 <literal>max</literal>=<value>N</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1554 [<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	1555 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1556 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1557 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1558 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1559
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1560 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1561 Configures a cache that can store:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1562 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1563
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1564 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1565 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	1566 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1567
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1568 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1569 directory lookups;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1570 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1571
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1572 <listitem>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1573 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	1574 and so on.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1575 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1576 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	1577 <link id="open_file_cache_errors"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1578 directive.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1579 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1580 </listitem>
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 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1583 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1584
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1585 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1586 The directive has the following parameters:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1587 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1588
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1589 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1590 <literal>max</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1591 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1592 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1593 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	1594 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	1595 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1596
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1597 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1598 <literal>inactive</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1599 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1600 <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	1601 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	1602 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	1603 by default, it is 60 seconds;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1604 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1605
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1606 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1607 <literal>off</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1608 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1609 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1610 disables the cache.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1611 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1612
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1613 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1614 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1615
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1616 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1617 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1618 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1619 open_file_cache max=1000 inactive=20s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1620 open_file_cache_valid 30s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1621 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	1622 open_file_cache_errors on;<!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1623 open_file_cache_events on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1624 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1625 </example>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1628 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1631 <directive name="open_file_cache_errors">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1632 <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	1633 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1634 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1635 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1636 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1637
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1638 <para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1639 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	1640 <link id="open_file_cache"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1641 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1642
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1643 </directive>
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
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="open_file_cache_events">
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 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	1657 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1658 elements.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1659 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	1660 <link doc="../events.xml" id="kqueue"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1661 method only.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1662 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	1663 support events for arbitrary file system types.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1664 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	1665 file systems such as UFS or FFS.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1666 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1667
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1668 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1669
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1670 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1671
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1672
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1673 <directive name="open_file_cache_min_uses">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1674 <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	1675 <default>1</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1676 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1677 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1678 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1679
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1680 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1681 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	1682 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	1683 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	1684 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	1685 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1686
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1687 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1688
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1689
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1690 <directive name="open_file_cache_valid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1691 <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	1692 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1693 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1694 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1695 <context>location</context>
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 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	1699 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1700 elements should be validated.
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 When
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	1703 <link id="open_file_cache_events"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1704 is enabled, open file descriptors
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1705 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	1706 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1707 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1708
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1709 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1710
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1711
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1712 <directive name="optimize_server_names">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1713 <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	1714 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1715 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1716 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1717
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1718 <para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1719 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	1720 <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	1721 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1722
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1723 <!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1724 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1725 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	1726 virtual servers.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1727 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	1728 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	1729 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	1730 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	1731 server name is used in redirects.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1732 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	1733 optimization needs to be disabled.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1734 </para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1735 -->
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1736
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1737 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1738
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 <directive name="port_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1741 <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	1742 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1743 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1744 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1745 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1746
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1747 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1748 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	1749 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1750
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1751 <para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1752 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	1753 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	1754
57 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
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1758 <directive name="postpone_output">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1759 <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	1760 <default>1460</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1761 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1762 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1763 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1764
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1765 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1766 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	1767 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	1768 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	1769 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1770
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1771 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1772
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1773
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1774 <directive name="read_ahead">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1775 <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	1776 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1777 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1778 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1779 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1780
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1781 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1782 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	1783 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1784
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1785 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1786 On Linux, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1787 <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	1788 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	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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1792 On FreeBSD, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1793 <literal>fcntl(O_READAHEAD,</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1794 <value>size</value><literal>)</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1795 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	1796 FreeBSD 7 needs to be
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1797 <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	1798 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1799
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1800 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1801
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1802
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1803 <directive name="recursive_error_pages">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1804 <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	1805 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1806 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1807 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1808 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1809
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1810 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1811 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	1812 <link id="error_page"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1813 directive.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1814 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1815
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1816 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1817
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1818
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1819 <directive name="request_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1820 <syntax><value>size</value></syntax>
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1821 <default>4k</default>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1822 <context>http</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1823 <context>server</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1824
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1825 <para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1826 Allows to fine tune per-request memory allocations.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1827 This directive has minimal impact on performance,
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1828 and should not generally be used.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1829 </para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1830
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1831 </directive>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1832
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	1833
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1834 <directive name="reset_timedout_connection">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1835 <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	1836 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1837 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1838 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1839 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1840
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1841 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1842 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	1843 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	1844 <c-def>SO_LINGER</c-def>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1845 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	1846 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	1847 occupied by this socket is freed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1848 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	1849 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	1850 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1851
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1852 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1853 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	1854 closed normally.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1855 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1856
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1857 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1858
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1859
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1860 <directive name="resolver">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1861 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1862 <value>address</value> ...
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1863 [<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	1864 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1865 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1866 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1868
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1869 <para>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1870 Configures name servers used to resolve names of upstream servers
58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1871 into addresses, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1872 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1873 resolver 127.0.0.1 [::1]:5353;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1874 </example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1875 An address can be specified as a domain name or IP address,
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	1876 and an optional port (1.3.1, 1.2.2).
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1877 If port is not specified, the port 53 is used.
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1878 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	1879 <note>
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1880 Before version 1.1.7, only a single name server could be configured.
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1881 Specifying name servers using IPv6 addresses is supported
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	1882 starting from versions 1.3.1 and 1.2.2.
143 370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	1883 </note>
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1884 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	1885 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	1886 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	1887 resolver 127.0.0.1 [::1]:5353 valid=30s;
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1888 </example>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1889 <note>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	1890 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	1891 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	1892 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1893 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1894
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1895 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1896
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 <directive name="resolver_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1899 <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	1900 <default>30s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1901 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1902 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1903 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1904
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1905 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1906 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	1907 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1908 resolver_timeout 5s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1909 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1910 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1911
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1912 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1913
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1914
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1915 <directive name="root">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1916 <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	1917 <default>html</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1918 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1919 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1920 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1921 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1922
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1923 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1924 Sets the root directory for requests.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1925 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1926 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1928 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1929 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1930 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1931 “<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	1932 with the file
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	1933 <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	1934 </para>
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 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1937 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	1938 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	1939 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1940
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1941 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1942 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	1943 of the <literal>root</literal> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1944 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	1945 <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	1946 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1949
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 <directive name="satisfy">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1952 <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	1953 <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	1954 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	1955 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1956 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1957
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1958 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1959 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	1960 <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	1961 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	1962 modules grant access.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1963 </para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1964
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1965 <para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1966 Example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1967 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1968 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1969 satisfy any;
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 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1972 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1973
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1974 auth_basic "closed site";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1975 auth_basic_user_file conf/htpasswd;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1976 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1977 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1978 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1979
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1980 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1981
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 <directive name="satisfy_any">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1984 <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	1985 <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	1986 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	1987 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1988 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1989
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1990 <para>
406 98dac2bd7598 Links with mixed underscores and spaces were hard to read, eliminated them. Ruslan Ermilov <ru@nginx.com> parents: 400 diff changeset	1991 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	1992 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	1993 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1995 </directive>
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
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	1998 <directive name="send_lowat">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1999 <syntax><value>size</value></syntax>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2000 <default>0</default>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2001 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2002 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2003 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2004
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2005 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2006 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	2007 of send operations on client sockets by using either
553 6330ca27a485 Translated "events" into English. Ruslan Ermilov <ru@nginx.com> parents: 541 diff changeset	2008 <c-def>NOTE_LOWAT</c-def> flag of the
6330ca27a485 Translated "events" into English. Ruslan Ermilov <ru@nginx.com> parents: 541 diff changeset	2009 <link doc="../events.xml" id="kqueue"/> method,
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2010 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	2011 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	2012 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2013
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2014 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2015 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	2016 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2017
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2018 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2019
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2020
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2021 <directive name="send_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2022 <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	2023 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2024 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2025 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2026 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027
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 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	2030 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	2031 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	2032 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	2033 a connection is closed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2036 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2037
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2038
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2039 <directive name="sendfile">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2040
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2041 <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	2042 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2043 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2044 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2045 <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	2046 <context>if in location</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2047
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2050 <c-func>sendfile</c-func>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2054
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2055
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2056 <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	2057
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2058 <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	2059 <default>0</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2060 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2061 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2062 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2063
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2064 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2065 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	2066 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	2067 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	2068 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2069
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2070 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2071
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2072
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2073 <directive name="server">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2074 <syntax block="yes"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2075 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2076 <context>http</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 Sets a configuration for the virtual server.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2080 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	2081 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	2082 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	2083 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	2084 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	2085 <link id="server_name"/> directive lists all server names.
522 ef11546f75ee Translated "request_processing" into Russian, removed "virtual_hosts" Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	2086 Example configurations are provided in the
ef11546f75ee Translated "request_processing" into Russian, removed "virtual_hosts" Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	2087 “<link doc="request_processing.xml"/>” document.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2088 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2089
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2090 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2091
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 <directive name="server_name">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2094 <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	2095 <default>""</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2096 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2097
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2098 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2099 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	2100 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2101 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2102 server_name example.com www.example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2103 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2104 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2105 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2106
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2107 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2108 The first name becomes the primary server name.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2109 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	2110 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	2111 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2112 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2113 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	2114 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2115 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2116 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2117
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2118 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2119 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	2120 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2121 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2122 server_name .example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2123 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2124 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2125 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2126
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2127 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2128 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	2129 machine's hostname is substituted.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2130 </para>
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2131
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2132 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2133 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	2134 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	2135 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2137 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	2138 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2139 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2140 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2141
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2142 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2143 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	2144 be used in other directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2145 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2146 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2147 server_name ~^(www\.)?(.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2148
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2149 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2150 root /sites/$2;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2151 }
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 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2155 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2156
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2157 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2158 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2159 }
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2162 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2163
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2164 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2165 Named captures in regular expressions create variables (0.8.25)
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2166 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	2167 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2168 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2169 server_name ~^(www\.)?(?<domain>.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2170
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2171 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2172 root /sites/$domain;
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 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2175
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2176 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2177 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2179 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2180 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2181 }
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2184 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2185
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2186 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2187 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	2188 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2190 server_name www.example.com "";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2191 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2192 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2193 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	2194 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	2195 This is the default setting.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2196 <note>
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2197 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	2198 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2199 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2200
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2201 <para>
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2202 When searching for a virtual server by name,
5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2203 if name matches more than one of the specified variants,
5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2204 e.g. both mask and regular expression match, the first matching
5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2205 variant will be choosen, in the following order of precedence:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2206 <list type="enum">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2207
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2208 <listitem>
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2209 full name
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2210 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2211
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2212 <listitem>
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2213 longest name with a prefix mask,
5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2214 e.g. “<literal>*.example.com</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2215 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2216
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2217 <listitem>
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2218 longest name with a suffix mask,
5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2219 e.g. “<literal>mail.*</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2220 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2221
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2222 <listitem>
587 5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2223 first matching regular expression
5bb7716cae7e Documented in more depth how server names are matched. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	2224 (in order of appearance in a configuration file)
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2225 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2226
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2227 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2228 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2229
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2230 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2231
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2232
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2233 <directive name="server_name_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2234 <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	2235 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2236 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2237 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2238 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2239
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2240 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2241 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	2242 <link id="server_name"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2243 directive, in redirects issued by nginx.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2244 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	2245 is used.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2246 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	2247 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2248
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2249 <para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2250 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	2251 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2252
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2253 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2256 <directive name="server_names_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2257 <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	2258 <default>32\|64\|128</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2259 <context>http</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2262 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	2263 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	2264 For more information, please refer to
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2265 <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	2266 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2267
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2268 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2269
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2270
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2271 <directive name="server_names_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2272 <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	2273 <default>512</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2274 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2275
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2276 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2277 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	2278 For more information, please refer to
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2279 <link doc="../hash.xml">Setting Up Hashes</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2280 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2281
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2282 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2283
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2284
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2285 <directive name="server_tokens">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2286 <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	2287 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2288 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2289 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2290 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2293 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	2294 <header>Server</header> response header field.
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2298
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2299
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2300 <directive name="tcp_nodelay">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2301 <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	2302 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2303 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2304 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2305 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2308 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	2309 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	2310 keep-alive state.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2311 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2314
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2315
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2316 <directive name="tcp_nopush">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2317 <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	2318 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2319 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2320 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2321 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2322
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2323 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2324 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2325 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	2326 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	2327 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	2328 Enabling the option allows to
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2329 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2330
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2331 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2332 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	2333 on Linux and FreeBSD 4.*;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2334 </listitem>
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 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2337 send a file in full packets.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2338 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2339
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2340 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2341 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2342
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2343 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2344
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2345
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2346 <directive name="try_files">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2347 <syntax><value>file</value> ... <value>uri</value></syntax>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2348 <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	2349 <default/>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2350 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2351 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2352
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2353 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2354 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	2355 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	2356 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	2357 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	2358 <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	2359 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	2360 <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	2361 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	2362 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	2363 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	2364 <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	2365 For example:
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2366 <example>
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2367 location /images/ {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2368 try_files $uri /images/default.gif;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2369 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2370
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2371 location = /images/default.gif {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2372 expires 30s;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2373 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2374 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2375 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	2376 see examples below.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2377 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	2378 <value>code</value>:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2379 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2380 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2381 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	2382 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2383 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2384 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2385
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2386 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2387 Example when proxying Mongrel:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2388 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2389 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2390 try_files /system/maintenance.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2391 $uri $uri/index.html $uri.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2392 @mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2393 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2394
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2395 location @mongrel {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2396 proxy_pass http://mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2397 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2398 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2399 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2400
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2401 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2402 Example for Drupal/FastCGI:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2403 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2404 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2405 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2406 }
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 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2409 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2410
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2411 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2412
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2413 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	2414 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2415 fastcgi_param QUERY_STRING $args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2416
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2417 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2418 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2419
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2420 location @drupal {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2421 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2422
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2423 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	2424 fastcgi_param SCRIPT_NAME /index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2425 fastcgi_param QUERY_STRING q=$uri&$args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2426
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2427 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2428 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2429 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2430 In the following example,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2431 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2432 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2433 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2434 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2435 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2436 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	2437 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2438 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2439 error_page 404 = @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2440 log_not_found off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2441 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2442 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2443 And here,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2444 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2445 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2446 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2447
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2448 fastcgi_pass ...;
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 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	2451
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2452 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2453 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2454 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2455 <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	2456 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	2457 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2458
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2459 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2460 Example for Wordpress and Joomla:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2461 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2462 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2463 try_files $uri $uri/ @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2464 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2465
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2466 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2467 try_files $uri @wordpress;
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 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2470
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2471 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	2472 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2473 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2474
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2475 location @wordpress {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2476 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2477
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2478 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	2479 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2480 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2481 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2482 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2483
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2484 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2485
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2486
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2487 <directive name="types">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2488 <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	2489 <default>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2490 text/html html;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2491 image/gif gif;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2492 image/jpeg jpg;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2493 </default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2494 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2495 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2496 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2497
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2498 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2499 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	2500 Extensions are case-insensitive.
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2501 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	2502 <example>
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2503 types {
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2504 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	2505 application/octet-stream deb;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2506 application/octet-stream dmg;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2507 }
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2508 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2509 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2510
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2511 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2512 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	2513 <path>conf/mime.types</path> file.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2514 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2515
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2516 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2517 To make a particular location emit the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2518 “<literal>application/octet-stream</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2519 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	2520 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2521 location /download/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2522 types { }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2523 default_type application/octet-stream;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2524 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2525 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2526 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2527
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2529
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2530
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2531 <directive name="types_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2532 <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	2533 <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	2534 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2535 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2536 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2537
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2538 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2539 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	2540 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	2541 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	2542 <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	2543 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2544
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2545 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2546
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2547
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2548 <directive name="types_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2549 <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	2550 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2551 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2552 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2553 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2554
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2555 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2556 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	2557 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	2558 <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	2559 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2560
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2561 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2562
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2563
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2564 <directive name="underscores_in_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2565 <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	2566 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2567 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2568 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2569
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2570 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2571 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	2572 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	2573 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	2574 directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2575 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2576
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2577 <para>
442 b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	2578 A directive can be specified on the <link id="server"/> level
b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	2579 in a default server.
b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	2580 In this case, its value will cover all virtual servers
b423d725a932 Try to emphasize that "underscores_in_headers" and "merge_slashes", Ruslan Ermilov <ru@nginx.com> parents: 438 diff changeset	2581 listening on the same address and port.
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2582 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	2583
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2584 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2585
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2586
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2587 <directive name="variables_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2588 <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	2589 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2590 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2591
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2592 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2593 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	2594 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	2595 <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	2596 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2597
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2598 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2599
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2600
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2601 <directive name="variables_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2602 <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	2603 <default>512</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2604 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2605
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2606 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2607 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	2608 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	2609 <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	2610 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2611
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2612 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2613
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2614 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2615
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2616
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2617 <section id="variables" name="Embedded Variables">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2618
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2619 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2620 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	2621 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	2622 First of all, these are variables representing client request header
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2623 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	2624 and so on.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2625 It also supports other variables:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2626 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2627
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2628 <tag-name><var>$arg_</var><value>name</value></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2629 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2630 argument <value>name</value> in the request line
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2631 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2632
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2633 <tag-name><var>$args</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2634 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2635 arguments in the request line
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2636 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2637
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2638 <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	2639 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2640 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	2641 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2642
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2643 <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	2644 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2645 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	2646 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2647
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2648 <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	2649 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2650 <header>Content-Length</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2651 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2652
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2653 <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	2654 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2655 <header>Content-Type</header> request header field
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
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2658 <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	2659 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2660 the <value>name</value> cookie
57 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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2663 <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	2664 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2665 <link id="root"/> or <link id="alias"/> directive's value
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2666 for the current request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2667 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2668
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2669 <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	2670 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2671 same as <var>$uri</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2672 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2673
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2674 <tag-name><var>$host</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2675 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2676 <header>Host</header> request header field,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2677 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	2678 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2679
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 <tag-name><var>$hostname</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2681 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2682 host name
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2683 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2684
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2685 <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	2686 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2687 arbitrary request header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2688 the last part of a variable name is the field name converted
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2689 to lower case with dashes replaced by underscores
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2690 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2691
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2692 <tag-name><var>$https</var></tag-name>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2693 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2694 “<literal>on</literal>”
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2695 if connection operates in SSL mode,
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2696 or an empty string otherwise
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2697 </tag-desc>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	2698
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2699 <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	2700 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2701 “<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	2702 or an empty string otherwise
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2703 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2704
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2705 <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	2706 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2707 allows for connection rate limiting
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2708 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2709
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2710 <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	2711 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2712 nginx version
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2713 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2714
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2715 <tag-name><var>$pid</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2716 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2717 PID of the worker process
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2718 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2719
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2720 <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	2721 <tag-desc>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2722 same as <var>$args</var>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2723 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2724
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2725 <tag-name><var>$realpath_root</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2726 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2727 an absolute pathname corresponding to the
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2728 <link id="root"/> or <link id="alias"/> directive's value
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2729 for the current request,
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	2730 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	2731 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2732
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2733 <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	2734 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2735 client address
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2736 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2737
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2738 <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	2739 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2740 client port
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2741 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2742
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2743 <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	2744 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2745 user name supplied with the Basic authentication
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2746 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2747
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2748 <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	2749 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2750 full original request line
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2751 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2752
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2753 <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	2754 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2755 request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2756 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2757 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	2758 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	2759 <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	2760 and
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2761 <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	2762 directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2763 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2764 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2765
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2766 <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	2767 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2768 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	2769 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2770 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	2771 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	2772 <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	2773 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	2774 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	2775 passing of the request body should be disabled by the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2776 <link doc="ngx_http_proxy_module.xml" id="proxy_pass_request_body">
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2777 proxy_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2778 and
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2779 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass_request_body">
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2780 fastcgi_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2781 directives, respectively.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2782 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2783 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2784
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2785 <tag-name><var>$request_completion</var></tag-name>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2786 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2787 “<literal>OK</literal>” if a request has completed,
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2788 or an empty string otherwise
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2789 </tag-desc>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	2790
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2791 <tag-name><var>$request_filename</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2792 <tag-desc>
530 d8c7160527ae query -> request Ruslan Ermilov <ru@nginx.com> parents: 527 diff changeset	2793 file path for the current request, based on the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2794 <link id="root"/> or <link id="alias"/>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2795 directives, and the request URI
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2796 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2797
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2798 <tag-name><var>$request_method</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2799 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2800 request method, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2801 “<literal>GET</literal>” or “<literal>POST</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2802 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2803
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2804 <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	2805 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2806 full original request URI (with arguments)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2807 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2808
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2809 <tag-name><var>$scheme</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2810 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2811 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	2812 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2813
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2814 <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	2815 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2816 arbitrary response header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2817 the last part of a variable name is the field name converted
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	2818 to lower case with dashes replaced by underscores
86 341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2819 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	2820
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2821 <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	2822 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2823 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	2824 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2825 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	2826 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	2827 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	2828 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2829 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2830
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2831 <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	2832 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2833 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	2834 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2835
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2836 <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	2837 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2838 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	2839 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2840
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2841 <tag-name><var>$server_protocol</var></tag-name>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2842 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2843 request protocol, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2844 “<literal>HTTP/1.0</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2845 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2846 “<literal>HTTP/1.1</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2847 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	2848
541 a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	2849 <tag-name><var>$status</var></tag-name>
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	2850 <tag-desc>
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	2851 response status
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	2852 </tag-desc>
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	2853
453 98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2854 <tag-name>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2855 <var>$tcpinfo_rtt</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2856 <var>$tcpinfo_rttvar</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2857 <var>$tcpinfo_snd_cwnd</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2858 <var>$tcpinfo_rcv_space</var>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2859 </tag-name>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2860 <tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2861 information about the client TCP connection; available on systems
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2862 that support the <c-def>TCP_INFO</c-def> socket option
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2863 </tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	2864
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2865 <tag-name><var>$uri</var></tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2866 <tag-desc>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	2867 current URI in request, <link id="location">normalized</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2868 <para>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	2869 The value of <var>$uri</var> may change during request processing,
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	2870 e.g. when doing internal redirects, or when using index files.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2871 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2872 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2873
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2874 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2875 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2876
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2877 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2878
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2879 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_core_module.xml @ 589:764fbac1b8b4