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

annotate xml/en/docs/http/ngx_http_core_module.xml @ 1031:f7f23f5928ef

Documented "resolver ipv6=" parameter.

author	Ruslan Ermilov <ru@nginx.com>
date	Fri, 13 Dec 2013 21:02:08 +0400
parents	e47971bf6619
children	e9c485d6cc0c

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

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_core_module.xml @ 1031:f7f23f5928ef