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