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