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

annotate xml/en/docs/http/ngx_http_core_module.xml @ 3083:3b5594157fab

Documented max_headers directive.

author	Maxim Dounin <mdounin@mdounin.ru>
date	Fri, 24 May 2024 01:16:29 +0300
parents	9eadb98ec770
children

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"
3083 3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	13 rev="108">
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="directives" name="Directives">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
1879 3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	17 <directive name="absolute_redirect">
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	18 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	19 <default>on</default>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	20 <context>http</context>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	21 <context>server</context>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	22 <context>location</context>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	23 <appeared-in>1.11.8</appeared-in>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	24
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	25 <para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	26 If disabled, redirects issued by nginx will be relative.
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	27 </para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	28
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	29 <para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	30 See also <link id="server_name_in_redirect"/>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	31 and <link id="port_in_redirect"/> directives.
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	32 </para>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	33
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	34 </directive>
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	35
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	36
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	37 <directive name="aio">
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	38 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	39 <literal>on</literal> \|
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	40 <literal>off</literal> \|
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	41 <literal>threads</literal>[<literal>=</literal><value>pool</value>]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	42 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	46 <appeared-in>0.8.11</appeared-in>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 Enables or disables the use of asynchronous file I/O (AIO)
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	50 on FreeBSD and Linux:
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	51 <example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	52 location /video/ {
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	53 aio on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	54 output_buffers 1 64k;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	55 }
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	56 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	60 On FreeBSD, AIO can be used starting from FreeBSD 4.3.
1859 5cd4964fbc5f Updated AIO description for FreeBSD 11.0 and upwards. Sergey Kandaurov <pluknet@nginx.com> parents: 1827 diff changeset	61 Prior to FreeBSD 11.0,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 AIO can either be linked statically into a kernel:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 options VFS_AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 or loaded dynamically as a kernel loadable module:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 kldload aio
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	72 <!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 In FreeBSD versions 5 and 6, enabling AIO statically, or dynamically
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 when booting the kernel, will cause the entire networking subsystem
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	76 to use the Giant lock, which can impact overall performance negatively.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 This limitation has been removed in FreeBSD 6.4-STABLE in 2009, and in
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 FreeBSD 7.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 However, starting from FreeBSD 5.3 it is possible to enable AIO
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 without the penalty of running the networking subsystem under a
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 Giant lock—for this to work, the AIO module needs to be loaded
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 after the kernel has booted.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 In this case, the following message will appear in
148 682163f2b298 Unified article/path and module/pathname into a single "path". Ruslan Ermilov <ru@nginx.com> parents: 147 diff changeset	84 <path>/var/log/messages</path>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 WARNING: Network stack Giant-free, but aio requires Giant.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 Consider adding 'options NET_WITH_GIANT' or setting debug.mpsafenet=0
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 and can safely be ignored.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 <note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 The requirement to use the Giant lock with AIO is related to the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 fact that FreeBSD supports asynchronous calls
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 <c-func>aio_read</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 and
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 <c-func>aio_write</c-func>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 when working with sockets.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	97 However, since nginx uses AIO only for disk I/O, no problems should arise.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 </note>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 </para>
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	100 -->
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	103 On Linux, AIO can be used starting from kernel version 2.6.22.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	104 Also, it is necessary to enable
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	105 <link id="directio"/>,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	106 or otherwise reading will be blocking:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 location /video/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 aio on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 directio 512;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 output_buffers 1 128k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 On Linux,
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	118 <link id="directio"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 can only be used for reading blocks that are aligned on 512-byte
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 boundaries (or 4K for XFS).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	121 File’s unaligned end is read in blocking mode.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	122 The same holds true for byte range requests and for FLV requests
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 not from the beginning of a file: reading of unaligned data at the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 beginning and end of a file will be blocking.
1430 0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	125 </para>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	126
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	127 <para>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	128 When both AIO and <link id="sendfile"/> are enabled on Linux,
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	129 AIO is used for files that are larger than or equal to
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	130 the size specified in the <link id="directio"/> directive,
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	131 while <link id="sendfile"/> is used for files of smaller sizes
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	132 or when <link id="directio"/> is disabled.
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	133 <example>
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	134 location /video/ {
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	135 sendfile on;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	136 aio on;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	137 directio 8m;
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	138 }
0eb8e261f349 AIO: clarified the use of both AIO and sendfile on Linux. Ruslan Ermilov <ru@nginx.com> parents: 1414 diff changeset	139 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	142 <para>
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	143 Finally, files can be read and <link id="sendfile">sent</link>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	144 using multi-threading (1.7.11),
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	145 without blocking a worker process:
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	146 <example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	147 location /video/ {
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	148 sendfile on;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	149 aio threads;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	150 }
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	151 </example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	152 Read and send file operations are offloaded to threads of the specified
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	153 <link doc="../ngx_core_module.xml" id="thread_pool">pool</link>.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	154 If the pool name is omitted,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	155 the pool with the name “<literal>default</literal>” is used.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	156 The pool name can also be set with variables:
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	157 <example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	158 aio threads=pool$disk;
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	159 </example>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	160 By default, multi-threading is disabled, it should be
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	161 enabled with the
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	162 <literal>--with-threads</literal> configuration parameter.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	163 Currently, multi-threading is compatible only with the
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	164 <link doc="../events.xml" id="epoll"/>,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	165 <link doc="../events.xml" id="kqueue"/>,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	166 and
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	167 <link doc="../events.xml" id="eventport"/> methods.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	168 Multi-threaded sending of files is only supported on Linux.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	169 </para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	170
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1432 diff changeset	171 <para>
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	172 See also the <link id="sendfile"/> directive.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	173 </para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	174
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177
1664 1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	178 <directive name="aio_write">
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	179 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	180 <default>off</default>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	181 <context>http</context>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	182 <context>server</context>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	183 <context>location</context>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	184 <appeared-in>1.9.13</appeared-in>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	185
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	186 <para>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	187 If <link id="aio"/> is enabled, specifies whether it is used for writing files.
1665 57b53a0818df Slightly paraphrased aio_write description for better perception. Ruslan Ermilov <ru@nginx.com> parents: 1664 diff changeset	188 Currently, this only works when using
1664 1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	189 <literal>aio threads</literal>
1665 57b53a0818df Slightly paraphrased aio_write description for better perception. Ruslan Ermilov <ru@nginx.com> parents: 1664 diff changeset	190 and is limited to writing temporary files
57b53a0818df Slightly paraphrased aio_write description for better perception. Ruslan Ermilov <ru@nginx.com> parents: 1664 diff changeset	191 with data received from proxied servers.
1664 1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	192 </para>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	193
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	194 </directive>
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	195
1a05fd32dca8 Documented the "aio_write" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1636 diff changeset	196
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 <directive name="alias">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	198 <syntax><value>path</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 Defines a replacement for the specified location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	210 on request of
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	211 “<literal>/i/top.gif</literal>”, the file
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	212 <path>/data/w3/images/top.gif</path> will be sent.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	216 The <value>path</value> value can contain variables,
65 f122a777a6de - Use of $document_root and $realpath_root in "alias" is prohibited. Ruslan Ermilov <ru@nginx.com> parents: 57 diff changeset	217 except <var>$document_root</var> and <var>$realpath_root</var>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	221 If <literal>alias</literal> is used inside a location defined
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 with a regular expression then such regular expression should
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	223 contain captures and <literal>alias</literal> should refer to
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 these captures (0.7.40), for example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 location ~ ^/users/(.+\.(?:gif\|jpe?g\|png))$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 alias /data/w3/images/$1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 <para>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	233 When location matches the last part of the directive’s value:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 alias /data/w3/images/;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 it is better to use the
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	240 <link id="root"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 directive instead:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 location /images/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251
2523 2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	252 <directive name="auth_delay">
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	253 <syntax><value>time</value></syntax>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	254 <default>0s</default>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	255 <context>http</context>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	256 <context>server</context>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	257 <context>location</context>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	258 <appeared-in>1.17.10</appeared-in>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	259
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	260 <para>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	261 Delays processing of unauthorized requests with 401 response code
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	262 to prevent timing attacks when access is limited by
3043 9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	263 <link doc="ngx_http_auth_basic_module.xml">password</link> or by the
9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	264 <link doc="ngx_http_auth_request_module.xml">result of subrequest</link>.
2523 2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	265 </para>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	266
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	267 </directive>
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	268
2bb06b3fbcc5 Documented the "auth_delay" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2458 diff changeset	269
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	270 <directive name="chunked_transfer_encoding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	271 <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	272 <default>on</default>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	273 <context>http</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	274 <context>server</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	275 <context>location</context>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	276
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	277 <para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	278 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	279 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	280 chunked encoding despite the standard’s requirement.
162 a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	281 </para>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	282
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	283 </directive>
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	284
a8bd350e3481 Documented the "chunked_transfer_encoding" directive. Ruslan Ermilov <ru@nginx.com> parents: 161 diff changeset	285
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	286 <directive name="client_body_buffer_size">
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	287
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	288 <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	289 <default>8k\|16k</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	290 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	291 <context>server</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	292 <context>location</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	293
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	294 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	295 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	296 In case the request body is larger than the buffer,
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	297 the whole body or only its part is written to a
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	298 <link id="client_body_temp_path">temporary file</link>.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	299 By default, buffer size is equal to two memory pages.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	300 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	301 It is usually 16K on other 64-bit platforms.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	302 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	303
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	304 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	305
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	306
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <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	308 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	309 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	310 <literal>clean</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	311 <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	312 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 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	319 into a file.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 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	321 <var>$request_body_file</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 variable, or the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 <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	324 method of the module
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325 <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	326 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	329 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	330 removed after request processing.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	334 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	335 left after request processing to be removed.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	337
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 <directive name="client_body_in_single_buffer">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	342 <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	343 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	344 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 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	350 in a single buffer.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 The directive is recommended when using the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 <var>$request_body</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 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	354 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 <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	360 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	361 <value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	362 [<value>level1</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	363 [<value>level2</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	364 [<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	365 <default>client_body_temp</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 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	372 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	373 directory.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374 For example, in the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 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	377 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	378 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	379 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 /spool/nginx/client_temp/7/45/00000123457
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 <directive name="client_body_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	388 <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	389 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	391 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	395 Defines a timeout for reading client request body.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	396 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	397 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	398 If a client does not transmit anything within this time, the
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	399 request is terminated with the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 <http-status code="408" text="Request Time-out"/>
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	401 error.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	402 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	403
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407 <directive name="client_header_buffer_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	408 <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	409 <default>1k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 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	415 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	416 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	417 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	418 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	419 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	420 <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	421 are allocated.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423
2795 691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	424 <para>
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	425 If the directive is specified on the <link id="server"/> level,
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	426 the value from the default server can be used.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	427 Details are provided in the
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	428 “<link doc="server_names.xml" id="virtual_server_selection">Virtual
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	429 server selection</link>” section.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	430 </para>
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	431
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	434
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 <directive name="client_header_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	436 <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	437 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 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	443 If a client does not transmit the entire header within this time, the
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	444 request is terminated with the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 <http-status code="408" text="Request Time-out"/>
2220 896562a1ccde Fixed description of client_header_timeout and client_body_timeout. Sergey Kandaurov <pluknet@nginx.com> parents: 2206 diff changeset	446 error.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 <directive name="client_max_body_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	453 <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	454 <default>1m</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	455 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	456 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 <para>
2657 679fb7712ab4 Updated client_max_body_size for chunked encoding and HTTP/2. Sergey Kandaurov <pluknet@nginx.com> parents: 2593 diff changeset	460 Sets the maximum allowed size of the client request body.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	461 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	462 <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	463 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 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	465 <!--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	466 this error<!--/link-->.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	467 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	468 request body size.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	474 <directive name="connection_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	475 <syntax><value>size</value></syntax>
1619 88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	476 <default>256\|512</default>
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	477 <context>http</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	478 <context>server</context>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	479
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	480 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	481 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	482 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	483 and should not generally be used.
1619 88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	484 By default, the size is equal to
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	485 256 bytes on 32-bit platforms and 512 bytes on 64-bit platforms.
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	486 <note>
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	487 Prior to version 1.9.8, the default value was 256 on all platforms.
88ad8fcea975 Changed default value of connection_pool_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1614 diff changeset	488 </note>
161 ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	489 </para>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	490
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	491 </directive>
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	492
ec980064d576 Documented the "connection_pool_size" and "request_pool_size" directives. Ruslan Ermilov <ru@nginx.com> parents: 160 diff changeset	493
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494 <directive name="default_type">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	495 <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	496 <default>text/plain</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	498 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	499 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	500
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	501 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	502 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	503 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	504 with the <link id="types"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	505 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	506
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	507 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	508
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	509
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	510 <directive name="directio">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	511 <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	512 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	513 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	515 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	516 <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	517
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	518 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 Enables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	520 the <c-def>O_DIRECT</c-def> flag (FreeBSD, Linux),
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	521 the <c-def>F_NOCACHE</c-def> flag (macOS),
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	522 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	523 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	524 the specified <value>size</value>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	525 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	526 <link id="sendfile"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	527 for a given request.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	528 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	529 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	530 directio 4m;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	531 </example>
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	532 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	533 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	534
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	535 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	536
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	537
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	538 <directive name="directio_alignment">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	539 <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	540 <default>512</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	541 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	542 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	543 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	544 <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	545
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	546 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	547 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	548 <link id="directio"/>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	549 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	550 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	551 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	552
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	553 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	554
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	555
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	556 <directive name="disable_symlinks">
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	557 <syntax><literal>off</literal></syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	558 <syntax>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	559 <literal>on</literal> \|
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	560 <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	561 [<literal>from</literal>=<value>part</value>]</syntax>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	562 <default>off</default>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	563 <context>http</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	564 <context>server</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	565 <context>location</context>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	566 <appeared-in>1.1.15</appeared-in>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	567
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	568 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	569 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	570 <list type="tag">
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	571
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	572 <tag-name><literal>off</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	573 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	574 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	575 This is the default behavior.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	576 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	577
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	578 <tag-name><literal>on</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	579 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	580 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	581 access to a file is denied.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	582 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	583
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	584 <tag-name><literal>if_not_owner</literal></tag-name>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	585 <tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	586 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	587 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	588 points to have different owners.
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	589 </tag-desc>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	590
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	591 <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	592 <tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	593 When checking symbolic links
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	594 (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	595 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	596 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	597 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	598 <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	599 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	600 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	601 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	602 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	603 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	604 symbolic links are not checked.
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	605 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	606 </tag-desc>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	607
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	608 </list>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	609 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	610
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	611 <para>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	612 Example:
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	613 <example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	614 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	615 </example>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	616 </para>
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	617
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	618 <para>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	619 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	620 <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	621 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	622 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	623
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	624 <para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	625 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	626 add a processing overhead.
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	627 <note>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	628 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	629 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	630 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	631 </note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	632 </para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	633
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	634 <para>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	635 <note>
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	636 The
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	637 <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	638 <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	639 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	640 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	641 </note>
418 2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	642 </para>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	643
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	644 </directive>
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	645
2638f67205ee Documented the disable_symlinks directive. Ruslan Ermilov <ru@nginx.com> parents: 406 diff changeset	646
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	647 <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	648 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	649 <value>code</value> ...
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	650 [<literal>=</literal>[<value>response</value>]]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	651 <value>uri</value></syntax>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	652 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	653 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	654 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	658 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	659 Defines the URI that will be shown for the specified errors.
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	660 A <value>uri</value> value can contain variables.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	661 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	662
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	663 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	664 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	665 <example>
711 1f383a8bccdb Minor improvements over the recent additions to the "error_page" directive. Ruslan Ermilov <ru@nginx.com> parents: 709 diff changeset	666 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	667 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	668 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	669 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	670
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	671 <para>
1827 64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	672 This causes an internal redirect to the specified <value>uri</value>
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	673 with the client request method changed to “<literal>GET</literal>”
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	674 (for all methods other than
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	675 “<literal>GET</literal>” and “<literal>HEAD</literal>”).
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	676 </para>
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	677
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	678 <para>
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	679 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	680 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	681 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	682 error_page 404 =200 /empty.gif;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	685
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	686 <para>
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	687 If an error response is processed by a proxied server
2134 4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	688 or a FastCGI/uwsgi/SCGI/gRPC server,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	689 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	690 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	691 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	692 error_page 404 = /404.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	693 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	694 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	695
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	696 <para>
1827 64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	697 If there is no need to change URI and method during internal redirection
64e2b8c5200d Documented request method change by error_page in /uri redirection. Ruslan Ermilov <ru@nginx.com> parents: 1826 diff changeset	698 it is possible to pass error processing into a named location:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	699 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	700 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	701 error_page 404 = @fallback;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	702 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	703
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	704 location @fallback {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	705 proxy_pass http://backend;
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	708 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	709
679 9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	710 <para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	711 <note>
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	712 If <value>uri</value> processing leads to an error,
747 ddec437b692b Fixed a number of typos. Vladimir Homutov <vl@nginx.com> parents: 741 diff changeset	713 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	714 </note>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	715 </para>
9888364847b7 Documented status codes in the error_page directive. Vladimir Homutov <vl@nginx.com> parents: 674 diff changeset	716
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	717 <para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	718 It is also possible to use URL redirects for error processing:
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	719 <example>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	720 error_page 403 http://example.com/forbidden.html;
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	721 error_page 404 =301 http://example.com/notfound.html;
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	722 </example>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	723 In this case, by default, the response code 302 is returned to the client.
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	724 It can only be changed to one of the redirect status
1964 2a3c58dcb3e8 Documented support for the 308 Permanent Redirect. Yaroslav Zhuravlev <yar@nginx.com> parents: 1953 diff changeset	725 codes (301, 302, 303, 307, and 308).
2039 d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	726 <note>
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	727 The code 307 was not treated as a redirect until versions 1.1.16 and 1.0.13.
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	728 </note>
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	729
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	730 <note>
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	731 The code 308 was not treated as a redirect until version 1.13.0.
d2969b2f69ae Added history notes about codes 201, 307, and 308. Yaroslav Zhuravlev <yar@nginx.com> parents: 2036 diff changeset	732 </note>
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	733 </para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	734
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	735 <para>
2593 eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2567 diff changeset	736 These directives are inherited from the previous configuration level
eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2567 diff changeset	737 if and only if there are no <literal>error_page</literal> directives
eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2567 diff changeset	738 defined on the current level.
1826 da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	739 </para>
da6a3e401b26 Slightly reformatted the error_page description. Ruslan Ermilov <ru@nginx.com> parents: 1770 diff changeset	740
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	741 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	742
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	743
576 cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	744 <directive name="etag">
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	745 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	746 <default>on</default>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	747 <context>http</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	748 <context>server</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	749 <context>location</context>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	750 <appeared-in>1.3.3</appeared-in>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	751
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	752 <para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	753 Enables or disables automatic generation of the <header>ETag</header>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	754 response header field for static resources.
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	755 </para>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	756
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	757 </directive>
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	758
cac22cc79afd Documented the "etag" directive. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	759
651 eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	760 <directive name="http">
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	761 <syntax block="yes"/>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	762 <default/>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	763 <context>main</context>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	764
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	765 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	766 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	767 are specified.
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	768 </para>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	769
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	770 </directive>
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	771
eba81bfb6aaf Documented the "http" directive. Vladimir Homutov <vl@nginx.com> parents: 628 diff changeset	772
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	773 <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	774 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	775 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	776 <literal>exact</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	777 <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	778 <default>exact</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	779 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	780 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	781 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	782 <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	783
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	784 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	785 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	786 with the time in the
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	787 <header>If-Modified-Since</header>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	788 request header field:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	789
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	790 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	791
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	792 <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	793 <tag-desc>
2921 52ea1f45b324 Clarified "if_modified_since off" behaviour (ticket #2176). Maxim Dounin <mdounin@mdounin.ru> parents: 2912 diff changeset	794 the response is always considered modified (0.7.34);
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	795 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	796
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	797 <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	798 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	799 exact match;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	800 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	801
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	802 <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	803 <tag-desc>
2922 547303412ab9 Fixed article in "if_modified_since before". Maxim Dounin <mdounin@mdounin.ru> parents: 2921 diff changeset	804 modification time of the response is
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	805 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	806 request header field.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	807 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	808
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	809 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	810 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	811
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	812 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	813
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	814
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	815 <directive name="ignore_invalid_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	816 <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	817 <default>on</default>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	818 <context>http</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	819 <context>server</context>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	820
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	821 <para>
235 6d8356490215 Consistently call header fields as such. Ruslan Ermilov <ru@nginx.com> parents: 234 diff changeset	822 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	823 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	824 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	825 directive).
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	826 </para>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	827
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	828 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	829 If the directive is specified on the <link id="server"/> level,
2795 691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	830 the value from the default server can be used.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	831 Details are provided in the
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	832 “<link doc="server_names.xml" id="virtual_server_selection">Virtual
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	833 server selection</link>” section.
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	834 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	835
152 5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	836 </directive>
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	837
5a35535f7cdf Documented the "ignore_invalid_headers" directive. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	838
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	839 <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	840 <syntax/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	841 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	842 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	845 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	846 For external requests, the client error
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	847 <http-status code="404" text="Not Found"/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	848 is returned.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	849 Internal requests are the following:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	850
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	851 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	852
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	853 <listitem>
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	854 requests redirected by the
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	855 <link id="error_page"/>,
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	856 <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	857 <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	858 <link id="try_files"/> directives;
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	859 </listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	860
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	861 <listitem>
2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	862 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	863 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	864 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	865
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	866 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	867 subrequests formed by the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	868 “<command>include virtual</command>”
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	869 command of the
b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	870 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>
2036 ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	871 module, by the
438 b27974b92a58 - corrected the description of the from= parameter of the Ruslan Ermilov <ru@nginx.com> parents: 436 diff changeset	872 <link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link>
2036 ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	873 module directives, and by
ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	874 <link doc="ngx_http_auth_request_module.xml" id="auth_request"/> and
ee0aeddbe8a2 Updated types of subrequests allowed in the internal location. Sergey Kandaurov <pluknet@nginx.com> parents: 2003 diff changeset	875 <link doc="ngx_http_mirror_module.xml" id="mirror"/> directives;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	876 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	877
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	878 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	879 requests changed by the
429 2b9507b2cdf3 List all sources of internal requests. Ruslan Ermilov <ru@nginx.com> parents: 426 diff changeset	880 <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	881 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	882
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	883 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	884 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	885
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	886 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	887 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	888 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	889 error_page 404 /404.html;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	890
2206 5cacd6fffade Eliminated some examples of unsafe prefix locations. Ruslan Ermilov <ru@nginx.com> parents: 2199 diff changeset	891 location = /404.html {
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	892 internal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	893 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	894 </example>
674 c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	895 <note>
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	896 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	897 request processing cycles that can occur in incorrect configurations.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	898 If this limit is reached, the error
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	899 <http-status code="500" text="Internal Server Error"/> is returned.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	900 In such cases, the “rewrite or internal redirection cycle” message
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	901 can be seen in the error log.
c48c0936b4df Documented internal redirections limit. Vladimir Homutov <vl@nginx.com> parents: 659 diff changeset	902 </note>
57 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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	905 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	906
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	907
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	908 <directive name="keepalive_disable">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	909 <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	910 <default>msie6</default>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	911 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	912 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	913 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	914
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	915 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	916 Disables keep-alive connections with misbehaving browsers.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	917 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	918 browsers will be affected.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	919 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	920 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	921 The value <literal>safari</literal> disables keep-alive connections
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	922 with Safari and Safari-like browsers on macOS and macOS-like
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	923 operating systems.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	924 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	925 with all browsers.
467 c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	926 <note>
c505c92c8658 Documented recent changes to the "keepalive_disable" directive. Ruslan Ermilov <ru@nginx.com> parents: 454 diff changeset	927 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	928 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	929 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	930 </note>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	931 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	932
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	933 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	934
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	935
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	936 <directive name="keepalive_requests">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	937 <syntax><value>number</value></syntax>
2706 4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	938 <default>1000</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	939 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	940 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	941 <context>location</context>
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	942 <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	943
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	944 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	945 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	946 served through one keep-alive connection.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	947 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	948 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	949
2450 a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	950 <para>
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	951 Closing connections periodically is necessary to free
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	952 per-connection memory allocations.
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	953 Therefore, using too high maximum number of requests
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	954 could result in excessive memory usage and not recommended.
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	955 </para>
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	956
2706 4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	957 <para>
4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	958 <note>
4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	959 Prior to version 1.19.10, the default value was 100.
4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	960 </note>
4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	961 </para>
4f44386a16b1 Changed default value of keepalive_requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2705 diff changeset	962
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	963 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	964
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	965
2705 06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	966 <directive name="keepalive_time">
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	967 <syntax><value>time</value></syntax>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	968 <default>1h</default>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	969 <context>http</context>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	970 <context>server</context>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	971 <context>location</context>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	972 <appeared-in>1.19.10</appeared-in>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	973
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	974 <para>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	975 Limits the maximum time during which
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	976 requests can be processed through one keep-alive connection.
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	977 After this time is reached, the connection is closed
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	978 following the subsequent request processing.
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	979 </para>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	980
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	981 </directive>
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	982
06805824d0f0 Documented the keepalive_time directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2657 diff changeset	983
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	984 <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	985 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	986 <value>timeout</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	987 [<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	988 <default>75s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	989 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	990 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	991 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	992
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	993 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	994 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	995 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	996 The zero value disables keep-alive client connections.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	997 The optional second parameter sets a value in the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	998 <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	999 response header field.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1000 Two parameters may differ.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1001 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1002
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1003 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1004 The
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1005 <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	1006 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	1007 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	1008 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1009
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1010 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1013 <directive name="large_client_header_buffers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1014 <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	1015 <default>4 8k</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1016 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1017 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1018
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1019 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1020 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	1021 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	1022 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	1023 <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	1024 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1025 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	1026 <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	1027 error is returned to the client.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1028 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	1029 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	1030 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	1031 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	1032 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1033
2795 691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1034 <para>
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1035 If the directive is specified on the <link id="server"/> level,
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1036 the value from the default server can be used.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1037 Details are provided in the
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1038 “<link doc="server_names.xml" id="virtual_server_selection">Virtual
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1039 server selection</link>” section.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1040 </para>
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1041
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1042 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1043
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1044
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1045 <directive name="limit_except">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1046 <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	1047 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1048 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1049
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1050 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1051 Limits allowed HTTP methods inside a location.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1052 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	1053 <literal>GET</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1054 <literal>HEAD</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1055 <literal>POST</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1056 <literal>PUT</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1057 <literal>DELETE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1058 <literal>MKCOL</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1059 <literal>COPY</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1060 <literal>MOVE</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1061 <literal>OPTIONS</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1062 <literal>PROPFIND</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1063 <literal>PROPPATCH</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1064 <literal>LOCK</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1065 <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	1066 or
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1067 <literal>PATCH</literal>.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1068 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	1069 <literal>HEAD</literal> method also allowed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1070 Access to other methods can be limited using the
3043 9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	1071 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link> and
9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	1072 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1073 modules directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1074 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1075 limit_except GET {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1076 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1077 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1079 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080 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	1081 <emphasis>except</emphasis> GET and HEAD.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1085
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1087 <directive name="limit_rate">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1088 <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	1089 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1090 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1091 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1092 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1093 <context>if in location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1094
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1095 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1096 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	1097 The <value>rate</value> is specified in bytes per second.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1098 The zero value disables rate limiting.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100 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	1101 -->
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1102 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	1103 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	1104 as the specified limit.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1105 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1106
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1107 <para>
2391 375a3dfde23b Unified phrase "Parameter value can contain variables". Yaroslav Zhuravlev <yar@nginx.com> parents: 2390 diff changeset	1108 Parameter value can contain variables (1.17.0).
767 1bb8b733416a Clarified the description of the limit_rate directive Ruslan Ermilov <ru@nginx.com> parents: 747 diff changeset	1109 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	1110 depending on a certain condition:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1111 <example>
2384 144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1112 map $slow $rate {
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1113 1 4k;
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1114 2 8k;
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1115 }
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1116
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1117 limit_rate $rate;
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1118 </example>
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1119 </para>
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1120
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1121 <para>
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1122 Rate limit can also be set in the
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1123 <link id="var_limit_rate"><var>$limit_rate</var></link> variable,
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1124 however, since version 1.17.0, this method is not recommended:
144c8e3d6c09 Documented variables support in limit_rate and limit_rate_after. Yaroslav Zhuravlev <yar@nginx.com> parents: 2220 diff changeset	1125 <example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1126 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1127
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 if ($slow) {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129 set $limit_rate 4k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1130 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1131
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1132 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1133 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1135 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1136
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1137 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1138 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	1139 <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	1140 This capability can be disabled using the
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1141 <link doc="ngx_http_proxy_module.xml" id="proxy_ignore_headers"/>,
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1142 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_ignore_headers"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1143 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_ignore_headers"/>,
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1144 and
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	1145 <link doc="ngx_http_scgi_module.xml" id="scgi_ignore_headers"/>
506 657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1146 directives.
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1147 </para>
657848837328 Documented how nginx processes proxied server's response header fields Ruslan Ermilov <ru@nginx.com> parents: 503 diff changeset	1148
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1149 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1150
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1151
171 6eeaa9e1f3b5 Made "appeared-in" an element, and added support for Ruslan Ermilov <ru@nginx.com> parents: 169 diff changeset	1152 <directive name="limit_rate_after">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1153 <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	1154 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1155 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1156 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1157 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1158 <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	1159 <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	1160
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1161 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1162 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	1163 of a response to a client will be rate limited.
2391 375a3dfde23b Unified phrase "Parameter value can contain variables". Yaroslav Zhuravlev <yar@nginx.com> parents: 2390 diff changeset	1164 Parameter value can contain variables (1.17.0).
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1165 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1166
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1167 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1168 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1169 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1170 location /flv/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1171 flv;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1172 limit_rate_after 500k;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1173 limit_rate 50k;
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1176 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1177
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1178 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1179
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1180
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1181 <directive name="lingering_close">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1182 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1183 <literal>off</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1184 <literal>on</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1185 <literal>always</literal></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1186 <default>on</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1187 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1188 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1189 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1190 <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	1191 <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	1192
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1193 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1194 Controls how nginx closes client connections.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1195 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1196
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1197 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1198 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	1199 <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	1200 <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	1201 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	1202 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	1203 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1204
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1205 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1206 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	1207 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	1208 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1209
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1210 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1211 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	1212 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	1213 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	1214 circumstances.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1215 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1216
2567 4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2523 diff changeset	1217 <para>
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2523 diff changeset	1218 To control closing
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2523 diff changeset	1219 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections,
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2523 diff changeset	1220 the directive must be specified on the <link id="server"/> level (1.19.1).
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2523 diff changeset	1221 </para>
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2523 diff changeset	1222
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1223 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1224
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1225
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1226 <directive name="lingering_time">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1227 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1228 <default>30s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1229 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1230 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1231 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1232
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1233 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1234 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	1235 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	1236 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	1237 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	1238 more data.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1239 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1240
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1241 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1242
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1243
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1244 <directive name="lingering_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1245 <syntax><value>time</value></syntax>
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1246 <default>5s</default>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1247 <context>http</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1248 <context>server</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1249 <context>location</context>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1250
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1251 <para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1252 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	1253 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	1254 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	1255 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	1256 for more data again.
172 5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1257 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	1258 <link id="lingering_time"/> directive.
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1259 </para>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1260
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1261 </directive>
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1262
5e8e63f73c33 Documented "lingering_close", "lingering_time", and "lingering_timeout". Ruslan Ermilov <ru@nginx.com> parents: 171 diff changeset	1263
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1264 <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	1265 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1266 <value>address</value>[:<value>port</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1267 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1268 [<literal>ssl</literal>]
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1269 [<literal>http2</literal> \|
2972 9a8d15333a58 Removed obsolete SPDY documentation. Sergey Kandaurov <pluknet@nginx.com> parents: 2965 diff changeset	1270 <literal>quic</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1271 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1272 [<literal>setfib</literal>=<value>number</value>]
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1273 [<literal>fastopen</literal>=<value>number</value>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1274 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1275 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1276 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1277 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1278 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1279 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1280 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1281 [<literal>reuseport</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1282 [<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	1283 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1284 <value>port</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1285 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1286 [<literal>ssl</literal>]
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1287 [<literal>http2</literal> \|
2972 9a8d15333a58 Removed obsolete SPDY documentation. Sergey Kandaurov <pluknet@nginx.com> parents: 2965 diff changeset	1288 <literal>quic</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1289 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1290 [<literal>setfib</literal>=<value>number</value>]
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1291 [<literal>fastopen</literal>=<value>number</value>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1292 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1293 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1294 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1295 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1296 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1297 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1298 [<literal>ipv6only</literal>=<literal>on</literal>\|<literal>off</literal>]
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1299 [<literal>reuseport</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1300 [<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	1301 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1302 <literal>unix:</literal><value>path</value>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1303 [<literal>default_server</literal>]
869 ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1304 [<literal>ssl</literal>]
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1305 [<literal>http2</literal> \|
2972 9a8d15333a58 Removed obsolete SPDY documentation. Sergey Kandaurov <pluknet@nginx.com> parents: 2965 diff changeset	1306 <literal>quic</literal>]
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1307 [<literal>proxy_protocol</literal>]
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1308 [<literal>backlog</literal>=<value>number</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1309 [<literal>rcvbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1310 [<literal>sndbuf</literal>=<value>size</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1311 [<literal>accept_filter</literal>=<value>filter</value>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1312 [<literal>deferred</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1313 [<literal>bind</literal>]
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1314 [<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	1315 <default>:80 \| :8000</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1316 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1317
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1318 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1319 Sets the <value>address</value> and <value>port</value> for IP,
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	1320 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	1321 the server will accept requests.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1322 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	1323 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	1324 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	1325 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1326 listen 127.0.0.1:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1327 listen 127.0.0.1;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1328 listen 8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1329 listen *:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1330 listen localhost:8000;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1331 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1332 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	1333 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1334 listen [::]:8000;
941 7d1d53d4d293 Removed link-scoped IPv6 addresses from examples. Ruslan Ermilov <ru@nginx.com> parents: 940 diff changeset	1335 listen [::1];
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1336 </example>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1337 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	1338 prefix:
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1339 <example>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1340 listen unix:/var/run/nginx.sock;
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1341 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1342 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1343
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1344 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1345 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	1346 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1347
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1348 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1349 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	1350 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	1351 otherwise.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1352 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1353
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1354 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1355 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	1356 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	1357 <value>address</value>:<value>port</value> pair.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1358 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	1359 parameter then the first server with the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1360 <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	1361 the default server for this pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1362 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1363 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	1364 <literal>default</literal>.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1365 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1366 </para>
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 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	1370 connections accepted on this port should work in SSL mode.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1371 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	1372 id="single_http_https_server">configuration</link> for the server that
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1373 handles both HTTP and HTTPS requests.
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1374 </para>
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1375
ade81792bdaa Documented SPDY support. Homutov Vladimir <vl@nginx.com> parents: 840 diff changeset	1376 <para>
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1377 The <literal>http2</literal> parameter (1.9.5) configures the port to accept
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1378 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections.
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1379 Normally, for this to work the <literal>ssl</literal> parameter should be
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1380 specified as well, but nginx can also be configured to accept HTTP/2
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1381 connections without SSL.
2976 cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2972 diff changeset	1382 <note>
cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2972 diff changeset	1383 The parameter is deprecated,
cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2972 diff changeset	1384 the <link doc="ngx_http_v2_module.xml" id="http2">http2</link> directive
cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2972 diff changeset	1385 should be used instead.
cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2972 diff changeset	1386 </note>
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1387 </para>
695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1388
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1389 <para id="quic">
2965 23eedf89fd5d Updated QUIC documentation after QUIC code merge. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	1390 The <literal>quic</literal> parameter (1.25.0) configures the port to accept
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1391 <link doc="ngx_http_v3_module.xml">QUIC</link> connections.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1392 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1393
1567 695999bdd4a5 Updated description of http2 parameter, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	1394 <para>
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1395 The <literal>proxy_protocol</literal> parameter (1.5.12)
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1396 allows specifying that all connections accepted on this port should use the
2912 7ebe15d6c68d Updated link to the PROXY protocol specification. Yaroslav Zhuravlev <yar@nginx.com> parents: 2903 diff changeset	1397 <link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1398 protocol</link>.
2125 b19d5d47c16c Documented ver.2 of the PROXY protocol. Yaroslav Zhuravlev <yar@nginx.com> parents: 2121 diff changeset	1399 <note>
b19d5d47c16c Documented ver.2 of the PROXY protocol. Yaroslav Zhuravlev <yar@nginx.com> parents: 2121 diff changeset	1400 The PROXY protocol version 2 is supported since version 1.13.11.
b19d5d47c16c Documented ver.2 of the PROXY protocol. Yaroslav Zhuravlev <yar@nginx.com> parents: 2121 diff changeset	1401 </note>
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1402 </para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1403
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	1404 <para>
1414 5addfab7e171 Corrected article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1279 diff changeset	1405 The <literal>listen</literal> directive
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1406 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	1407 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	1408 <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	1409 <value>address</value>:<value>port</value> pair.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1410 <note>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1411 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	1412 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	1413 <literal>default</literal> parameter.
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1414 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1415 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1416
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1417 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1418 <literal>setfib</literal>=<value>number</value>
66 9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1419 </tag-name>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1420 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1421 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	1422 (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	1423 This currently works only on FreeBSD.
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1424 </tag-desc>
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1425
9332d7a02822 In the "listen" directive, Ruslan Ermilov <ru@nginx.com> parents: 65 diff changeset	1426 <tag-name>
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1427 <literal>fastopen</literal>=<value>number</value>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1428 </tag-name>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1429 <tag-desc>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1430 enables
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1431 “<link url="http://en.wikipedia.org/wiki/TCP_Fast_Open">TCP Fast Open</link>”
1037 3fde5aa256ac Fixed markup. Vladimir Homutov <vl@nginx.com> parents: 1036 diff changeset	1432 for the listening socket (1.5.8) and
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2795 diff changeset	1433 <link url="https://datatracker.ietf.org/doc/html/rfc7413#section-5.1">limits</link>
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1434 the maximum length for the queue of connections that have not yet completed
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1435 the three-way handshake.
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1436 <note>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1437 Do not enable this feature unless the server can handle
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1438 receiving the
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2795 diff changeset	1439 <link url="https://datatracker.ietf.org/doc/html/rfc7413#section-6.1">
1036 5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1440 same SYN packet with data</link> more than once.
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1441 </note>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1442 </tag-desc>
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1443
5894aa46ffef Documented "listen fastopen=" parameter. Vladimir Homutov <vl@nginx.com> parents: 1035 diff changeset	1444 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1445 <literal>backlog</literal>=<value>number</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1446 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1447 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1448 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	1449 <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	1450 the maximum length for the queue of pending connections.
1501 40425063b413 Fixed the default "listen backlog" value on DragonFly BSD. Ruslan Ermilov <ru@nginx.com> parents: 1500 diff changeset	1451 By default,
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	1452 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and macOS,
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1453 and to 511 on other platforms.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1454 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1455
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1456 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1457 <literal>rcvbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1458 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1459 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1460 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	1461 (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	1462 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1463
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1464 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1465 <literal>sndbuf</literal>=<value>size</value>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1466 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1467 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1468 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	1469 (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	1470 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1471
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1472 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1473 <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	1474 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1475 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1476 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	1477 (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	1478 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	1479 <c-func>accept</c-func>.
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1480 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	1481 Possible values are
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1482 <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	1483 and
368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1484 <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	1485 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1486
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1487 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1488 <literal>deferred</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1489 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1490 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1491 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	1492 (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	1493 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1494
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1495 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1496 <literal>bind</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1497 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1498 <tag-desc>
240 472e88bf177e Slightly better wording for the "bind" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 237 diff changeset	1499 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	1500 <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	1501 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	1502 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	1503 <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	1504 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	1505 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	1506 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	1507 made in this case to determine the address that accepted the connection.
1035 e9c485d6cc0c Documented that "listen setfib=" implies "bind". Ruslan Ermilov <ru@nginx.com> parents: 1031 diff changeset	1508 If the <literal>setfib</literal>,
2724 00afc7c4d4df Documented listen options that imply "bind". Ruslan Ermilov <ru@nginx.com> parents: 2707 diff changeset	1509 <literal>fastopen</literal>,
1035 e9c485d6cc0c Documented that "listen setfib=" implies "bind". Ruslan Ermilov <ru@nginx.com> parents: 1031 diff changeset	1510 <literal>backlog</literal>, <literal>rcvbuf</literal>,
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1511 <literal>sndbuf</literal>, <literal>accept_filter</literal>,
1279 7261e621dd4a Documented that "listen ipv6only=" implies "bind". Maxim Dounin <mdounin@mdounin.ru> parents: 1257 diff changeset	1512 <literal>deferred</literal>, <literal>ipv6only</literal>,
2724 00afc7c4d4df Documented listen options that imply "bind". Ruslan Ermilov <ru@nginx.com> parents: 2707 diff changeset	1513 <literal>reuseport</literal>,
1279 7261e621dd4a Documented that "listen ipv6only=" implies "bind". Maxim Dounin <mdounin@mdounin.ru> parents: 1257 diff changeset	1514 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	1515 are used then for a given
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1516 <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	1517 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	1518 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1519
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1520 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1521 <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	1522 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1523 <tag-desc>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1524 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	1525 (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	1526 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	1527 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	1528 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	1529 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	1530 <note>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1531 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	1532 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	1533 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	1534 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1535 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1536
1507 14180fa9a518 Added ids for reuseport, mentioned reuseport in news. Yaroslav Zhuravlev <yar@nginx.com> parents: 1501 diff changeset	1537 <tag-name id="reuseport">
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1538 <literal>reuseport</literal>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1539 </tag-name>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1540 <tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1541 this parameter (1.9.1) instructs to create an individual listening socket
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1542 for each worker process
2199 1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1543 (using the
1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1544 <c-def>SO_REUSEPORT</c-def> socket option on Linux 3.9+ and DragonFly BSD,
1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1545 or <c-def>SO_REUSEPORT_LB</c-def> on FreeBSD 12+), allowing a kernel
1496 99ce48c8cce3 Corrected the "reuseport" description of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1493 diff changeset	1546 to distribute incoming connections between worker processes.
2199 1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1547 This currently works only on Linux 3.9+, DragonFly BSD,
1d60e4b4ed64 Documented SO_REUSEPORT_LB for listen reuseport. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1548 and FreeBSD 12+ (1.15.1).
1493 9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1549 <note>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1550 Inappropriate use of this option may have its security
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1551 <link url="http://man7.org/linux/man-pages/man7/socket.7.html">implications</link>.
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1552 </note>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1553 </tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1554
9faa78768252 Documented the "reuseport" option of the "listen" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	1555 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1556 <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	1557 </tag-name>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1558 <tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1559 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	1560 for the listening socket.
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1561 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	1562 in effect for the socket.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1563 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	1564 <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	1565 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	1566 <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	1567 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	1568 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	1569 <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	1570 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	1571 FreeBSD 9.0-STABLE), they can be configured
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1572 using the <value>keepidle</value>, <value>keepintvl</value>, and
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1573 <value>keepcnt</value> parameters.
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1574 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	1575 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	1576 For example,
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1577 <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	1578 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	1579 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	1580 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	1581 </tag-desc>
09b8c8b2b865 Documented the "so_keepalive" parameter of the "listen" directive. Ruslan Ermilov <ru@nginx.com> parents: 185 diff changeset	1582
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1583 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1584 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1585
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1586 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1587 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1588 <example>
617 368a449e85b8 Expanded documentation of what various parameters of the "listen" Ruslan Ermilov <ru@nginx.com> parents: 615 diff changeset	1589 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	1590 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1591 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1592
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1593 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1594
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1595
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1596 <directive name="location">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	1597 <syntax block="yes">[
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1598 <literal>=</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1599 <literal>~</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1600 <literal>~*</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1601 <literal>^~</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	1602 ] <value>uri</value></syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1603 <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	1604 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1605 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1606 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1607
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1608 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1609 Sets configuration depending on a request URI.
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1610 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1611
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1612 <para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1613 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	1614 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	1615 resolving references to relative path components “<literal>.</literal>”
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1616 and “<literal>..</literal>”, and possible
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1617 <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	1618 adjacent slashes into a single slash.
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1619 </para>
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1620
aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	1621 <para>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1622 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	1623 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	1624 “<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	1625 “<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	1626 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	1627 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	1628 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	1629 prefix is selected and remembered.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1630 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	1631 in the configuration file.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1632 The search of regular expressions terminates on the first match,
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1633 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	1634 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	1635 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	1636 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1637
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1638 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1639 <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	1640 mentioned below.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1641 </para>
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1642
d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1643 <para>
1911 f024ac0ec5c7 Apple rebranded Mac OS X to macOS. Sergey Kandaurov <pluknet@nginx.com> parents: 1904 diff changeset	1644 For case-insensitive operating systems such as macOS and Cygwin,
244 9e2be02df2ce Fixed wording. Ruslan Ermilov <ru@nginx.com> parents: 241 diff changeset	1645 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	1646 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	1647 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1648
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1649 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1650 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	1651 be used in other directives.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1652 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1653
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1654 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1655 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	1656 then regular expressions are not checked.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1657 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1658
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1659 <para>
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1660 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	1661 an exact match of URI and location.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1662 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	1663 For example, if a “<literal>/</literal>” request happens frequently,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1664 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	1665 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	1666 comparison.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1667 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	1668 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1669
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1670 <para>
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1671 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1672 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	1673 location without the “<literal>=</literal>” and “<literal>^~</literal>”
810 7c72c3e67e77 The "location" directive: improved wording. Ruslan Ermilov <ru@nginx.com> parents: 779 diff changeset	1674 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	1675 not checked.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1676 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1677 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1678
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1679 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1680 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	1681 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1682 location = / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1683 [ configuration A ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1684 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1685
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1686 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1687 [ configuration B ]
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1688 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1689
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1690 location /documents/ {
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1691 [ configuration C ]
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1692 }
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1693
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1694 location ^~ /images/ {
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1695 [ configuration D ]
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1696 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1697
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1698 location ~* \.(gif\|jpg\|jpeg)$ {
738 0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1699 [ configuration E ]
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1700 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1701 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1702 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	1703 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	1704 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	1705 configuration C,
0914bbb59fd2 Expanded "location" examples with another prefix location. Ruslan Ermilov <ru@nginx.com> parents: 711 diff changeset	1706 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	1707 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	1708 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1709
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	1710 <para id="location_named">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1711 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	1712 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	1713 used for request redirection.
67 d98323a15ba4 Documented the nested locations. Ruslan Ermilov <ru@nginx.com> parents: 66 diff changeset	1714 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	1715 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1716
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1717 <para>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1718 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	1719 and requests are processed by one of
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1720 <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	1721 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1722 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>,
2134 4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	1723 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>,
4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	1724 <link doc="ngx_http_memcached_module.xml" id="memcached_pass"/>, or
4cafd82e5007 Added info about gRPC to various modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2125 diff changeset	1725 <link doc="ngx_http_grpc_module.xml" id="grpc_pass"/>,
1257 ac7a5ee98768 Split long sentence into two. Ruslan Ermilov <ru@nginx.com> parents: 1194 diff changeset	1726 then the special processing is performed.
ac7a5ee98768 Split long sentence into two. Ruslan Ermilov <ru@nginx.com> parents: 1194 diff changeset	1727 In response to a request with URI equal to this string,
914 474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1728 but without the trailing slash,
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1729 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	1730 with the slash appended.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1731 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	1732 defined like this:
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1733 <example>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1734 location /user/ {
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1735 proxy_pass http://user.example.com;
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1736 }
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1737
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1738 location = /user {
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1739 proxy_pass http://login.example.com;
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1740 }
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1741 </example>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1742 </para>
474a21f26a2a Documented location behavior with proxying directives. Vladimir Homutov <vl@nginx.com> parents: 871 diff changeset	1743
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1744 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1745 <migration from="Apache" directive="Location" />
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1748 </directive>
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 <directive name="log_not_found">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1752 <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	1753 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1754 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1755 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1756 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1757
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1758 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1759 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	1760 <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	1761 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1762
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1763 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1764
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 name="log_subrequest">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1767 <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	1768 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1769 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1770 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1771 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1772
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1773 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1774 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	1775 <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	1776 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1777
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1778 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1779
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1780
3083 3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1781 <directive name="max_headers">
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1782 <syntax><value>number</value></syntax>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1783 <default>1000</default>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1784 <context>http</context>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1785 <context>server</context>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1786 <appeared-in>1.27.1</appeared-in>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1787
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1788 <para>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1789 Limits the maximum allowed number of client request header fields.
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1790 If the limit is exceeded, the
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1791 <http-status code="400" text="Bad Request"/>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1792 error is returned to the client.
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1793 </para>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1794
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1795 <para>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1796 If the directive is specified on the <link id="server"/> level,
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1797 the value from the default server can be used.
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1798 Details are provided in the
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1799 “<link doc="server_names.xml" id="virtual_server_selection">Virtual
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1800 server selection</link>” section.
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1801 </para>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1802
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1803 </directive>
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1804
3b5594157fab Documented max_headers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 3043 diff changeset	1805
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1806 <directive name="max_ranges">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1807 <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	1808 <default/>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1809 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1810 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1811 <context>location</context>
499 76a8eca844d0 Documented that "max_ranges" appeared in 1.1.2. Ruslan Ermilov <ru@nginx.com> parents: 477 diff changeset	1812 <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	1813
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1814 <para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1815 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	1816 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	1817 byte ranges specified.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1818 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	1819 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	1820 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1821
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1822 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1823
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	1824
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1825 <directive name="merge_slashes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1826 <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	1827 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1828 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1829 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1830
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1831 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1832 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	1833 in a URI into a single slash.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1834 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1835
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1836 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1837 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	1838 and regular expression locations.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1839 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	1840 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1841 location /scripts/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1842 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1843 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1844 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1845 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	1846 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	1847 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1848
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1849 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1850 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	1851 contains base64-encoded names, since base64 uses the “<literal>/</literal>”
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1852 character internally.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1853 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	1854 the compression off.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1855 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1856
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1857 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	1858 If the directive is specified on the <link id="server"/> level,
2795 691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1859 the value from the default server can be used.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1860 Details are provided in the
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1861 “<link doc="server_names.xml" id="virtual_server_selection">Virtual
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	1862 server selection</link>” section.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1863 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1864
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1865 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1866
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1867
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1868 <directive name="msie_padding">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1869 <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	1870 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1871 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1872 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1873 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1874
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1875 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1876 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	1877 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	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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1881
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1882
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1883 <directive name="msie_refresh">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1884 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	1885 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1886 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1887 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1888 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1889
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1890 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1891 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	1892 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1893
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1894 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1895
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1896
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1897 <directive name="open_file_cache">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1898 <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	1899 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1900 <literal>max</literal>=<value>N</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1901 [<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	1902 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1903 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1904 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1905 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1906
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1907 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1908 Configures a cache that can store:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1909 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1910
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1911 <listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1912 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	1913 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1914
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1915 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1916 information on existence of directories;
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1917 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1918
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1919 <listitem>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1920 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	1921 and so on.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1922 <note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1923 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	1924 <link id="open_file_cache_errors"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1925 directive.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	1926 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1927 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1928
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1929 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1930 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1931
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1932 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1933 The directive has the following parameters:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1934 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1935
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1936 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1937 <literal>max</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1938 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1939 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1940 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	1941 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	1942 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1943
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1944 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1945 <literal>inactive</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1946 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1947 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	1948 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	1949 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	1950 by default, it is 60 seconds;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1951 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1952
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1953 <tag-name>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1954 <literal>off</literal>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1955 </tag-name>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1956 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1957 disables the cache.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1958 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1959
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1960 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1961 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1962
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1963 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1964 Example:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1965 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1966 open_file_cache max=1000 inactive=20s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1967 open_file_cache_valid 30s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1968 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	1969 open_file_cache_errors on;<!--
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1970 open_file_cache_events on;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1971 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1972 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1973 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1974
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1975 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1976
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1977
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1978 <directive name="open_file_cache_errors">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1979 <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	1980 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1981 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1982 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1983 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1984
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1985 <para>
68 9de85defbcf8 - "optimize_server_names" is deprecated in favour of "server_name_in_redirects" Ruslan Ermilov <ru@nginx.com> parents: 67 diff changeset	1986 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	1987 <link id="open_file_cache"/>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1988 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1989
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1990 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1991
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1992
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1993 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1994
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1995 <directive name="open_file_cache_events">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	1996 <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	1997 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1998 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1999 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2000 <context>location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2003 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	2004 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2005 elements.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2006 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	2007 <link doc="../events.xml" id="kqueue"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2008 method only.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2009 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	2010 support events for arbitrary file system types.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2011 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	2012 file systems such as UFS or FFS.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2013 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2014
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2015 </directive>
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 -->
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="open_file_cache_min_uses">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2021 <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	2022 <default>1</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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2027 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2028 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	2029 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	2030 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	2031 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	2032 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2033
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2034 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2035
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2036
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2037 <directive name="open_file_cache_valid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2038 <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	2039 <default>60s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2040 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2041 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2042 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2043
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2044 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2045 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	2046 <link id="open_file_cache"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2047 elements should be validated.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2048 <!--
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2049 When
106 56457a474903 If text of the link is not provided, the @id is used. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	2050 <link id="open_file_cache_events"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2051 is enabled, open file descriptors
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2052 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	2053 -->
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2054 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2055
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2056 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2057
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2058
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2059 <directive name="output_buffers">
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2060 <syntax><value>number</value> <value>size</value></syntax>
1576 7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	2061 <default>2 32k</default>
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2062 <context>http</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2063 <context>server</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2064 <context>location</context>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2065
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2066 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	2067 Sets the <value>number</value> and <value>size</value> of the
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2068 buffers used for reading a response from a disk.
1576 7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	2069 <note>
7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	2070 Prior to version 1.9.5, the default value was 1 32k.
7f97ab081d24 Changed default value in the output_buffers directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1567 diff changeset	2071 </note>
1024 e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2072 </para>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2073
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2074 </directive>
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2075
e47971bf6619 Documented output_buffers directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1023 diff changeset	2076
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2077 <directive name="port_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2078 <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	2079 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2080 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2081 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2082 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2083
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2084 <para>
1879 3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	2085 Enables or disables specifying the port in
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	2086 <link id="absolute_redirect">absolute</link> redirects issued by nginx.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2087 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2088
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2089 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2090 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	2091 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	2092 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2093
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2094 </directive>
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
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2097 <directive name="postpone_output">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2098 <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	2099 <default>1460</default>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2100 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2101 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2102 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2103
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2104 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2105 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	2106 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	2107 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	2108 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2109
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2110 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2111
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2112
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2113 <directive name="read_ahead">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2114 <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	2115 <default>0</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2116 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2117 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2118 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2119
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2120 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2121 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	2122 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2123
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2124 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2125 On Linux, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2126 <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	2127 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	2128 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2129
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2130 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2131 On FreeBSD, the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2132 <literal>fcntl(O_READAHEAD,</literal>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2133 <value>size</value><literal>)</literal>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2134 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	2135 FreeBSD 7 has to be
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2136 <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	2137 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2138
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2139 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2140
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2141
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2142 <directive name="recursive_error_pages">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2143 <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	2144 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2145 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2146 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2147 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2148
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2149 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2150 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	2151 <link id="error_page"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2152 directive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2153 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	2154 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2155
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2156 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2157
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2158
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2159 <directive name="request_pool_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2160 <syntax><value>size</value></syntax>
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2161 <default>4k</default>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2162 <context>http</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2163 <context>server</context>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2164
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2165 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2166 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	2167 This directive has minimal impact on performance
169 b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2168 and should not generally be used.
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2169 </para>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2170
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2171 </directive>
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2172
b7b160e4e046 Rstored alphabetical order of directives. Ruslan Ermilov <ru@nginx.com> parents: 162 diff changeset	2173
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2174 <directive name="reset_timedout_connection">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2175 <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	2176 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2177 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2178 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2179 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2180
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2181 <para>
2390 655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2182 Enables or disables resetting timed out connections
655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2183 and connections
655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2184 <link doc="ngx_http_rewrite_module.xml" id="return">closed</link>
655e7de7fd4b Documented "return 444" when reset_timedout_connection is on. Yaroslav Zhuravlev <yar@nginx.com> parents: 2384 diff changeset	2185 with the non-standard code 444 (1.15.2).
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2186 The reset is performed as follows.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2187 Before closing a socket, the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2188 <c-def>SO_LINGER</c-def>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2189 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	2190 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	2191 occupied by this socket is released.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2192 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	2193 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	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 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2197 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	2198 closed normally.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2199 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2200
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2201 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2202
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 <directive name="resolver">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2205 <syntax>
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2206 <value>address</value> ...
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2207 [<literal>valid</literal>=<value>time</value>]
2870 e06cf66a9f63 Documented the "ipv4=off" parameter of the "resolver" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2831 diff changeset	2208 [<literal>ipv4</literal>=<literal>on</literal>\|<literal>off</literal>]
3043 9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	2209 [<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	2210 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2211 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2212 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2213 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2214
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2215 <para>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2216 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	2217 into addresses, for example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2218 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2219 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	2220 </example>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2221 The address can be specified as a domain name or IP address,
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2222 with an optional port (1.3.1, 1.2.2).
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2223 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	2224 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	2225 <note>
370cf5ccd3ca The "resolver" directive now allows specifying multiple name servers. Ruslan Ermilov <ru@nginx.com> parents: 140 diff changeset	2226 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	2227 Specifying name servers using IPv6 addresses is supported
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	2228 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	2229 </note>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2230 </para>
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2231
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2232 <para id="resolver_ipv6">
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2233 By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
2870 e06cf66a9f63 Documented the "ipv4=off" parameter of the "resolver" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2831 diff changeset	2234 If looking up of IPv4 or IPv6 addresses is not desired,
e06cf66a9f63 Documented the "ipv4=off" parameter of the "resolver" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2831 diff changeset	2235 the <literal>ipv4=off</literal> (1.23.1) or
1031 f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2236 the <literal>ipv6=off</literal> parameter can be specified.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2237 <note>
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2238 Resolving of names into IPv6 addresses is supported
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2239 starting from version 1.5.8.
f7f23f5928ef Documented "resolver ipv6=" parameter. Ruslan Ermilov <ru@nginx.com> parents: 1024 diff changeset	2240 </note>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2241 </para>
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2242
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	2243 <para id="resolver_valid">
185 05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2244 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	2245 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	2246 <example>
527 58d79f8c412d Documented 1.3.1 changes in "resolver". Ruslan Ermilov <ru@nginx.com> parents: 522 diff changeset	2247 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	2248 </example>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2249 <note>
05e7496801ec Documented recent changes in the "resolver" directive. Ruslan Ermilov <ru@nginx.com> parents: 176 diff changeset	2250 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	2251 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	2252 </note>
1770 ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2253 <note>
ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2254 To prevent DNS spoofing, it is recommended
ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2255 configuring DNS servers in a properly secured trusted local network.
ae46e57cecba Added note to the "resover" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	2256 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2257 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2260
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2261
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2262 <directive name="resolver_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2263 <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	2264 <default>30s</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2265 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2266 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2267 <context>location</context>
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>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2270 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	2271 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2272 resolver_timeout 5s;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2273 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2274 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2277
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2278
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2279 <directive name="root">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2280 <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	2281 <default>html</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2282 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2283 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2284 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2285 <context>if in location</context>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2288 Sets the root directory for requests.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2289 For example, with the following configuration
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2290 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2291 location /i/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2292 root /data/w3;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2293 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2294 </example>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2295 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	2296 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	2297 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2298
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2299 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2300 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	2301 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	2302 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2303
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2304 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2305 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	2306 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	2307 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	2308 <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	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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2312
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2313
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2314 <directive name="satisfy">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2315 <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	2316 <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	2317 <context>http</context>
935beaa561b3 - use of $document_root and $realpath_root in "root" is prohibited Ruslan Ermilov <ru@nginx.com> parents: 68 diff changeset	2318 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2319 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2320
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2321 <para>
971 6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2322 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	2323 (<literal>any</literal>) of the
971 6316a7579448 Documented the "ngx_http_auth_request" module. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	2324 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>,
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1732 diff changeset	2325 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>,
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1732 diff changeset	2326 or
3043 9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	2327 <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	2328 modules allow access.
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2329 </para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2330
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2331 <para>
6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	2332 Example:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2333 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2334 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2335 satisfy any;
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 allow 192.168.1.0/32;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2338 deny all;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2339
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2340 auth_basic "closed site";
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2341 auth_basic_user_file conf/htpasswd;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2342 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2343 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2344 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2345
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2346 </directive>
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
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2349 <directive name="send_lowat">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2350 <syntax><value>size</value></syntax>
176 0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2351 <default>0</default>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2352 <context>http</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2353 <context>server</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2354 <context>location</context>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2355
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2356 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2357 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	2358 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	2359 <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	2360 <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	2361 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	2362 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	2363 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2364
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2365 <para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2366 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	2367 </para>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2368
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2369 </directive>
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2370
0883fc5aabc9 Documented the "keepalive_disable" and "send_lowat" directives. Ruslan Ermilov <ru@nginx.com> parents: 175 diff changeset	2371
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2372 <directive name="send_timeout">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2373 <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	2374 <default>60s</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 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2377 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2378
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2379 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2380 Sets a timeout for transmitting a response to the client.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1132 diff changeset	2381 The timeout is set only between two successive write operations,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2382 not for the transmission of the whole response.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1132 diff changeset	2383 If the client does not receive anything within this time,
1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 1132 diff changeset	2384 the connection is closed.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2385 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2386
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2387 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2388
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2389
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2390 <directive name="sendfile">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2391
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2392 <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	2393 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2394 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2395 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2396 <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	2397 <context>if in location</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2398
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2399 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2400 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2401 <c-func>sendfile</c-func>.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2402 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2403
1432 9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2404 <para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2405 Starting from nginx 0.8.12 and FreeBSD 5.2.1,
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2406 <link id="aio"/> can be used to pre-load data
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2407 for <c-func>sendfile</c-func>:
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2408 <example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2409 location /video/ {
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2410 sendfile on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2411 tcp_nopush on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2412 aio on;
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2413 }
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2414 </example>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2415 In this configuration, <c-func>sendfile</c-func> is called with
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2416 the <c-def>SF_NODISKIO</c-def> flag which causes it not to block on disk I/O,
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2417 but, instead, report back that the data are not in memory.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2418 nginx then initiates an asynchronous data load by reading one byte.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2419 On the first read, the FreeBSD kernel loads the first 128K bytes
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2420 of a file into memory, although next reads will only load data in 16K chunks.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2421 This can be changed using the
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2422 <link id="read_ahead"/> directive.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2423 <note>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2424 Before version 1.7.11, pre-loading could be enabled with
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2425 <literal>aio sendfile;</literal>.
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2426 </note>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2427 </para>
9012d7935c9b Documented that "aio sendfile" is deprecated. Ruslan Ermilov <ru@nginx.com> parents: 1430 diff changeset	2428
57 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
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2432 <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	2433
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2434 <syntax><value>size</value></syntax>
2793 4934cbc1db19 Changed default value of sendfile_max_chunk to 2m. Yaroslav Zhuravlev <yar@nginx.com> parents: 2724 diff changeset	2435 <default>2m</default>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2436 <context>http</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2437 <context>server</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2438 <context>location</context>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2439
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2440 <para>
2793 4934cbc1db19 Changed default value of sendfile_max_chunk to 2m. Yaroslav Zhuravlev <yar@nginx.com> parents: 2724 diff changeset	2441 Limits the amount of data that can be
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2442 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	2443 Without the limit, one fast connection may seize the worker process entirely.
2793 4934cbc1db19 Changed default value of sendfile_max_chunk to 2m. Yaroslav Zhuravlev <yar@nginx.com> parents: 2724 diff changeset	2444 <note>
4934cbc1db19 Changed default value of sendfile_max_chunk to 2m. Yaroslav Zhuravlev <yar@nginx.com> parents: 2724 diff changeset	2445 Prior to version 1.21.4, by default there was no limit.
4934cbc1db19 Changed default value of sendfile_max_chunk to 2m. Yaroslav Zhuravlev <yar@nginx.com> parents: 2724 diff changeset	2446 </note>
175 3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2447 </para>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2448
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2449 </directive>
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2450
3381ae6a93e4 Documented the max_ranges, postpone_output, and sendfile_max_chunk directives. Ruslan Ermilov <ru@nginx.com> parents: 174 diff changeset	2451
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2452 <directive name="server">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2453 <syntax block="yes"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2454 <default/>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2455 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2456
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2457 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2458 Sets configuration for a virtual server.
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2459 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	2460 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	2461 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	2462 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	2463 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	2464 <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	2465 Example configurations are provided in the
ef11546f75ee Translated "request_processing" into Russian, removed "virtual_hosts" Ruslan Ermilov <ru@nginx.com> parents: 506 diff changeset	2466 “<link doc="request_processing.xml"/>” document.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2467 </para>
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 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2470
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2471
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2472 <directive name="server_name">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2473 <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	2474 <default>""</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2475 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2476
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2477 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2478 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	2479 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2480 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2481 server_name example.com www.example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2482 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2483 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2484 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2485
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2486 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2487 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	2488 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2489
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2490 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2491 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	2492 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	2493 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2494 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2495 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	2496 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2497 </example>
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2498 Such names are called wildcard names.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2499 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2500
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2501 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2502 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	2503 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2504 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2505 server_name .example.com;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2506 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2507 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2508 </para>
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 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2511 It is also possible to use regular expressions in server names,
1101 ebe027a963f4 Typo fixed. Andrei Belov <defan@nginx.com> parents: 1097 diff changeset	2512 preceding the name with a tilde (“<literal>~</literal>”):
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2513 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2514 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2515 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	2516 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2517 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2518 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2519
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2520 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2521 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	2522 be used in other directives:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2523 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2524 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2525 server_name ~^(www\.)?(.+)$;
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 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2528 root /sites/$2;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2529 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2530 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2531
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2532 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2533 server_name _;
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 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2536 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2537 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2538 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2539 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2540 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2541
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2542 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2543 Named captures in regular expressions create variables (0.8.25)
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2544 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	2545 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2546 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2547 server_name ~^(www\.)?(?<domain>.+)$;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2548
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2549 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2550 root /sites/$domain;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2551 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2552 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2553
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2554 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2555 server_name _;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2556
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2557 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2558 root /sites/default;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2559 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2560 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2561 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2562 </para>
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 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2565 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	2566 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	2567 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2568
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2569 <para>
70 272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2570 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	2571 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2572 server {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2573 server_name www.example.com "";
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 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2576 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	2577 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	2578 This is the default setting.
272d99af0c15 The "server_name" directive: Ruslan Ermilov <ru@nginx.com> parents: 69 diff changeset	2579 <note>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	2580 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	2581 </note>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2582 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2583
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2584 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2585 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	2586 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	2587 (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	2588 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	2589 <list type="enum">
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 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2592 the exact name
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2593 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2594
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2595 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2596 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	2597 e.g. “<literal>*.example.com</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2598 </listitem>
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 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2601 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	2602 e.g. “<literal>mail.*</literal>”
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2603 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2604
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2605 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2606 the first matching regular expression
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2607 (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	2608 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2609
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2610 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2611 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2612
628 779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2613 <para>
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2614 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	2615 <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	2616 </para>
779a47d0acb0 Unified terminology used in the "server_name" directive and server_names.xml. Vladimir Homutov <vl@nginx.com> parents: 627 diff changeset	2617
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2618 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2619
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2620
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2621 <directive name="server_name_in_redirect">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2622 <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	2623 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2624 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2625 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2626 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2627
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2628 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2629 Enables or disables the use of the primary server name, specified by the
1879 3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	2630 <link id="server_name"/> directive,
3685d90e133e Documented the "absolute_redirect" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1859 diff changeset	2631 in <link id="absolute_redirect">absolute</link> redirects issued by nginx.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2632 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	2633 <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	2634 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	2635 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2636
159 8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2637 <para>
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2638 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	2639 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	2640 </para>
8c124aef0041 Cross-linked "server_name_in_redirect" and "port_in_redirect" directives. Ruslan Ermilov <ru@nginx.com> parents: 152 diff changeset	2641
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2642 </directive>
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
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2645 <directive name="server_names_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2646 <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	2647 <default>32\|64\|128</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2648 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2649
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2650 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2651 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	2652 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	2653 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	2654 <link doc="../hash.xml">document</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2655 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2656
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2657 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2658
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2659
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2660 <directive name="server_names_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2661 <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	2662 <default>512</default>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2663 <context>http</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2664
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2665 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2666 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	2667 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	2668 <link doc="../hash.xml">document</link>.
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2669 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2670
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2671 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2672
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	2673
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2674 <directive name="server_tokens">
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2675 <syntax>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2676 <literal>on</literal> \|
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1665 diff changeset	2677 <literal>off</literal> \|
3043 9eadb98ec770 Free nginx: removed commercial version documentation. Maxim Dounin <mdounin@mdounin.ru> parents: 2976 diff changeset	2678 <literal>build</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2679 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2680 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2681 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2682 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2683
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2684 <para>
1903 da00a2526415 Replaced "error messages" with "error pages" in server_tokens. Yaroslav Zhuravlev <yar@nginx.com> parents: 1879 diff changeset	2685 Enables or disables emitting nginx version on error pages and in the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2686 <header>Server</header> response header field.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2687 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2688
1904 d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2689 <para id="server_tokens_build">
1953 408eed0bf491 Clarified description of server_tokens build. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	2690 The <literal>build</literal> parameter (1.11.10) enables emitting
408eed0bf491 Clarified description of server_tokens build. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	2691 a <link doc="../configure.xml" id="build">build name</link>
408eed0bf491 Clarified description of server_tokens build. Yaroslav Zhuravlev <yar@nginx.com> parents: 1923 diff changeset	2692 along with nginx version.
1904 d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2693 </para>
d59199b0c022 Documented the "build" parameter of the "server_tokens" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1903 diff changeset	2694
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2695 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2696
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2697
2118 0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2698 <directive name="subrequest_output_buffer_size">
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2699 <syntax><value>size</value></syntax>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2700 <default>4k\|8k</default>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2701 <context>http</context>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2702 <context>server</context>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2703 <context>location</context>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2704 <appeared-in>1.13.10</appeared-in>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2705
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2706 <para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2707 Sets the <value>size</value> of the buffer used for
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2708 storing the response body of a subrequest.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2709 By default, the buffer size is equal to one memory page.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2710 This is either 4K or 8K, depending on a platform.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2711 It can be made smaller, however.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2712 </para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2713
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2714 <para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2715 The directive is applicable only for subrequests
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2716 with response bodies saved into memory.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2717 For example, such subrequests are created by
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2718 <link doc="ngx_http_ssi_module.xml" id="ssi_include_set">SSI</link>.
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2719 </para>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2720
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2721 </directive>
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2722
0b3103eabdf1 Documented the "subrequest_output_buffer_size" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2039 diff changeset	2723
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2724 <directive name="tcp_nodelay">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2725 <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	2726 <default>on</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2727 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2728 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2729 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2730
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2731 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2732 Enables or disables the use of the <c-def>TCP_NODELAY</c-def> option.
2121 cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2733 The option is enabled when a connection is transitioned into the
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2734 keep-alive state.
2121 cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2735 Additionally, it is enabled on SSL connections,
cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2736 for unbuffered proxying,
cf9e3d2893b6 Fixed description of the http tcp_nodelay directive. Ruslan Ermilov <ru@nginx.com> parents: 2118 diff changeset	2737 and for <link doc="websocket.xml">WebSocket</link> proxying.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2738 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2739
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2740 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2741
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2742
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2743 <directive name="tcp_nopush">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2744 <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	2745 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2746 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2747 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2748 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2749
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2750 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2751 Enables or disables the use of
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2752 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	2753 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	2754 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	2755 Enabling the option allows
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2756 <list type="bullet">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2757
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2758 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2759 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	2760 on Linux and FreeBSD 4.*;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2761 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2762
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2763 <listitem>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2764 sending a file in full packets.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2765 </listitem>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2766
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2767 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2768 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2769
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2770 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2771
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2772
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2773 <directive name="try_files">
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2774 <syntax><value>file</value> ... <value>uri</value></syntax>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	2775 <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	2776 <default/>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2777 <context>server</context>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2778 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2779
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2780 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2781 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	2782 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	2783 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	2784 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	2785 <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	2786 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	2787 <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	2788 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	2789 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	2790 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	2791 <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	2792 For example:
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2793 <example>
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2794 location /images/ {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2795 try_files $uri /images/default.gif;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2796 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2797
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2798 location = /images/default.gif {
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2799 expires 30s;
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2800 }
6b81a1950ecb Improved on "try_files" documentation: Ruslan Ermilov <ru@nginx.com> parents: 172 diff changeset	2801 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2802 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	2803 as shown in examples below.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2804 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	2805 <value>code</value>:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2806 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2807 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2808 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	2809 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2810 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2811 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2812
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2813 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2814 Example in proxying Mongrel:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2815 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2816 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2817 try_files /system/maintenance.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2818 $uri $uri/index.html $uri.html
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2819 @mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2820 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2821
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2822 location @mongrel {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2823 proxy_pass http://mongrel;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2824 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2825 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2826 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2827
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2828 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2829 Example for Drupal/FastCGI:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2830 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2831 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2832 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2833 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2834
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2835 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2836 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2837
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2838 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2839
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2840 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	2841 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2842 fastcgi_param QUERY_STRING $args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2843
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2844 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2845 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2846
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2847 location @drupal {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2848 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2849
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2850 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	2851 fastcgi_param SCRIPT_NAME /index.php;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2852 fastcgi_param QUERY_STRING q=$uri&$args;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2853
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2854 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2855 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2856 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2857 In the following example,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2858 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2859 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2860 try_files $uri $uri/ @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2861 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2862 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2863 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	2864 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2865 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2866 error_page 404 = @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2867 log_not_found off;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2868 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2869 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2870 And here,
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2871 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2872 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2873 try_files $uri @drupal;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2874
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2875 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2876
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2877 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	2878
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2879 ...
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2880 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2881 </example>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2882 <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	2883 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	2884 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2885
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2886 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2887 Example for Wordpress and Joomla:
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2888 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2889 location / {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2890 try_files $uri $uri/ @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2891 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2892
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2893 location ~ \.php$ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2894 try_files $uri @wordpress;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2895
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2896 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2897
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2898 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	2899 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2900 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2901
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2902 location @wordpress {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2903 fastcgi_pass ...;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2904
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2905 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	2906 ... other fastcgi_param's
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2907 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2908 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2909 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2910
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2911 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2912
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2913
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2914 <directive name="types">
108 72524ae53106 Explicitly marked directives with the block syntax. Such directives will Ruslan Ermilov <ru@nginx.com> parents: 106 diff changeset	2915 <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	2916 <default>
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2917 text/html html;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2918 image/gif gif;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2919 image/jpeg jpg;
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	2920 </default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2921 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2922 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2923 <context>location</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2924
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2925 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2926 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	2927 Extensions are case-insensitive.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2928 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	2929 <example>
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2930 types {
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2931 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	2932 application/octet-stream deb;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2933 application/octet-stream dmg;
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2934 }
0b65e87daa8a Documented that filename extensions that map to MIME types are Ruslan Ermilov <ru@nginx.com> parents: 159 diff changeset	2935 </example>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2936 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2937
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2938 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2939 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	2940 <path>conf/mime.types</path> file.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2941 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2942
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2943 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2944 To make a particular location emit the
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2945 “<literal>application/octet-stream</literal>”
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	2946 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	2947 <example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2948 location /download/ {
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2949 types { }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2950 default_type application/octet-stream;
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2951 }
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2952 </example>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2953 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2954
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2955 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2956
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2957
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2958 <directive name="types_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2959 <syntax><value>size</value></syntax>
1132 8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2960 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2961 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2962 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2963 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2964
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2965 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2966 Sets the bucket size for the types hash tables.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	2967 The details of setting up hash tables are provided in a separate
659 77a3314c74a7 Avoid the uses of second person. Ruslan Ermilov <ru@nginx.com> parents: 651 diff changeset	2968 <link doc="../hash.xml">document</link>.
1132 8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2969 <note>
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2970 Prior to version 1.5.13,
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2971 the default value depended on the size of the processor’s cache line.
8bdb4eb27f48 Documented the new default of "types_hash_bucket_size". Ruslan Ermilov <ru@nginx.com> parents: 1110 diff changeset	2972 </note>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2973 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2974
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2975 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2976
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2977
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2978 <directive name="types_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2979 <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	2980 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2981 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2982 <context>server</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2983 <context>location</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2984
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2985 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2986 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	2987 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	2988 <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	2989 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2990
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2991 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2992
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	2993
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2994 <directive name="underscores_in_headers">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	2995 <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	2996 <default>off</default>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2997 <context>http</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2998 <context>server</context>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2999
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3000 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3001 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	3002 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	3003 contain underscores are
fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3004 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	3005 <link id="ignore_invalid_headers"/> directive.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3006 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3007
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	3008 <para>
1023 375055da60fa Improved wording of merge_slashes etc. (ticket #448). Maxim Dounin <mdounin@mdounin.ru> parents: 1022 diff changeset	3009 If the directive is specified on the <link id="server"/> level,
2795 691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	3010 the value from the default server can be used.
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	3011 Details are provided in the
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	3012 “<link doc="server_names.xml" id="virtual_server_selection">Virtual
691de23367a7 Added link to "Virtual server Selection" in buffer directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2793 diff changeset	3013 server selection</link>” section.
426 1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	3014 </para>
1d6dc85ed324 Specifying "ignore_invalid_headers" or "underscores_in_headers" on the Ruslan Ermilov <ru@nginx.com> parents: 419 diff changeset	3015
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3016 </directive>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3017
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3018
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3019 <directive name="variables_hash_bucket_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3020 <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	3021 <default>64</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3022 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3023
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3024 <para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3025 Sets the bucket size for the variables hash table.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 958 diff changeset	3026 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	3027 <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	3028 </para>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3029
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3030 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3031
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3032
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3033 <directive name="variables_hash_max_size">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3034 <syntax><value>size</value></syntax>
1108 a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	3035 <default>1024</default>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3036 <context>http</context>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3037
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3038 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3039 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	3040 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	3041 <link doc="../hash.xml">document</link>.
1108 a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	3042 <note>
a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	3043 Prior to version 1.5.13, the default value was 512.
a0543e9213e7 New default value for the variables_hash_max_size directive. Andrei Belov <defan@nginx.com> parents: 1101 diff changeset	3044 </note>
1110 4a4fe2d79d14 a0543e9213e7 nit fixed: "note" block moved inside "para". Maxim Konovalov <maxim@nginx.com> parents: 1108 diff changeset	3045 </para>
72 0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3046
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3047 </directive>
0987079ad08f - "try_files" can be specified in the "server" context, Ruslan Ermilov <ru@nginx.com> parents: 70 diff changeset	3048
57 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
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 318 diff changeset	3051
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3052 <section id="variables" name="Embedded Variables">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3053
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3054 <para>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3055 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	3056 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	3057 First of all, these are variables representing client request header
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 72 diff changeset	3058 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	3059 and so on.
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3060 Also there are other variables:
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3061 <list type="tag">
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3062
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3063 <tag-name id="var_arg_"><var>$arg_</var><value>name</value></tag-name>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3064 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3065 argument <value>name</value> in the request line
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3066 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3067
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3068 <tag-name id="var_args"><var>$args</var></tag-name>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3069 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3070 arguments in the request line
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3071 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3072
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3073 <tag-name id="var_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	3074 <tag-desc>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3075 client address in a binary form, value’s length is always 4 bytes
1699 6c96a644b0b3 Corrected description of $binary_remote_addr and saved state. Yaroslav Zhuravlev <yar@nginx.com> parents: 1692 diff changeset	3076 for IPv4 addresses or 16 bytes for IPv6 addresses
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3077 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3078
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3079 <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	3080 <tag-desc>
769 d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3081 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	3082 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	3083 <literal>mod_log_config</literal>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3084 Apache module
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3085 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3086
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3087 <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	3088 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3089 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	3090 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3091
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3092 <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	3093 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3094 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	3095 </tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3096
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3097 <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	3098 <tag-desc>
d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3099 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	3100 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3101
2707 c1d62e514b3c Documented the $connection_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2706 diff changeset	3102 <tag-name id="var_connection_time"><var>$connection_time</var></tag-name>
c1d62e514b3c Documented the $connection_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2706 diff changeset	3103 <tag-desc>
c1d62e514b3c Documented the $connection_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2706 diff changeset	3104 connection time in seconds with a milliseconds resolution (1.19.10)
c1d62e514b3c Documented the $connection_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2706 diff changeset	3105 </tag-desc>
c1d62e514b3c Documented the $connection_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2706 diff changeset	3106
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3107 <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	3108 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3109 <header>Content-Length</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3110 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3111
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3112 <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	3113 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3114 <header>Content-Type</header> request header field
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3115 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3116
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3117 <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	3118 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3119 the <value>name</value> cookie
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3120 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3121
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3122 <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	3123 <tag-desc>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3124 <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	3125 for the current request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3126 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3127
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3128 <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	3129 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3130 same as <var>$uri</var>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3131 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3132
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3133 <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	3134 <tag-desc>
940 ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3135 in this order of precedence:
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3136 host name from the request line, or
ded8f4a5de28 Corrected description of the $host variable. Ruslan Ermilov <ru@nginx.com> parents: 914 diff changeset	3137 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	3138 the server name matching a request
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3139 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3140
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3141 <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	3142 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3143 host name
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3144 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3145
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3146 <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	3147 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3148 arbitrary request header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3149 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	3150 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	3151 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3152
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3153 <tag-name id="var_https"><var>$https</var></tag-name>
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3154 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3155 “<literal>on</literal>”
234 ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3156 if connection operates in SSL mode,
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3157 or an empty string otherwise
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3158 </tag-desc>
ad26f0ae970f Documented the $https variable. Ruslan Ermilov <ru@nginx.com> parents: 225 diff changeset	3159
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3160 <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	3161 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3162 “<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	3163 or an empty string otherwise
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3164 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3165
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3166 <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	3167 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3168 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	3169 see <link id="limit_rate"/>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3170 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3171
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3172 <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	3173 <tag-desc>
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3174 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	3175 </tag-desc>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3176
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3177 <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	3178 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3179 nginx version
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3180 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3181
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3182 <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	3183 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3184 PID of the worker process
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3185 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3186
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3187 <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	3188 <tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3189 “<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	3190 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	3191 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3192
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3193 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3194 <tag-desc>
2457 3896055c397e Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	3195 client address from the PROXY protocol header (1.5.12)
1097 eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3196 <para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3197 The PROXY protocol must be previously enabled by setting the
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3198 <literal>proxy_protocol</literal> parameter
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3199 in the <link id="listen"/> directive.
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3200 </para>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3201 </tag-desc>
eeb690d4212b Documented the PROXY protocol support. Yaroslav Zhuravlev <yar@nginx.com> parents: 1037 diff changeset	3202
1704 792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3203 <tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3204 <tag-desc>
2457 3896055c397e Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	3205 client port from the PROXY protocol header (1.11.0)
1704 792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3206 <para>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3207 The PROXY protocol must be previously enabled by setting the
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3208 <literal>proxy_protocol</literal> parameter
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3209 in the <link id="listen"/> directive.
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3210 </para>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3211 </tag-desc>
792478434bb1 Documented the $proxy_protocol_port variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1699 diff changeset	3212
2458 9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3213 <tag-name id="var_proxy_protocol_server_addr"><var>$proxy_protocol_server_addr</var></tag-name>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3214 <tag-desc>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3215 server address from the PROXY protocol header (1.17.6)
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3216 <para>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3217 The PROXY protocol must be previously enabled by setting the
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3218 <literal>proxy_protocol</literal> parameter
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3219 in the <link id="listen"/> directive.
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3220 </para>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3221 </tag-desc>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3222
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3223 <tag-name id="var_proxy_protocol_server_port"><var>$proxy_protocol_server_port</var></tag-name>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3224 <tag-desc>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3225 server port from the PROXY protocol header (1.17.6)
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3226 <para>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3227 The PROXY protocol must be previously enabled by setting the
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3228 <literal>proxy_protocol</literal> parameter
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3229 in the <link id="listen"/> directive.
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3230 </para>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3231 </tag-desc>
9cd5883ac546 Documented $proxy_protocol_server_addr, $proxy_protocol_server_port. Yaroslav Zhuravlev <yar@nginx.com> parents: 2457 diff changeset	3232
2903 44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3233 <tag-name id="var_proxy_protocol_tlv_"><var>$proxy_protocol_tlv_</var><value>name</value></tag-name>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3234 <tag-desc>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3235 TLV from the PROXY Protocol header (1.23.2).
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3236 The <literal>name</literal> can be a TLV type name or its numeric value.
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3237 In the latter case, the value is hexadecimal
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3238 and should be prefixed with <literal>0x</literal>:
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3239
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3240 <example>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3241 $proxy_protocol_tlv_alpn
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3242 $proxy_protocol_tlv_0x01
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3243 </example>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3244 SSL TLVs can also be accessed by TLV type name
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3245 or its numeric value,
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3246 both prefixed by <literal>ssl_</literal>:
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3247 <example>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3248 $proxy_protocol_tlv_ssl_version
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3249 $proxy_protocol_tlv_ssl_0x21
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3250 </example>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3251
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3252 <para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3253 The following TLV type names are supported:
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3254 <list type="bullet">
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3255
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3256 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3257 <literal>alpn</literal> (<literal>0x01</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3258 upper layer protocol used over the connection
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3259 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3260
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3261 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3262 <literal>authority</literal> (<literal>0x02</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3263 host name value passed by the client
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3264 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3265
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3266 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3267 <literal>unique_id</literal> (<literal>0x05</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3268 unique connection id
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3269 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3270
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3271 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3272 <literal>netns</literal> (<literal>0x30</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3273 name of the namespace
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3274 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3275
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3276 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3277 <literal>ssl</literal> (<literal>0x20</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3278 binary SSL TLV structure
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3279 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3280
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3281 </list>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3282 </para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3283
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3284 <para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3285 The following SSL TLV type names are supported:
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3286 <list type="bullet">
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3287
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3288 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3289 <literal>ssl_version</literal> (<literal>0x21</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3290 SSL version used in client connection
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3291 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3292
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3293 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3294 <literal>ssl_cn</literal> (<literal>0x22</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3295 SSL certificate Common Name
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3296 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3297
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3298 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3299 <literal>ssl_cipher</literal> (<literal>0x23</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3300 name of the used cipher
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3301 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3302
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3303 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3304 <literal>ssl_sig_alg</literal> (<literal>0x24</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3305 algorithm used to sign the certificate
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3306 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3307
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3308 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3309 <literal>ssl_key_alg</literal> (<literal>0x25</literal>)—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3310 public-key algorithm
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3311 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3312
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3313 </list>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3314 </para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3315
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3316 <para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3317 Also, the following special SSL TLV type name is supported:
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3318 <list type="bullet">
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3319
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3320 <listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3321 <literal>ssl_verify</literal>—
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3322 client SSL certificate verification result,
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3323 <literal>0</literal> if the client presented a certificate
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3324 and it was successfully verified,
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3325 non-zero otherwise.
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3326 </listitem>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3327
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3328 </list>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3329 </para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3330
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3331 <para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3332 The PROXY protocol must be previously enabled by setting the
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3333 <literal>proxy_protocol</literal> parameter
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3334 in the <link id="listen"/> directive.
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3335 </para>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3336 </tag-desc>
44f3b52c0679 Documented the $proxy_protocol_tlv_ variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2870 diff changeset	3337
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3338 <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	3339 <tag-desc>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3340 same as <var>$args</var>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3341 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3342
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3343 <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	3344 <tag-desc>
436 3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	3345 an absolute pathname corresponding to the
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3346 <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	3347 for the current request,
3a9f39341c7c - Documented the "from" parameter of the "disable_symlinks" directive, Ruslan Ermilov <ru@nginx.com> parents: 429 diff changeset	3348 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	3349 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3350
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3351 <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	3352 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3353 client address
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3354 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3355
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3356 <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	3357 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3358 client port
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3359 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3360
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3361 <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	3362 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3363 user name supplied with the Basic authentication
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3364 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3365
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3366 <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	3367 <tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3368 full original request line
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3369 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3370
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3371 <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	3372 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3373 request body
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3374 <para>
625 af3f38e349eb Removed terminal whitespace and fixed apostrophes used. Ruslan Ermilov <ru@nginx.com> parents: 617 diff changeset	3375 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	3376 processed by the
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3377 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>,
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3378 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3379 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>,
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3380 and
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3381 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>
1732 5eb54b170c74 Clarified cases when $request_body is not empty. Yaroslav Zhuravlev <yar@nginx.com> parents: 1721 diff changeset	3382 directives when the request body was read to
5eb54b170c74 Clarified cases when $request_body is not empty. Yaroslav Zhuravlev <yar@nginx.com> parents: 1721 diff changeset	3383 a <link id="client_body_buffer_size">memory buffer</link>.
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3384 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3385 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3386
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3387 <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	3388 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3389 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	3390 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3391 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	3392 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	3393 <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	3394 When the name of a temporary file is passed in a proxied request
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3395 or in a request to a FastCGI/uwsgi/SCGI server,
958 fd1f8e0a405e Text review of ngx_http_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 941 diff changeset	3396 passing the request body should be disabled by the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3397 <link doc="ngx_http_proxy_module.xml" id="proxy_pass_request_body">
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3398 proxy_pass_request_body off</link>,
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3399 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass_request_body">
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3400 fastcgi_pass_request_body off</link>,
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3401 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass_request_body">
9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	3402 uwsgi_pass_request_body off</link>, or
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3403 <link doc="ngx_http_scgi_module.xml" id="scgi_pass_request_body">
b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1151 diff changeset	3404 scgi_pass_request_body off</link>
57 12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3405 directives, respectively.
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3406 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3407 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3408
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3409 <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	3410 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3411 “<literal>OK</literal>” if a request has completed,
88 6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3412 or an empty string otherwise
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3413 </tag-desc>
6876e2558d09 Spell checking. Ruslan Ermilov <ru@nginx.com> parents: 86 diff changeset	3414
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3415 <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	3416 <tag-desc>
530 d8c7160527ae query -> request Ruslan Ermilov <ru@nginx.com> parents: 527 diff changeset	3417 file path for the current request, based on the
246 6bfacf7124c6 Minor tweaks. Ruslan Ermilov <ru@nginx.com> parents: 244 diff changeset	3418 <link id="root"/> or <link id="alias"/>
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3419 directives, and the request URI
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3420 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3421
1692 4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3422 <tag-name id="var_request_id"><var>$request_id</var></tag-name>
4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3423 <tag-desc>
1721 737c86e8b316 Clarified meaning of the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1704 diff changeset	3424 unique request identifier
737c86e8b316 Clarified meaning of the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1704 diff changeset	3425 generated from 16 random bytes, in hexadecimal (1.11.0)
1692 4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3426 </tag-desc>
4319f72f11f5 Documented the $request_id variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	3427
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3428 <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	3429 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3430 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	3431 (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	3432 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3433
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3434 <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	3435 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3436 request method, usually
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3437 “<literal>GET</literal>” or “<literal>POST</literal>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3438 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3439
771 47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3440 <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	3441 <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	3442 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	3443 (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	3444 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	3445 </tag-desc>
47ad88faaa3f $msec and $request_time have become generic variables in 1.3.9. Ruslan Ermilov <ru@nginx.com> parents: 769 diff changeset	3446
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3447 <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	3448 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3449 full original request URI (with arguments)
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3450 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3451
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3452 <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	3453 <tag-desc>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	3454 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	3455 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3456
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3457 <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	3458 <tag-desc>
448 92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3459 arbitrary response header field;
92672f6f0ee1 Elaborated on $http_* and $sent_http_* syntax. Ruslan Ermilov <ru@nginx.com> parents: 442 diff changeset	3460 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	3461 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	3462 </tag-desc>
341dc6392e8a Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_. Ruslan Ermilov <ru@nginx.com>* parents: 83 diff changeset	3463
2003 be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3464 <tag-name id="var_sent_trailer_"><var>$sent_trailer_</var><value>name</value></tag-name>
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3465 <tag-desc>
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3466 arbitrary field sent at the end of the response (1.13.2);
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3467 the last part of a variable name is the field name converted
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3468 to lower case with dashes replaced by underscores
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3469 </tag-desc>
be779702663e Documented the "sent_trailer_" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1964 diff changeset	3470
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3471 <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	3472 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3473 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	3474 <para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3475 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	3476 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	3477 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	3478 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3479 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3480
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3481 <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	3482 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3483 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	3484 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3485
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3486 <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	3487 <tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3488 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	3489 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3490
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3491 <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	3492 <tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3493 request protocol, usually
1597 8b97ba73129b Added HTTP/2.0 to the "server_protocol" variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1576 diff changeset	3494 “<literal>HTTP/1.0</literal>”,
1614 1bab8e5f53c6 Added Oxford comma to "$server_protocol". Yaroslav Zhuravlev <yar@nginx.com> parents: 1597 diff changeset	3495 “<literal>HTTP/1.1</literal>”,
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	3496 “<link doc="ngx_http_v2_module.xml">HTTP/2.0</link>”,
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3497 or
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2922 diff changeset	3498 “<link doc="ngx_http_v3_module.xml">HTTP/3.0</link>”
83 e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3499 </tag-desc>
e8ed74d3fa0e Sorted variables alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	3500
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3501 <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	3502 <tag-desc>
769 d71e56d56ada Documented variables relocations between http log and core modules. Vladimir Homutov <vl@nginx.com> parents: 768 diff changeset	3503 response status (1.3.2, 1.2.2)
541 a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3504 </tag-desc>
a8971cf346be Documented the $status core variable. Andrey Belov <defan@nginx.com> parents: 537 diff changeset	3505
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3506 <tag-name id="var_tcpinfo_">
453 98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3507 <var>$tcpinfo_rtt</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3508 <var>$tcpinfo_rttvar</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3509 <var>$tcpinfo_snd_cwnd</var>,
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3510 <var>$tcpinfo_rcv_space</var>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3511 </tag-name>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3512 <tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3513 information about the client TCP connection; available on systems
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3514 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	3515 </tag-desc>
98ee97a382d3 Documented the $tcpinfo_* variables. Ruslan Ermilov <ru@nginx.com> parents: 448 diff changeset	3516
826 ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3517 <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	3518 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3519 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	3520 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3521
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3522 <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	3523 <tag-desc>
840 9dab69f2b71d Documented nginx 1.2.7 changes. Ruslan Ermilov <ru@nginx.com> parents: 835 diff changeset	3524 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	3525 </tag-desc>
ddd22f571529 Variables $pipe, $request_length, $time_iso8601, and $time_local. Ruslan Ermilov <ru@nginx.com> parents: 810 diff changeset	3526
768 f63b7fa3bf17 Added "id" attributes to http core module variables. Vladimir Homutov <vl@nginx.com> parents: 767 diff changeset	3527 <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	3528 <tag-desc>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3529 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	3530 <para>
503 aed015c3dedd Documented URI normalization rules, including %-decoding. Ruslan Ermilov <ru@nginx.com> parents: 499 diff changeset	3531 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	3532 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	3533 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3534 </tag-desc>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3535
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3536 </list>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3537 </para>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3538
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3539 </section>
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3540
12f1de4539b4 Initial English translation of ngx_http_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3541 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_core_module.xml @ 3083:3b5594157fab