Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_core_module.xml @ 2948:37e082fd009c
Added TLSv1.3 to the default value of ssl_protocols and friends.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Fri, 10 Mar 2023 22:17:07 +0000 |
parents | 547303412ab9 |
children | a85e4d126bc7 |
rev | line source |
---|---|
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
576
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
576
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
576
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
576
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
576
diff
changeset
|
7 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
89 | 10 <module name="Module ngx_http_core_module" |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_core_module.html" |
589 | 12 lang="en" |
2921
52ea1f45b324
Clarified "if_modified_since off" behaviour (ticket #2176).
Maxim Dounin <mdounin@mdounin.ru>
parents:
2912
diff
changeset
|
13 rev="103"> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="directives" name="Directives"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
1879
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
17 <directive name="absolute_redirect"> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
18 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
19 <default>on</default> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
20 <context>http</context> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
21 <context>server</context> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
22 <context>location</context> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
23 <appeared-in>1.11.8</appeared-in> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
24 |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
25 <para> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
26 If disabled, redirects issued by nginx will be relative. |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
27 </para> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
28 |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
29 <para> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
30 See also <link id="server_name_in_redirect"/> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
31 and <link id="port_in_redirect"/> directives. |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
32 </para> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
33 |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
34 </directive> |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
35 |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
36 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
37 <directive name="aio"> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
38 <syntax> |
364 | 39 <literal>on</literal> | |
1436 | 40 <literal>off</literal> | |
41 <literal>threads</literal>[<literal>=</literal><value>pool</value>]</syntax> | |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
42 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <context>location</context> |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
46 <appeared-in>0.8.11</appeared-in> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 Enables or disables the use of asynchronous file I/O (AIO) |
1432
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
50 on FreeBSD and Linux: |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
51 <example> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
52 location /video/ { |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
53 aio on; |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
54 output_buffers 1 64k; |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
55 } |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
56 </example> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
60 On FreeBSD, AIO can be used starting from FreeBSD 4.3. |
1859
5cd4964fbc5f
Updated AIO description for FreeBSD 11.0 and upwards.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1827
diff
changeset
|
61 Prior to FreeBSD 11.0, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
62 AIO can either be linked statically into a kernel: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
64 options VFS_AIO |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
65 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 or loaded dynamically as a kernel loadable module: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
68 kldload aio |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 |
1430
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
72 <!-- |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 In FreeBSD versions 5 and 6, enabling AIO statically, or dynamically |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 when booting the kernel, will cause the entire networking subsystem |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
76 to use the Giant lock, which can impact overall performance negatively. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 This limitation has been removed in FreeBSD 6.4-STABLE in 2009, and in |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 FreeBSD 7. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 However, starting from FreeBSD 5.3 it is possible to enable AIO |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 without the penalty of running the networking subsystem under a |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 Giant lock—for this to work, the AIO module needs to be loaded |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 after the kernel has booted. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 In this case, the following message will appear in |
148
682163f2b298
Unified article/path and module/pathname into a single "path".
Ruslan Ermilov <ru@nginx.com>
parents:
147
diff
changeset
|
84 <path>/var/log/messages</path> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 WARNING: Network stack Giant-free, but aio requires Giant. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 Consider adding 'options NET_WITH_GIANT' or setting debug.mpsafenet=0 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 and can safely be ignored. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 <note> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 The requirement to use the Giant lock with AIO is related to the |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 fact that FreeBSD supports asynchronous calls |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 <c-func>aio_read</c-func> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 and |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 <c-func>aio_write</c-func> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 when working with sockets. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
97 However, since nginx uses AIO only for disk I/O, no problems should arise. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 </note> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 </para> |
1430
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
100 --> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
103 On Linux, AIO can be used starting from kernel version 2.6.22. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
104 Also, it is necessary to enable |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
105 <link id="directio"/>, |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
106 or otherwise reading will be blocking: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 location /video/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 aio on; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 directio 512; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 output_buffers 1 128k; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 On Linux, |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
118 <link id="directio"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 can only be used for reading blocks that are aligned on 512-byte |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 boundaries (or 4K for XFS). |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
121 File’s unaligned end is read in blocking mode. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
122 The same holds true for byte range requests and for FLV requests |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 not from the beginning of a file: reading of unaligned data at the |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 beginning and end of a file will be blocking. |
1430
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
125 </para> |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
126 |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
127 <para> |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
128 When both AIO and <link id="sendfile"/> are enabled on Linux, |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
129 AIO is used for files that are larger than or equal to |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
130 the size specified in the <link id="directio"/> directive, |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
131 while <link id="sendfile"/> is used for files of smaller sizes |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
132 or when <link id="directio"/> is disabled. |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
133 <example> |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
134 location /video/ { |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
135 sendfile on; |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
136 aio on; |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
137 directio 8m; |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
138 } |
0eb8e261f349
AIO: clarified the use of both AIO and sendfile on Linux.
Ruslan Ermilov <ru@nginx.com>
parents:
1414
diff
changeset
|
139 </example> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 |
1432
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
142 <para> |
1436 | 143 Finally, files can be read and <link id="sendfile">sent</link> |
144 using multi-threading (1.7.11), | |
145 without blocking a worker process: | |
146 <example> | |
147 location /video/ { | |
148 sendfile on; | |
149 aio threads; | |
150 } | |
151 </example> | |
152 Read and send file operations are offloaded to threads of the specified | |
153 <link doc="../ngx_core_module.xml" id="thread_pool">pool</link>. | |
154 If the pool name is omitted, | |
155 the pool with the name “<literal>default</literal>” is used. | |
156 The pool name can also be set with variables: | |
157 <example> | |
158 aio threads=pool$disk; | |
159 </example> | |
160 By default, multi-threading is disabled, it should be | |
161 enabled with the | |
162 <literal>--with-threads</literal> configuration parameter. | |
163 Currently, multi-threading is compatible only with the | |
164 <link doc="../events.xml" id="epoll"/>, | |
165 <link doc="../events.xml" id="kqueue"/>, | |
166 and | |
167 <link doc="../events.xml" id="eventport"/> methods. | |
168 Multi-threaded sending of files is only supported on Linux. | |
169 </para> | |
170 | |
171 <para> | |
1432
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
172 See also the <link id="sendfile"/> directive. |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
173 </para> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
174 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 |
1664
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
178 <directive name="aio_write"> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
179 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
180 <default>off</default> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
181 <context>http</context> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
182 <context>server</context> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
183 <context>location</context> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
184 <appeared-in>1.9.13</appeared-in> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
185 |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
186 <para> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
187 If <link id="aio"/> is enabled, specifies whether it is used for writing files. |
1665
57b53a0818df
Slightly paraphrased aio_write description for better perception.
Ruslan Ermilov <ru@nginx.com>
parents:
1664
diff
changeset
|
188 Currently, this only works when using |
1664
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
189 <literal>aio threads</literal> |
1665
57b53a0818df
Slightly paraphrased aio_write description for better perception.
Ruslan Ermilov <ru@nginx.com>
parents:
1664
diff
changeset
|
190 and is limited to writing temporary files |
57b53a0818df
Slightly paraphrased aio_write description for better perception.
Ruslan Ermilov <ru@nginx.com>
parents:
1664
diff
changeset
|
191 with data received from proxied servers. |
1664
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
192 </para> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
193 |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
194 </directive> |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
195 |
1a05fd32dca8
Documented the "aio_write" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1636
diff
changeset
|
196 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 <directive name="alias"> |
271 | 198 <syntax><value>path</value></syntax> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 <default/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 Defines a replacement for the specified location. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 For example, with the following configuration |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 location /i/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 alias /data/w3/images/; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 </example> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
210 on request of |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
211 “<literal>/i/top.gif</literal>”, the file |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
212 <path>/data/w3/images/top.gif</path> will be sent. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
216 The <value>path</value> value can contain variables, |
65
f122a777a6de
- Use of $document_root and $realpath_root in "alias" is prohibited.
Ruslan Ermilov <ru@nginx.com>
parents:
57
diff
changeset
|
217 except <var>$document_root</var> and <var>$realpath_root</var>. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 <para> |
271 | 221 If <literal>alias</literal> is used inside a location defined |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 with a regular expression then such regular expression should |
271 | 223 contain captures and <literal>alias</literal> should refer to |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 these captures (0.7.40), for example: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 location ~ ^/users/(.+\.(?:gif|jpe?g|png))$ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 alias /data/w3/images/$1; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 <para> |
625
af3f38e349eb
Removed terminal whitespace and fixed apostrophes used.
Ruslan Ermilov <ru@nginx.com>
parents:
617
diff
changeset
|
233 When location matches the last part of the directive’s value: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 location /images/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 alias /data/w3/images/; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 it is better to use the |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
240 <link id="root"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 directive instead: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 location /images/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 root /data/w3; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
251 |
2523
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
252 <directive name="auth_delay"> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
253 <syntax><value>time</value></syntax> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
254 <default>0s</default> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
255 <context>http</context> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
256 <context>server</context> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
257 <context>location</context> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
258 <appeared-in>1.17.10</appeared-in> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
259 |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
260 <para> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
261 Delays processing of unauthorized requests with 401 response code |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
262 to prevent timing attacks when access is limited by |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
263 <link doc="ngx_http_auth_basic_module.xml">password</link>, by the |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
264 <link doc="ngx_http_auth_request_module.xml">result of subrequest</link>, |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
265 or by <link doc="ngx_http_auth_jwt_module.xml">JWT</link>. |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
266 </para> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
267 |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
268 </directive> |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
269 |
2bb06b3fbcc5
Documented the "auth_delay" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2458
diff
changeset
|
270 |
162
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
271 <directive name="chunked_transfer_encoding"> |
271 | 272 <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
|
273 <default>on</default> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
274 <context>http</context> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
275 <context>server</context> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
276 <context>location</context> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
277 |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
278 <para> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
279 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
|
280 It may come in handy when using a software failing to support |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
281 chunked encoding despite the standard’s requirement. |
162
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
282 </para> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
283 |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
284 </directive> |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
285 |
a8bd350e3481
Documented the "chunked_transfer_encoding" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
161
diff
changeset
|
286 |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
287 <directive name="client_body_buffer_size"> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
288 |
271 | 289 <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
|
290 <default>8k|16k</default> |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
291 <context>http</context> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
292 <context>server</context> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
293 <context>location</context> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
294 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
295 <para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
296 Sets buffer size for reading client request body. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
297 In case the request body is larger than the buffer, |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
298 the whole body or only its part is written to a |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
299 <link id="client_body_temp_path">temporary file</link>. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
300 By default, buffer size is equal to two memory pages. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
301 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
|
302 It is usually 16K on other 64-bit platforms. |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
303 </para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
304 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
305 </directive> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
306 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
307 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 <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
|
309 <syntax> |
364 | 310 <literal>on</literal> | |
311 <literal>clean</literal> | | |
312 <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
|
313 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
316 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
317 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
318 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
319 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
|
320 into a file. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 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
|
322 <var>$request_body_file</var> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 variable, or the |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 <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
|
325 method of the module |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
326 <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
|
327 </para> |
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 <para> |
271 | 330 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
|
331 removed after request processing. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 <para> |
271 | 335 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
|
336 left after request processing to be removed. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
337 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
338 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
339 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
340 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 <directive name="client_body_in_single_buffer"> |
271 | 343 <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
|
344 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 <context>location</context> |
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 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 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
|
351 in a single buffer. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 The directive is recommended when using the |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 <var>$request_body</var> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 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
|
355 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
358 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 <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
|
361 <syntax> |
364 | 362 <value>path</value> |
363 [<value>level1</value> | |
364 [<value>level2</value> | |
365 [<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
|
366 <default>client_body_temp</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 Defines a directory for storing temporary files holding client request bodies. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
373 Up to three-level subdirectory hierarchy can be used under the specified |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 directory. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
375 For example, in the following configuration |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
376 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
377 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
|
378 </example> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
379 a path to a temporary file might look like this: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 /spool/nginx/client_temp/7/45/00000123457 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
384 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
385 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
386 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
387 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 <directive name="client_body_timeout"> |
271 | 389 <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
|
390 <default>60s</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
391 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
392 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
393 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
396 Defines a timeout for reading client request body. |
966 | 397 The timeout is set only for a period between two successive read operations, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
398 not for the transmission of the whole request body. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
399 If a client does not transmit anything within this time, the |
2220
896562a1ccde
Fixed description of client_header_timeout and client_body_timeout.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2206
diff
changeset
|
400 request is terminated with the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
401 <http-status code="408" text="Request Time-out"/> |
2220
896562a1ccde
Fixed description of client_header_timeout and client_body_timeout.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2206
diff
changeset
|
402 error. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
403 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
404 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
405 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 <directive name="client_header_buffer_size"> |
271 | 409 <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
|
410 <default>1k</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 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
|
416 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
|
417 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
|
418 it may not fit into 1K. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
419 If a request line or a request header field does not fit into |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
420 this buffer then larger buffers, configured by the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
421 <link id="large_client_header_buffers"/> directive, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
422 are allocated. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
423 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
424 |
2795
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
425 <para> |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
426 If the directive is specified on the <link id="server"/> level, |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
427 the value from the default server can be used. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
428 Details are provided in the |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
429 “<link doc="server_names.xml" id="virtual_server_selection">Virtual |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
430 server selection</link>” section. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
431 </para> |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
432 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
433 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
434 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
435 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
436 <directive name="client_header_timeout"> |
271 | 437 <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
|
438 <default>60s</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
440 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
441 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
442 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
443 Defines a timeout for reading client request header. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
444 If a client does not transmit the entire header within this time, the |
2220
896562a1ccde
Fixed description of client_header_timeout and client_body_timeout.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2206
diff
changeset
|
445 request is terminated with the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
446 <http-status code="408" text="Request Time-out"/> |
2220
896562a1ccde
Fixed description of client_header_timeout and client_body_timeout.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2206
diff
changeset
|
447 error. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
448 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
449 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
450 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
451 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
452 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
453 <directive name="client_max_body_size"> |
271 | 454 <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
|
455 <default>1m</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
456 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
457 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
458 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
459 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
460 <para> |
2657
679fb7712ab4
Updated client_max_body_size for chunked encoding and HTTP/2.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2593
diff
changeset
|
461 Sets the maximum allowed size of the client request body. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
462 If the size in a request exceeds the configured value, the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
463 <http-status code="413" text="Request Entity Too Large"/> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
464 error is returned to the client. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
465 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
|
466 <!--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
|
467 this error<!--/link-->. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
468 Setting <value>size</value> to 0 disables checking of client |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
469 request body size. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
470 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
471 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
472 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
473 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
474 |
161
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
475 <directive name="connection_pool_size"> |
271 | 476 <syntax><value>size</value></syntax> |
1619
88ad8fcea975
Changed default value of connection_pool_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1614
diff
changeset
|
477 <default>256|512</default> |
161
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
478 <context>http</context> |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
479 <context>server</context> |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
480 |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
481 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
482 Allows accurate tuning of per-connection memory allocations. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
483 This directive has minimal impact on performance |
161
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
484 and should not generally be used. |
1619
88ad8fcea975
Changed default value of connection_pool_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1614
diff
changeset
|
485 By default, the size is equal to |
88ad8fcea975
Changed default value of connection_pool_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1614
diff
changeset
|
486 256 bytes on 32-bit platforms and 512 bytes on 64-bit platforms. |
88ad8fcea975
Changed default value of connection_pool_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1614
diff
changeset
|
487 <note> |
88ad8fcea975
Changed default value of connection_pool_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1614
diff
changeset
|
488 Prior to version 1.9.8, the default value was 256 on all platforms. |
88ad8fcea975
Changed default value of connection_pool_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1614
diff
changeset
|
489 </note> |
161
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
490 </para> |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
491 |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
492 </directive> |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
493 |
ec980064d576
Documented the "connection_pool_size" and "request_pool_size" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
160
diff
changeset
|
494 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
495 <directive name="default_type"> |
271 | 496 <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
|
497 <default>text/plain</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
498 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
499 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
500 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
501 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
502 <para> |
966 | 503 Defines the default MIME type of a response. |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
504 Mapping of file name extensions to MIME types can be set |
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
505 with the <link id="types"/> directive. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
506 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
507 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
508 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
509 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
510 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
511 <directive name="directio"> |
271 | 512 <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
|
513 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
514 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
515 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
516 <context>location</context> |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
517 <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
|
518 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
519 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
520 Enables the use of |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
521 the <c-def>O_DIRECT</c-def> flag (FreeBSD, Linux), |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1904
diff
changeset
|
522 the <c-def>F_NOCACHE</c-def> flag (macOS), |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
523 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
|
524 when reading files that are larger than or equal to |
271 | 525 the specified <value>size</value>. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
526 The directive automatically disables (0.7.15) the use of |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
527 <link id="sendfile"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
528 for a given request. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
529 It can be useful for serving large files: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
530 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
531 directio 4m; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
532 </example> |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
533 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
|
534 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
535 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
536 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
537 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
538 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
539 <directive name="directio_alignment"> |
271 | 540 <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
|
541 <default>512</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
542 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
543 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
544 <context>location</context> |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
545 <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
|
546 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
547 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
548 Sets the alignment for |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
549 <link id="directio"/>. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
550 In most cases, a 512-byte alignment is enough. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
551 However, when using XFS under Linux, it needs to be increased to 4K. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
552 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
553 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
554 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
555 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
556 |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
557 <directive name="disable_symlinks"> |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
558 <syntax><literal>off</literal></syntax> |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
559 <syntax> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
560 <literal>on</literal> | |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
561 <literal>if_not_owner</literal> |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
562 [<literal>from</literal>=<value>part</value>]</syntax> |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
563 <default>off</default> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
564 <context>http</context> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
565 <context>server</context> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
566 <context>location</context> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
567 <appeared-in>1.1.15</appeared-in> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
568 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
569 <para> |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
570 Determines how symbolic links should be treated when opening files: |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
571 <list type="tag"> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
572 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
573 <tag-name><literal>off</literal></tag-name> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
574 <tag-desc> |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
575 Symbolic links in the pathname are allowed and not checked. |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
576 This is the default behavior. |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
577 </tag-desc> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
578 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
579 <tag-name><literal>on</literal></tag-name> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
580 <tag-desc> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
581 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
|
582 access to a file is denied. |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
583 </tag-desc> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
584 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
585 <tag-name><literal>if_not_owner</literal></tag-name> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
586 <tag-desc> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
587 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
|
588 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
|
589 points to have different owners. |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
590 </tag-desc> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
591 |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
592 <tag-name><literal>from</literal>=<value>part</value></tag-name> |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
593 <tag-desc> |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
594 When checking symbolic links |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
595 (parameters <literal>on</literal> and <literal>if_not_owner</literal>), |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
596 all components of the pathname are normally checked. |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
597 Checking of symbolic links in the initial part of the pathname |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
598 may be avoided by specifying additionally the |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
599 <literal>from</literal>=<value>part</value> parameter. |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
600 In this case, symbolic links are checked only from |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
601 the pathname component that follows the specified initial part. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
602 If the value is not an initial part of the pathname checked, the whole |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
603 pathname is checked as if this parameter was not specified at all. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
604 If the value matches the whole file name, |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
605 symbolic links are not checked. |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
606 The parameter value can contain variables. |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
607 </tag-desc> |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
608 |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
609 </list> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
610 </para> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
611 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
612 <para> |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
613 Example: |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
614 <example> |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
615 disable_symlinks on from=$document_root; |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
616 </example> |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
617 </para> |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
618 |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
619 <para> |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
620 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
|
621 <c-func>openat</c-func> and <c-func>fstatat</c-func> interfaces. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
622 Such systems include modern versions of FreeBSD, Linux, and Solaris. |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
623 </para> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
624 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
625 <para> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
626 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
|
627 add a processing overhead. |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
628 <note> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
629 On systems that do not support opening of directories only for search, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
630 to use these parameters it is required that worker processes |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
631 have read permissions for all directories being checked. |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
632 </note> |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
633 </para> |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
634 |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
635 <para> |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
636 <note> |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
637 The |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
638 <link doc="ngx_http_autoindex_module.xml">ngx_http_autoindex_module</link>, |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
639 <link doc="ngx_http_random_index_module.xml">ngx_http_random_index_module</link>, |
477
c5680571ec09
Unnecessary extensions removed from links.
Andrey Belov <defan@nginx.com>
parents:
476
diff
changeset
|
640 and <link doc="ngx_http_dav_module.xml">ngx_http_dav_module</link> |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
641 modules currently ignore this directive. |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
642 </note> |
418
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
643 </para> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
644 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
645 </directive> |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
646 |
2638f67205ee
Documented the disable_symlinks directive.
Ruslan Ermilov <ru@nginx.com>
parents:
406
diff
changeset
|
647 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
648 <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
|
649 <syntax> |
364 | 650 <value>code</value> ... |
651 [<literal>=</literal>[<value>response</value>]] | |
652 <value>uri</value></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>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
655 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
656 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
657 <context>if in location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
658 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
659 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
660 Defines the URI that will be shown for the specified errors. |
1826
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
661 A <value>uri</value> value can contain variables. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
662 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
663 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
664 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
665 Example: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
666 <example> |
711
1f383a8bccdb
Minor improvements over the recent additions to the "error_page" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
709
diff
changeset
|
667 error_page 404 /404.html; |
1f383a8bccdb
Minor improvements over the recent additions to the "error_page" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
709
diff
changeset
|
668 error_page 500 502 503 504 /50x.html; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
669 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
670 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
671 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
672 <para> |
1827
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
673 This causes an internal redirect to the specified <value>uri</value> |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
674 with the client request method changed to “<literal>GET</literal>” |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
675 (for all methods other than |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
676 “<literal>GET</literal>” and “<literal>HEAD</literal>”). |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
677 </para> |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
678 |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
679 <para> |
679
9888364847b7
Documented status codes in the error_page directive.
Vladimir Homutov <vl@nginx.com>
parents:
674
diff
changeset
|
680 Furthermore, it is possible to change the response code to another |
711
1f383a8bccdb
Minor improvements over the recent additions to the "error_page" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
709
diff
changeset
|
681 using the “<literal>=</literal><value>response</value>” syntax, for example: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
682 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
683 error_page 404 =200 /empty.gif; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
684 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
685 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
686 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
687 <para> |
1194 | 688 If an error response is processed by a proxied server |
2134
4cafd82e5007
Added info about gRPC to various modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2125
diff
changeset
|
689 or a FastCGI/uwsgi/SCGI/gRPC server, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
690 and the server may return different response codes (e.g., 200, 302, 401 |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
691 or 404), it is possible to respond with the code it returns: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
692 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
693 error_page 404 = /404.php; |
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 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
696 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
697 <para> |
1827
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
698 If there is no need to change URI and method during internal redirection |
64e2b8c5200d
Documented request method change by error_page in /uri redirection.
Ruslan Ermilov <ru@nginx.com>
parents:
1826
diff
changeset
|
699 it is possible to pass error processing into a named location: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
700 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 error_page 404 = @fallback; |
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 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
705 location @fallback { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 proxy_pass http://backend; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
708 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
709 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 |
679
9888364847b7
Documented status codes in the error_page directive.
Vladimir Homutov <vl@nginx.com>
parents:
674
diff
changeset
|
711 <para> |
9888364847b7
Documented status codes in the error_page directive.
Vladimir Homutov <vl@nginx.com>
parents:
674
diff
changeset
|
712 <note> |
1826
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
713 If <value>uri</value> processing leads to an error, |
747 | 714 the status code of the last occurred error is returned to the client. |
679
9888364847b7
Documented status codes in the error_page directive.
Vladimir Homutov <vl@nginx.com>
parents:
674
diff
changeset
|
715 </note> |
9888364847b7
Documented status codes in the error_page directive.
Vladimir Homutov <vl@nginx.com>
parents:
674
diff
changeset
|
716 </para> |
9888364847b7
Documented status codes in the error_page directive.
Vladimir Homutov <vl@nginx.com>
parents:
674
diff
changeset
|
717 |
1826
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
718 <para> |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
719 It is also possible to use URL redirects for error processing: |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
720 <example> |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
721 error_page 403 http://example.com/forbidden.html; |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
722 error_page 404 =301 http://example.com/notfound.html; |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
723 </example> |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
724 In this case, by default, the response code 302 is returned to the client. |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
725 It can only be changed to one of the redirect status |
1964
2a3c58dcb3e8
Documented support for the 308 Permanent Redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1953
diff
changeset
|
726 codes (301, 302, 303, 307, and 308). |
2039
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
727 <note> |
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
728 The code 307 was not treated as a redirect until versions 1.1.16 and 1.0.13. |
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
729 </note> |
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
730 |
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
731 <note> |
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
732 The code 308 was not treated as a redirect until version 1.13.0. |
d2969b2f69ae
Added history notes about codes 201, 307, and 308.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2036
diff
changeset
|
733 </note> |
1826
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
734 </para> |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
735 |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
736 <para> |
2593
eeed494bba51
Unified phrases about configuration levels and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
2567
diff
changeset
|
737 These directives are inherited from the previous configuration level |
eeed494bba51
Unified phrases about configuration levels and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
2567
diff
changeset
|
738 if and only if there are no <literal>error_page</literal> directives |
eeed494bba51
Unified phrases about configuration levels and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
2567
diff
changeset
|
739 defined on the current level. |
1826
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
740 </para> |
da6a3e401b26
Slightly reformatted the error_page description.
Ruslan Ermilov <ru@nginx.com>
parents:
1770
diff
changeset
|
741 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
742 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
743 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
744 |
576
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
745 <directive name="etag"> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
746 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
747 <default>on</default> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
748 <context>http</context> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
749 <context>server</context> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
750 <context>location</context> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
751 <appeared-in>1.3.3</appeared-in> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
752 |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
753 <para> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
754 Enables or disables automatic generation of the <header>ETag</header> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
755 response header field for static resources. |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
756 </para> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
757 |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
758 </directive> |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
759 |
cac22cc79afd
Documented the "etag" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
566
diff
changeset
|
760 |
651
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
761 <directive name="http"> |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
762 <syntax block="yes"/> |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
763 <default/> |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
764 <context>main</context> |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
765 |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
766 <para> |
966 | 767 Provides the configuration file context in which the HTTP server directives |
651
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
768 are specified. |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
769 </para> |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
770 |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
771 </directive> |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
772 |
eba81bfb6aaf
Documented the "http" directive.
Vladimir Homutov <vl@nginx.com>
parents:
628
diff
changeset
|
773 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
774 <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
|
775 <syntax> |
364 | 776 <literal>off</literal> | |
777 <literal>exact</literal> | | |
778 <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
|
779 <default>exact</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
780 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
781 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
782 <context>location</context> |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
783 <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
|
784 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
785 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
786 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
|
787 with the time in the |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
788 <header>If-Modified-Since</header> |
235
6d8356490215
Consistently call header fields as such.
Ruslan Ermilov <ru@nginx.com>
parents:
234
diff
changeset
|
789 request header field: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
790 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
791 <list type="tag"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
792 |
271 | 793 <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
|
794 <tag-desc> |
2921
52ea1f45b324
Clarified "if_modified_since off" behaviour (ticket #2176).
Maxim Dounin <mdounin@mdounin.ru>
parents:
2912
diff
changeset
|
795 the response is always considered modified (0.7.34); |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
796 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
797 |
271 | 798 <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
|
799 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
800 exact match; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
801 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
802 |
271 | 803 <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
|
804 <tag-desc> |
2922
547303412ab9
Fixed article in "if_modified_since before".
Maxim Dounin <mdounin@mdounin.ru>
parents:
2921
diff
changeset
|
805 modification time of the response is |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
806 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
|
807 request header field. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
808 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
809 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
810 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
811 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
812 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
813 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
814 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
815 |
152
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
816 <directive name="ignore_invalid_headers"> |
271 | 817 <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
|
818 <default>on</default> |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
819 <context>http</context> |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
820 <context>server</context> |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
821 |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
822 <para> |
235
6d8356490215
Consistently call header fields as such.
Ruslan Ermilov <ru@nginx.com>
parents:
234
diff
changeset
|
823 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
|
824 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
|
825 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
|
826 directive). |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
827 </para> |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
828 |
426
1d6dc85ed324
Specifying "ignore_invalid_headers" or "underscores_in_headers" on the
Ruslan Ermilov <ru@nginx.com>
parents:
419
diff
changeset
|
829 <para> |
1023
375055da60fa
Improved wording of merge_slashes etc. (ticket #448).
Maxim Dounin <mdounin@mdounin.ru>
parents:
1022
diff
changeset
|
830 If the directive is specified on the <link id="server"/> level, |
2795
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
831 the value from the default server can be used. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
832 Details are provided in the |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
833 “<link doc="server_names.xml" id="virtual_server_selection">Virtual |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
834 server selection</link>” section. |
426
1d6dc85ed324
Specifying "ignore_invalid_headers" or "underscores_in_headers" on the
Ruslan Ermilov <ru@nginx.com>
parents:
419
diff
changeset
|
835 </para> |
1d6dc85ed324
Specifying "ignore_invalid_headers" or "underscores_in_headers" on the
Ruslan Ermilov <ru@nginx.com>
parents:
419
diff
changeset
|
836 |
152
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
837 </directive> |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
838 |
5a35535f7cdf
Documented the "ignore_invalid_headers" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
839 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
840 <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
|
841 <syntax/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
842 <default/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
843 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
844 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
845 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
846 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
|
847 For external requests, the client error |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
848 <http-status code="404" text="Not Found"/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
849 is returned. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
850 Internal requests are the following: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
851 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
852 <list type="bullet"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
853 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
854 <listitem> |
429
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
855 requests redirected by the |
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
856 <link id="error_page"/>, |
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
857 <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
|
858 <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
|
859 <link id="try_files"/> directives; |
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
860 </listitem> |
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
861 |
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
862 <listitem> |
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
863 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
|
864 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
|
865 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
866 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
867 <listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
868 subrequests formed by the |
271 | 869 “<command>include virtual</command>” |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
870 command of the |
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
871 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link> |
2036
ee0aeddbe8a2
Updated types of subrequests allowed in the internal location.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2003
diff
changeset
|
872 module, by the |
438
b27974b92a58
- corrected the description of the from= parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
436
diff
changeset
|
873 <link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link> |
2036
ee0aeddbe8a2
Updated types of subrequests allowed in the internal location.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2003
diff
changeset
|
874 module directives, and by |
ee0aeddbe8a2
Updated types of subrequests allowed in the internal location.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2003
diff
changeset
|
875 <link doc="ngx_http_auth_request_module.xml" id="auth_request"/> and |
ee0aeddbe8a2
Updated types of subrequests allowed in the internal location.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2003
diff
changeset
|
876 <link doc="ngx_http_mirror_module.xml" id="mirror"/> directives; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
877 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
878 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
879 <listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
880 requests changed by the |
429
2b9507b2cdf3
List all sources of internal requests.
Ruslan Ermilov <ru@nginx.com>
parents:
426
diff
changeset
|
881 <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
|
882 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
883 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
884 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
885 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
886 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
887 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
888 Example: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
889 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
890 error_page 404 /404.html; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
891 |
2206
5cacd6fffade
Eliminated some examples of unsafe prefix locations.
Ruslan Ermilov <ru@nginx.com>
parents:
2199
diff
changeset
|
892 location = /404.html { |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
893 internal; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
894 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
895 </example> |
674
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
896 <note> |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
897 There is a limit of 10 internal redirects per request to prevent |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
898 request processing cycles that can occur in incorrect configurations. |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
899 If this limit is reached, the error |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
900 <http-status code="500" text="Internal Server Error"/> is returned. |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
901 In such cases, the “rewrite or internal redirection cycle” message |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
902 can be seen in the error log. |
c48c0936b4df
Documented internal redirections limit.
Vladimir Homutov <vl@nginx.com>
parents:
659
diff
changeset
|
903 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
904 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
905 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
906 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
907 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
908 |
176
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
909 <directive name="keepalive_disable"> |
271 | 910 <syntax><literal>none</literal> | <value>browser</value> ...</syntax> |
467
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
911 <default>msie6</default> |
176
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
912 <context>http</context> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
913 <context>server</context> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
914 <context>location</context> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
915 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
916 <para> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
917 Disables keep-alive connections with misbehaving browsers. |
271 | 918 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
|
919 browsers will be affected. |
271 | 920 The value <literal>msie6</literal> disables keep-alive connections |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
921 with old versions of MSIE, once a POST request is received. |
271 | 922 The value <literal>safari</literal> disables keep-alive connections |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1904
diff
changeset
|
923 with Safari and Safari-like browsers on macOS and macOS-like |
467
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
924 operating systems. |
271 | 925 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
|
926 with all browsers. |
467
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
927 <note> |
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
928 Prior to version 1.1.18, the value <literal>safari</literal> matched |
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
929 all Safari and Safari-like browsers on all operating systems, and |
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
930 keep-alive connections with them were disabled by default. |
c505c92c8658
Documented recent changes to the "keepalive_disable" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
454
diff
changeset
|
931 </note> |
176
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
932 </para> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
933 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
934 </directive> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
935 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
936 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
937 <directive name="keepalive_requests"> |
271 | 938 <syntax><value>number</value></syntax> |
2706
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
939 <default>1000</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
940 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
941 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
942 <context>location</context> |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
943 <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
|
944 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
945 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
946 Sets the maximum number of requests that can be |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
947 served through one keep-alive connection. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
948 After the maximum number of requests are made, the connection is closed. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
949 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
950 |
2450
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
951 <para> |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
952 Closing connections periodically is necessary to free |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
953 per-connection memory allocations. |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
954 Therefore, using too high maximum number of requests |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
955 could result in excessive memory usage and not recommended. |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
956 </para> |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
957 |
2706
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
958 <para> |
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
959 <note> |
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
960 Prior to version 1.19.10, the default value was 100. |
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
961 </note> |
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
962 </para> |
4f44386a16b1
Changed default value of keepalive_requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2705
diff
changeset
|
963 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
964 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
965 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
966 |
2705
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
967 <directive name="keepalive_time"> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
968 <syntax><value>time</value></syntax> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
969 <default>1h</default> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
970 <context>http</context> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
971 <context>server</context> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
972 <context>location</context> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
973 <appeared-in>1.19.10</appeared-in> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
974 |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
975 <para> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
976 Limits the maximum time during which |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
977 requests can be processed through one keep-alive connection. |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
978 After this time is reached, the connection is closed |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
979 following the subsequent request processing. |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
980 </para> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
981 |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
982 </directive> |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
983 |
06805824d0f0
Documented the keepalive_time directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2657
diff
changeset
|
984 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
985 <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
|
986 <syntax> |
364 | 987 <value>timeout</value> |
988 [<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
|
989 <default>75s</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
990 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
991 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
992 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
993 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
994 <para> |
271 | 995 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
|
996 client connection will stay open on the server side. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
997 The zero value disables keep-alive client connections. |
271 | 998 The optional second parameter sets a value in the |
999 <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
|
1000 response header field. |
271 | 1001 Two parameters may differ. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1002 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1003 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1004 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1005 The |
271 | 1006 <header>Keep-Alive: timeout=<value>time</value></header> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1007 header field is recognized by Mozilla and Konqueror. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1008 MSIE closes keep-alive connections by itself in about 60 seconds. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1009 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1010 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1011 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1012 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1013 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1014 <directive name="large_client_header_buffers"> |
271 | 1015 <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
|
1016 <default>4 8k</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1017 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1018 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1019 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1020 <para> |
271 | 1021 Sets the maximum <value>number</value> and <value>size</value> of |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1022 buffers used for reading large client request header. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1023 A request line cannot exceed the size of one buffer, or the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1024 <http-status code="414" text="Request-URI Too Large"/> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1025 error is returned to the client. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1026 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
|
1027 <http-status code="400" text="Bad Request"/> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1028 error is returned to the client. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1029 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
|
1030 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
|
1031 If after the end of request processing a connection is transitioned |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1032 into the keep-alive state, these buffers are released. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1033 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1034 |
2795
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1035 <para> |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1036 If the directive is specified on the <link id="server"/> level, |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1037 the value from the default server can be used. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1038 Details are provided in the |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1039 “<link doc="server_names.xml" id="virtual_server_selection">Virtual |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1040 server selection</link>” section. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1041 </para> |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1042 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1043 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1044 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1045 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1046 <directive name="limit_except"> |
271 | 1047 <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
|
1048 <default/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1049 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1050 |
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 Limits allowed HTTP methods inside a location. |
271 | 1053 The <value>method</value> parameter can be one of the following: |
1054 <literal>GET</literal>, | |
1055 <literal>HEAD</literal>, | |
1056 <literal>POST</literal>, | |
1057 <literal>PUT</literal>, | |
1058 <literal>DELETE</literal>, | |
1059 <literal>MKCOL</literal>, | |
1060 <literal>COPY</literal>, | |
1061 <literal>MOVE</literal>, | |
1062 <literal>OPTIONS</literal>, | |
1063 <literal>PROPFIND</literal>, | |
1064 <literal>PROPPATCH</literal>, | |
1065 <literal>LOCK</literal>, | |
1066 <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
|
1067 or |
271 | 1068 <literal>PATCH</literal>. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1069 Allowing the <literal>GET</literal> method makes the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1070 <literal>HEAD</literal> method also allowed. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1071 Access to other methods can be limited using the |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2134
diff
changeset
|
1072 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2134
diff
changeset
|
1073 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1074 and |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2134
diff
changeset
|
1075 <link doc="ngx_http_auth_jwt_module.xml">ngx_http_auth_jwt_module</link> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2134
diff
changeset
|
1076 (1.13.10) |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1077 modules directives: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1078 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1079 limit_except GET { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1080 allow 192.168.1.0/32; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1081 deny all; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1082 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1083 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1084 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
|
1085 <emphasis>except</emphasis> GET and HEAD. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1086 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1087 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1088 </directive> |
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 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1091 <directive name="limit_rate"> |
271 | 1092 <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
|
1093 <default>0</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1094 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1095 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1096 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1097 <context>if in location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1098 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1099 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1100 Limits the rate of response transmission to a client. |
271 | 1101 The <value>rate</value> is specified in bytes per second. |
966 | 1102 The zero value disables rate limiting. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1103 <!-- |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1104 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
|
1105 --> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1106 The limit is set per a request, and so if a client simultaneously opens |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1107 two connections, the overall rate will be twice as much |
767
1bb8b733416a
Clarified the description of the limit_rate directive
Ruslan Ermilov <ru@nginx.com>
parents:
747
diff
changeset
|
1108 as the specified limit. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1109 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1110 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1111 <para> |
2391
375a3dfde23b
Unified phrase "Parameter value can contain variables".
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2390
diff
changeset
|
1112 Parameter value can contain variables (1.17.0). |
767
1bb8b733416a
Clarified the description of the limit_rate directive
Ruslan Ermilov <ru@nginx.com>
parents:
747
diff
changeset
|
1113 It may be useful in cases where rate should be limited |
1bb8b733416a
Clarified the description of the limit_rate directive
Ruslan Ermilov <ru@nginx.com>
parents:
747
diff
changeset
|
1114 depending on a certain condition: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1115 <example> |
2384
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1116 map $slow $rate { |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1117 1 4k; |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1118 2 8k; |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1119 } |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1120 |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1121 limit_rate $rate; |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1122 </example> |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1123 </para> |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1124 |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1125 <para> |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1126 Rate limit can also be set in the |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1127 <link id="var_limit_rate"><var>$limit_rate</var></link> variable, |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1128 however, since version 1.17.0, this method is not recommended: |
144c8e3d6c09
Documented variables support in limit_rate and limit_rate_after.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2220
diff
changeset
|
1129 <example> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1130 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1131 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1132 if ($slow) { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1133 set $limit_rate 4k; |
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 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1136 ... |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1137 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1138 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1139 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1140 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
503
diff
changeset
|
1141 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1142 Rate limit can also be set in the |
767
1bb8b733416a
Clarified the description of the limit_rate directive
Ruslan Ermilov <ru@nginx.com>
parents:
747
diff
changeset
|
1143 <header>X-Accel-Limit-Rate</header> header field of a proxied server response. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1144 This capability can be disabled using the |
1181 | 1145 <link doc="ngx_http_proxy_module.xml" id="proxy_ignore_headers"/>, |
1146 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_ignore_headers"/>, | |
1194 | 1147 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_ignore_headers"/>, |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
503
diff
changeset
|
1148 and |
1181 | 1149 <link doc="ngx_http_scgi_module.xml" id="scgi_ignore_headers"/> |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
503
diff
changeset
|
1150 directives. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
503
diff
changeset
|
1151 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
503
diff
changeset
|
1152 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1153 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1154 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1155 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
169
diff
changeset
|
1156 <directive name="limit_rate_after"> |
271 | 1157 <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
|
1158 <default>0</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1159 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1160 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1161 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1162 <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
|
1163 <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
|
1164 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1165 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1166 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
|
1167 of a response to a client will be rate limited. |
2391
375a3dfde23b
Unified phrase "Parameter value can contain variables".
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2390
diff
changeset
|
1168 Parameter value can contain variables (1.17.0). |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1169 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1170 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1171 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1172 Example: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1173 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1174 location /flv/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1175 flv; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1176 limit_rate_after 500k; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1177 limit_rate 50k; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1178 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1179 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1180 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1181 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1182 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1183 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1184 |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1185 <directive name="lingering_close"> |
271 | 1186 <syntax> |
364 | 1187 <literal>off</literal> | |
1188 <literal>on</literal> | | |
1189 <literal>always</literal></syntax> | |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1190 <default>on</default> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1191 <context>http</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1192 <context>server</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1193 <context>location</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1194 <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
|
1195 <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
|
1196 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1197 <para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1198 Controls how nginx closes client connections. |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1199 </para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1200 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1201 <para> |
271 | 1202 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
|
1203 <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
|
1204 <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
|
1205 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
|
1206 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
|
1207 </para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1208 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1209 <para> |
271 | 1210 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
|
1211 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
|
1212 </para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1213 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1214 <para> |
271 | 1215 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
|
1216 more data and close the connection immediately. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1217 This behavior breaks the protocol and should not be used under normal |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1218 circumstances. |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1219 </para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1220 |
2567
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2523
diff
changeset
|
1221 <para> |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2523
diff
changeset
|
1222 To control closing |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2523
diff
changeset
|
1223 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections, |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2523
diff
changeset
|
1224 the directive must be specified on the <link id="server"/> level (1.19.1). |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2523
diff
changeset
|
1225 </para> |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2523
diff
changeset
|
1226 |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1227 </directive> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1228 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1229 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1230 <directive name="lingering_time"> |
271 | 1231 <syntax><value>time</value></syntax> |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1232 <default>30s</default> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1233 <context>http</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1234 <context>server</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1235 <context>location</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1236 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1237 <para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1238 When <link id="lingering_close"/> is in effect, |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1239 this directive specifies the maximum time during which nginx |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1240 will process (read and ignore) additional data coming from a client. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1241 After that, the connection will be closed, even if there will be |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1242 more data. |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1243 </para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1244 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1245 </directive> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1246 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1247 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1248 <directive name="lingering_timeout"> |
271 | 1249 <syntax><value>time</value></syntax> |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1250 <default>5s</default> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1251 <context>http</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1252 <context>server</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1253 <context>location</context> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1254 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1255 <para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1256 When <link id="lingering_close"/> is in effect, this directive specifies |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1257 the maximum waiting time for more client data to arrive. |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1258 If data are not received during this time, the connection is closed. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1259 Otherwise, the data are read and ignored, and nginx starts waiting |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1260 for more data again. |
172
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1261 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
|
1262 <link id="lingering_time"/> directive. |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1263 </para> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1264 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1265 </directive> |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1266 |
5e8e63f73c33
Documented "lingering_close", "lingering_time", and "lingering_timeout".
Ruslan Ermilov <ru@nginx.com>
parents:
171
diff
changeset
|
1267 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1268 <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
|
1269 <syntax> |
364 | 1270 <value>address</value>[:<value>port</value>] |
1271 [<literal>default_server</literal>] | |
869 | 1272 [<literal>ssl</literal>] |
1567
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1273 [<literal>http2</literal> | <literal>spdy</literal>] |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1274 [<literal>proxy_protocol</literal>] |
364 | 1275 [<literal>setfib</literal>=<value>number</value>] |
1036
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1276 [<literal>fastopen</literal>=<value>number</value>] |
364 | 1277 [<literal>backlog</literal>=<value>number</value>] |
1278 [<literal>rcvbuf</literal>=<value>size</value>] | |
1279 [<literal>sndbuf</literal>=<value>size</value>] | |
1280 [<literal>accept_filter</literal>=<value>filter</value>] | |
1281 [<literal>deferred</literal>] | |
1282 [<literal>bind</literal>] | |
1283 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] | |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1284 [<literal>reuseport</literal>] |
364 | 1285 [<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
|
1286 <syntax> |
364 | 1287 <value>port</value> |
1288 [<literal>default_server</literal>] | |
869 | 1289 [<literal>ssl</literal>] |
1567
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1290 [<literal>http2</literal> | <literal>spdy</literal>] |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1291 [<literal>proxy_protocol</literal>] |
364 | 1292 [<literal>setfib</literal>=<value>number</value>] |
1036
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1293 [<literal>fastopen</literal>=<value>number</value>] |
364 | 1294 [<literal>backlog</literal>=<value>number</value>] |
1295 [<literal>rcvbuf</literal>=<value>size</value>] | |
1296 [<literal>sndbuf</literal>=<value>size</value>] | |
1297 [<literal>accept_filter</literal>=<value>filter</value>] | |
1298 [<literal>deferred</literal>] | |
1299 [<literal>bind</literal>] | |
1300 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] | |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1301 [<literal>reuseport</literal>] |
364 | 1302 [<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
|
1303 <syntax> |
364 | 1304 <literal>unix:</literal><value>path</value> |
1305 [<literal>default_server</literal>] | |
869 | 1306 [<literal>ssl</literal>] |
1567
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1307 [<literal>http2</literal> | <literal>spdy</literal>] |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1308 [<literal>proxy_protocol</literal>] |
364 | 1309 [<literal>backlog</literal>=<value>number</value>] |
1310 [<literal>rcvbuf</literal>=<value>size</value>] | |
1311 [<literal>sndbuf</literal>=<value>size</value>] | |
1312 [<literal>accept_filter</literal>=<value>filter</value>] | |
1313 [<literal>deferred</literal>] | |
1314 [<literal>bind</literal>] | |
1315 [<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
|
1316 <default>*:80 | *:8000</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1317 <context>server</context> |
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 <para> |
966 | 1320 Sets the <value>address</value> and <value>port</value> for IP, |
1321 or the <value>path</value> for a UNIX-domain socket on which | |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1322 the server will accept requests. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1323 Both <value>address</value> and <value>port</value>, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1324 or only <value>address</value> or only <value>port</value> can be specified. |
271 | 1325 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
|
1326 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1327 listen 127.0.0.1:8000; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1328 listen 127.0.0.1; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1329 listen 8000; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1330 listen *:8000; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1331 listen localhost:8000; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1332 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1333 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
|
1334 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1335 listen [::]:8000; |
941
7d1d53d4d293
Removed link-scoped IPv6 addresses from examples.
Ruslan Ermilov <ru@nginx.com>
parents:
940
diff
changeset
|
1336 listen [::1]; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1337 </example> |
364 | 1338 UNIX-domain sockets (0.8.21) are specified with the “<literal>unix:</literal>” |
1339 prefix: | |
66 | 1340 <example> |
1341 listen unix:/var/run/nginx.sock; | |
1342 </example> | |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1343 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1344 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1345 <para> |
271 | 1346 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
|
1347 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1348 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1349 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1350 If the directive is not present then either <literal>*:80</literal> is used |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1351 if nginx runs with the superuser privileges, or <literal>*:8000</literal> |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1352 otherwise. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1353 </para> |
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 <para> |
271 | 1356 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
|
1357 will cause the server to become the default server for the specified |
271 | 1358 <value>address</value>:<value>port</value> pair. |
1359 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
|
1360 parameter then the first server with the |
271 | 1361 <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
|
1362 the default server for this pair. |
66 | 1363 <note> |
1364 In versions prior to 0.8.21 this parameter is named simply | |
271 | 1365 <literal>default</literal>. |
66 | 1366 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1367 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1368 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1369 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1370 The <literal>ssl</literal> parameter (0.7.14) allows specifying that all |
869 | 1371 connections accepted on this port should work in SSL mode. |
1372 This allows for a more compact <link doc="configuring_https_servers.xml" | |
1373 id="single_http_https_server">configuration</link> for the server that | |
1374 handles both HTTP and HTTPS requests. | |
1375 </para> | |
1376 | |
1377 <para> | |
1567
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1378 The <literal>http2</literal> parameter (1.9.5) configures the port to accept |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1379 <link doc="ngx_http_v2_module.xml">HTTP/2</link> connections. |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1380 Normally, for this to work the <literal>ssl</literal> parameter should be |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1381 specified as well, but nginx can also be configured to accept HTTP/2 |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1382 connections without SSL. |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1383 </para> |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1384 |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1385 <para> |
695999bdd4a5
Updated description of http2 parameter, translated into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
1386 The <literal>spdy</literal> parameter (1.3.15-1.9.4) allows accepting |
869 | 1387 <link doc="ngx_http_spdy_module.xml">SPDY</link> connections on this port. |
1388 Normally, for this to work the <literal>ssl</literal> parameter should be | |
1389 specified as well, but nginx can also be configured to accept SPDY | |
1390 connections without SSL. | |
1391 </para> | |
1392 | |
1393 <para> | |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1394 The <literal>proxy_protocol</literal> parameter (1.5.12) |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1395 allows specifying that all connections accepted on this port should use the |
2912
7ebe15d6c68d
Updated link to the PROXY protocol specification.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2903
diff
changeset
|
1396 <link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1397 protocol</link>. |
2125
b19d5d47c16c
Documented ver.2 of the PROXY protocol.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2121
diff
changeset
|
1398 <note> |
b19d5d47c16c
Documented ver.2 of the PROXY protocol.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2121
diff
changeset
|
1399 The PROXY protocol version 2 is supported since version 1.13.11. |
b19d5d47c16c
Documented ver.2 of the PROXY protocol.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2121
diff
changeset
|
1400 </note> |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1401 </para> |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1402 |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
1403 <para> |
1414 | 1404 The <literal>listen</literal> directive |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1405 can have several additional parameters specific to socket-related system calls. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1406 These parameters can be specified in any |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1407 <literal>listen</literal> directive, but only once for a given |
271 | 1408 <value>address</value>:<value>port</value> pair. |
66 | 1409 <note> |
1410 In versions prior to 0.8.21, they could only be | |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1411 specified in the <literal>listen</literal> directive together with the |
271 | 1412 <literal>default</literal> parameter. |
66 | 1413 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1414 <list type="tag"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1415 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1416 <tag-name> |
271 | 1417 <literal>setfib</literal>=<value>number</value> |
66 | 1418 </tag-name> |
1419 <tag-desc> | |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1420 this parameter (0.8.44) sets the associated routing table, FIB |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1421 (the <c-def>SO_SETFIB</c-def> option) for the listening socket. |
66 | 1422 This currently works only on FreeBSD. |
1423 </tag-desc> | |
1424 | |
1425 <tag-name> | |
1036
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1426 <literal>fastopen</literal>=<value>number</value> |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1427 </tag-name> |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1428 <tag-desc> |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1429 enables |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1430 “<link url="http://en.wikipedia.org/wiki/TCP_Fast_Open">TCP Fast Open</link>” |
1037 | 1431 for the listening socket (1.5.8) and |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2795
diff
changeset
|
1432 <link url="https://datatracker.ietf.org/doc/html/rfc7413#section-5.1">limits</link> |
1036
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1433 the maximum length for the queue of connections that have not yet completed |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1434 the three-way handshake. |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1435 <note> |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1436 Do not enable this feature unless the server can handle |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1437 receiving the |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2795
diff
changeset
|
1438 <link url="https://datatracker.ietf.org/doc/html/rfc7413#section-6.1"> |
1036
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1439 same SYN packet with data</link> more than once. |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1440 </note> |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1441 </tag-desc> |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1442 |
5894aa46ffef
Documented "listen fastopen=" parameter.
Vladimir Homutov <vl@nginx.com>
parents:
1035
diff
changeset
|
1443 <tag-name> |
271 | 1444 <literal>backlog</literal>=<value>number</value> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1445 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1446 <tag-desc> |
271 | 1447 sets the <literal>backlog</literal> parameter in the |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1448 <c-func>listen</c-func> call that limits |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1449 the maximum length for the queue of pending connections. |
1501
40425063b413
Fixed the default "listen backlog" value on DragonFly BSD.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
1450 By default, |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1904
diff
changeset
|
1451 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and macOS, |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1452 and to 511 on other platforms. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1453 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1454 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1455 <tag-name> |
271 | 1456 <literal>rcvbuf</literal>=<value>size</value> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1457 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1458 <tag-desc> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1459 sets the receive buffer size |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1460 (the <c-def>SO_RCVBUF</c-def> option) for the listening socket. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1461 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1462 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1463 <tag-name> |
271 | 1464 <literal>sndbuf</literal>=<value>size</value> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1465 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1466 <tag-desc> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1467 sets the send buffer size |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1468 (the <c-def>SO_SNDBUF</c-def> option) for the listening socket. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1469 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1470 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1471 <tag-name> |
271 | 1472 <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
|
1473 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1474 <tag-desc> |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1475 sets the name of accept filter |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1476 (the <c-def>SO_ACCEPTFILTER</c-def> option) for the listening socket |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1477 that filters incoming connections before passing them to |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1478 <c-func>accept</c-func>. |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1479 This works only on FreeBSD and NetBSD 5.0+. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1480 Possible values are |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1481 <link url="http://man.freebsd.org/accf_data">dataready</link> |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1482 and |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1483 <link url="http://man.freebsd.org/accf_http">httpready</link>. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1484 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1485 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1486 <tag-name> |
271 | 1487 <literal>deferred</literal> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1488 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1489 <tag-desc> |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1490 instructs to use a deferred <c-func>accept</c-func> |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1491 (the <c-def>TCP_DEFER_ACCEPT</c-def> socket option) on Linux. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1492 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1493 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1494 <tag-name> |
271 | 1495 <literal>bind</literal> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1496 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1497 <tag-desc> |
240
472e88bf177e
Slightly better wording for the "bind" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
237
diff
changeset
|
1498 instructs to make a separate <c-func>bind</c-func> call for a given |
271 | 1499 <value>address</value>:<value>port</value> pair. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1500 This is useful because if there are several <literal>listen</literal> |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1501 directives with the same port but different addresses, and one of the |
271 | 1502 <literal>listen</literal> directives listens on all addresses |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1503 for the given port (<literal>*:</literal><value>port</value>), nginx |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1504 will <c-func>bind</c-func> only to <literal>*:</literal><value>port</value>. |
966 | 1505 It should be noted that the <c-func>getsockname</c-func> system call will be |
1506 made in this case to determine the address that accepted the connection. | |
1035
e9c485d6cc0c
Documented that "listen setfib=" implies "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
1031
diff
changeset
|
1507 If the <literal>setfib</literal>, |
2724
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2707
diff
changeset
|
1508 <literal>fastopen</literal>, |
1035
e9c485d6cc0c
Documented that "listen setfib=" implies "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
1031
diff
changeset
|
1509 <literal>backlog</literal>, <literal>rcvbuf</literal>, |
271 | 1510 <literal>sndbuf</literal>, <literal>accept_filter</literal>, |
1279
7261e621dd4a
Documented that "listen ipv6only=" implies "bind".
Maxim Dounin <mdounin@mdounin.ru>
parents:
1257
diff
changeset
|
1511 <literal>deferred</literal>, <literal>ipv6only</literal>, |
2724
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2707
diff
changeset
|
1512 <literal>reuseport</literal>, |
1279
7261e621dd4a
Documented that "listen ipv6only=" implies "bind".
Maxim Dounin <mdounin@mdounin.ru>
parents:
1257
diff
changeset
|
1513 or <literal>so_keepalive</literal> parameters |
223
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1514 are used then for a given |
271 | 1515 <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
|
1516 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
|
1517 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1518 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1519 <tag-name> |
271 | 1520 <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
|
1521 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1522 <tag-desc> |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1523 this parameter (0.7.42) determines |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1524 (via the <c-def>IPV6_V6ONLY</c-def> socket option) |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1525 whether an IPv6 socket listening on a wildcard address <literal>[::]</literal> |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1526 will accept only IPv6 connections or both IPv6 and IPv4 connections. |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1527 This parameter is turned on by default. |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1528 It can only be set once on start. |
615
f3ef5b77d22a
Documented that "ipv6only" is now turned on by default for
Ruslan Ermilov <ru@nginx.com>
parents:
589
diff
changeset
|
1529 <note> |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1530 Prior to version 1.3.4, |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1531 if this parameter was omitted then the operating system’s settings were |
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1532 in effect for the socket. |
615
f3ef5b77d22a
Documented that "ipv6only" is now turned on by default for
Ruslan Ermilov <ru@nginx.com>
parents:
589
diff
changeset
|
1533 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1534 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1535 |
1507
14180fa9a518
Added ids for reuseport, mentioned reuseport in news.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1501
diff
changeset
|
1536 <tag-name id="reuseport"> |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1537 <literal>reuseport</literal> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1538 </tag-name> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1539 <tag-desc> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1540 this parameter (1.9.1) instructs to create an individual listening socket |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1541 for each worker process |
2199
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
1542 (using the |
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
1543 <c-def>SO_REUSEPORT</c-def> socket option on Linux 3.9+ and DragonFly BSD, |
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
1544 or <c-def>SO_REUSEPORT_LB</c-def> on FreeBSD 12+), allowing a kernel |
1496
99ce48c8cce3
Corrected the "reuseport" description of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1493
diff
changeset
|
1545 to distribute incoming connections between worker processes. |
2199
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
1546 This currently works only on Linux 3.9+, DragonFly BSD, |
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
1547 and FreeBSD 12+ (1.15.1). |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1548 <note> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1549 Inappropriate use of this option may have its security |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1550 <link url="http://man7.org/linux/man-pages/man7/socket.7.html">implications</link>. |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1551 </note> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1552 </tag-desc> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1553 |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
1554 <tag-name> |
271 | 1555 <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
|
1556 </tag-name> |
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1557 <tag-desc> |
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1558 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
|
1559 for the listening socket. |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1560 If this parameter is omitted then the operating system’s settings will be |
223
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1561 in effect for the socket. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1562 If it is set to the value “<literal>on</literal>”, the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1563 <c-def>SO_KEEPALIVE</c-def> option is turned on for the socket. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1564 If it is set to the value “<literal>off</literal>”, the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1565 <c-def>SO_KEEPALIVE</c-def> option is turned off for the socket. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1566 Some operating systems support setting of TCP keepalive parameters on |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1567 a per-socket basis using the <c-def>TCP_KEEPIDLE</c-def>, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1568 <c-def>TCP_KEEPINTVL</c-def>, and <c-def>TCP_KEEPCNT</c-def> socket options. |
397
f1c0ae9c1c48
FreeBSD 10.0-CURRENT supports the TCP_KEEPIDLE, TCP_KEEPINTVL, and
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1569 On such systems (currently, Linux 2.4+, NetBSD 5+, and |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1570 FreeBSD 9.0-STABLE), they can be configured |
271 | 1571 using the <value>keepidle</value>, <value>keepintvl</value>, and |
1572 <value>keepcnt</value> parameters. | |
1573 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
|
1574 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
|
1575 For example, |
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1576 <example>so_keepalive=30m::10</example> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1577 will set the idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1578 leave the probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1579 and set the probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes. |
223
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1580 </tag-desc> |
09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
185
diff
changeset
|
1581 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1582 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1583 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1584 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1585 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1586 Example: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1587 <example> |
617
368a449e85b8
Expanded documentation of what various parameters of the "listen"
Ruslan Ermilov <ru@nginx.com>
parents:
615
diff
changeset
|
1588 listen 127.0.0.1 default_server accept_filter=dataready backlog=1024; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1589 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1590 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1591 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1592 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1593 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1594 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1595 <directive name="location"> |
108
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
106
diff
changeset
|
1596 <syntax block="yes">[ |
364 | 1597 <literal>=</literal> | |
1598 <literal>~</literal> | | |
1599 <literal>~*</literal> | | |
1600 <literal>^~</literal> | |
1601 ] <value>uri</value></syntax> | |
271 | 1602 <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
|
1603 <default/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1604 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1605 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1606 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1607 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1608 Sets configuration depending on a request URI. |
503
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1609 </para> |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1610 |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1611 <para> |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1612 The matching is performed against a normalized URI, |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1613 after decoding the text encoded in the “<literal>%XX</literal>” form, |
503
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1614 resolving references to relative path components “<literal>.</literal>” |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1615 and “<literal>..</literal>”, and possible |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1616 <link id="merge_slashes">compression</link> of two or more |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1617 adjacent slashes into a single slash. |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1618 </para> |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1619 |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
1620 <para> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1621 A location can either be defined by a prefix string, or by a regular expression. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1622 Regular expressions are specified with the preceding |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1623 “<literal>~*</literal>” modifier (for case-insensitive matching), or the |
810
7c72c3e67e77
The "location" directive: improved wording.
Ruslan Ermilov <ru@nginx.com>
parents:
779
diff
changeset
|
1624 “<literal>~</literal>” modifier (for case-sensitive matching). |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1625 To find location matching a given request, nginx first checks |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1626 locations defined using the prefix strings (prefix locations). |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1627 Among them, the location with the longest matching |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1628 prefix is selected and remembered. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1629 Then regular expressions are checked, in the order of their appearance |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1630 in the configuration file. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1631 The search of regular expressions terminates on the first match, |
244 | 1632 and the corresponding configuration is used. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1633 If no match with a regular expression is found then the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1634 configuration of the prefix location remembered earlier is used. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1635 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1636 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1637 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1638 <literal>location</literal> blocks can be nested, with some exceptions |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1639 mentioned below. |
67
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1640 </para> |
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1641 |
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1642 <para> |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1904
diff
changeset
|
1643 For case-insensitive operating systems such as macOS and Cygwin, |
244 | 1644 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
|
1645 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
|
1646 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1647 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1648 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1649 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
|
1650 be used in other directives. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1651 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1652 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1653 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1654 If the longest matching prefix location has the “<literal>^~</literal>” modifier |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1655 then regular expressions are not checked. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1656 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1657 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1658 <para> |
810
7c72c3e67e77
The "location" directive: improved wording.
Ruslan Ermilov <ru@nginx.com>
parents:
779
diff
changeset
|
1659 Also, using the “<literal>=</literal>” modifier it is possible to define |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1660 an exact match of URI and location. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1661 If an exact match is found, the search terminates. |
271 | 1662 For example, if a “<literal>/</literal>” request happens frequently, |
1663 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
|
1664 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
|
1665 comparison. |
67
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1666 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
|
1667 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1668 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1669 <para> |
67
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1670 <note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1671 In versions from 0.7.1 to 0.8.41, if a request matched the prefix |
271 | 1672 location without the “<literal>=</literal>” and “<literal>^~</literal>” |
810
7c72c3e67e77
The "location" directive: improved wording.
Ruslan Ermilov <ru@nginx.com>
parents:
779
diff
changeset
|
1673 modifiers, the search also terminated and regular expressions were |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1674 not checked. |
67
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1675 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1676 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1677 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1678 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1679 Let’s illustrate the above by an example: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1680 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1681 location = / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1682 [ configuration A ] |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1683 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1684 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1685 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1686 [ configuration B ] |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1687 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1688 |
738
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1689 location /documents/ { |
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1690 [ configuration C ] |
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1691 } |
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1692 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1693 location ^~ /images/ { |
738
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1694 [ configuration D ] |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1695 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1696 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1697 location ~* \.(gif|jpg|jpeg)$ { |
738
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1698 [ configuration E ] |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1699 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1700 </example> |
271 | 1701 The “<literal>/</literal>” request will match configuration A, |
738
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1702 the “<literal>/index.html</literal>” request will match configuration B, |
271 | 1703 the “<literal>/documents/document.html</literal>” request will match |
738
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1704 configuration C, |
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1705 the “<literal>/images/1.gif</literal>” request will match configuration D, and |
0914bbb59fd2
Expanded "location" examples with another prefix location.
Ruslan Ermilov <ru@nginx.com>
parents:
711
diff
changeset
|
1706 the “<literal>/documents/1.jpg</literal>” request will match configuration E. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1707 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1708 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1709 <para> |
271 | 1710 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
|
1711 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
|
1712 used for request redirection. |
67
d98323a15ba4
Documented the nested locations.
Ruslan Ermilov <ru@nginx.com>
parents:
66
diff
changeset
|
1713 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
|
1714 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1715 |
914
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1716 <para> |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1717 If a location is defined by a prefix string that ends with the slash character, |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1718 and requests are processed by one of |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1719 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>, |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1720 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>, |
1194 | 1721 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>, |
2134
4cafd82e5007
Added info about gRPC to various modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2125
diff
changeset
|
1722 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>, |
4cafd82e5007
Added info about gRPC to various modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2125
diff
changeset
|
1723 <link doc="ngx_http_memcached_module.xml" id="memcached_pass"/>, or |
4cafd82e5007
Added info about gRPC to various modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2125
diff
changeset
|
1724 <link doc="ngx_http_grpc_module.xml" id="grpc_pass"/>, |
1257
ac7a5ee98768
Split long sentence into two.
Ruslan Ermilov <ru@nginx.com>
parents:
1194
diff
changeset
|
1725 then the special processing is performed. |
ac7a5ee98768
Split long sentence into two.
Ruslan Ermilov <ru@nginx.com>
parents:
1194
diff
changeset
|
1726 In response to a request with URI equal to this string, |
914
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1727 but without the trailing slash, |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1728 a permanent redirect with the code 301 will be returned to the requested URI |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1729 with the slash appended. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1730 If this is not desired, an exact match of the URI and location could be |
914
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1731 defined like this: |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1732 <example> |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1733 location /user/ { |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1734 proxy_pass http://user.example.com; |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1735 } |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1736 |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1737 location = /user { |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1738 proxy_pass http://login.example.com; |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1739 } |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1740 </example> |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1741 </para> |
474a21f26a2a
Documented location behavior with proxying directives.
Vladimir Homutov <vl@nginx.com>
parents:
871
diff
changeset
|
1742 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1743 <!-- |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1744 <migration from="Apache" directive="Location" /> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1745 --> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1746 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1747 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1748 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1749 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1750 <directive name="log_not_found"> |
271 | 1751 <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
|
1752 <default>on</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1753 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1754 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1755 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1756 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1757 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1758 Enables or disables logging of errors about not found files into |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
1759 <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
|
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 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1763 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1764 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1765 <directive name="log_subrequest"> |
271 | 1766 <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
|
1767 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1768 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1769 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1770 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1771 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1772 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1773 Enables or disables logging of subrequests into |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
1774 <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
|
1775 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1776 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1777 </directive> |
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 |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1780 <directive name="max_ranges"> |
271 | 1781 <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
|
1782 <default/> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1783 <context>http</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1784 <context>server</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1785 <context>location</context> |
499
76a8eca844d0
Documented that "max_ranges" appeared in 1.1.2.
Ruslan Ermilov <ru@nginx.com>
parents:
477
diff
changeset
|
1786 <appeared-in>1.1.2</appeared-in> |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1787 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1788 <para> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1789 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
|
1790 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
|
1791 byte ranges specified. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1792 By default, the number of ranges is not limited. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1793 The zero value disables the byte-range support completely. |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1794 </para> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1795 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1796 </directive> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1797 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
1798 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1799 <directive name="merge_slashes"> |
271 | 1800 <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
|
1801 <default>on</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1802 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1803 <context>server</context> |
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 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1806 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
|
1807 in a URI into a single slash. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1808 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1809 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1810 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1811 Note that compression is essential for the correct matching of prefix string |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1812 and regular expression locations. |
271 | 1813 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
|
1814 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1815 location /scripts/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1816 ... |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1817 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1818 </example> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1819 and might be processed as a static file. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1820 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
|
1821 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1822 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1823 <para> |
271 | 1824 Turning the compression <literal>off</literal> can become necessary if a URI |
1825 contains base64-encoded names, since base64 uses the “<literal>/</literal>” | |
246 | 1826 character internally. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1827 However, for security considerations, it is better to avoid turning |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1828 the compression off. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1829 </para> |
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> |
1023
375055da60fa
Improved wording of merge_slashes etc. (ticket #448).
Maxim Dounin <mdounin@mdounin.ru>
parents:
1022
diff
changeset
|
1832 If the directive is specified on the <link id="server"/> level, |
2795
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1833 the value from the default server can be used. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1834 Details are provided in the |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1835 “<link doc="server_names.xml" id="virtual_server_selection">Virtual |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
1836 server selection</link>” section. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1837 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1838 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1839 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1840 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1841 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1842 <directive name="msie_padding"> |
271 | 1843 <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
|
1844 <default>on</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1845 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1846 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1847 <context>location</context> |
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> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1850 Enables or disables adding comments to responses for MSIE clients with status |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1851 greater than 400 to increase the response size to 512 bytes. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1852 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1853 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1854 </directive> |
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 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1857 <directive name="msie_refresh"> |
271 | 1858 <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
|
1859 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1860 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1861 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1862 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1863 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1864 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1865 Enables or disables issuing refreshes instead of redirects for MSIE clients. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1866 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1867 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1868 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1869 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1870 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1871 <directive name="open_file_cache"> |
271 | 1872 <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
|
1873 <syntax> |
271 | 1874 <literal>max</literal>=<value>N</value> |
1875 [<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
|
1876 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1877 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1878 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1879 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1880 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1881 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1882 Configures a cache that can store: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1883 <list type="bullet"> |
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 <listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1886 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
|
1887 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1888 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1889 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1890 information on existence of directories; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1891 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1892 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1893 <listitem> |
68
9de85defbcf8
- "optimize_server_names" is deprecated in favour of "server_name_in_redirects"
Ruslan Ermilov <ru@nginx.com>
parents:
67
diff
changeset
|
1894 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
|
1895 and so on. |
246 | 1896 <note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1897 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
|
1898 <link id="open_file_cache_errors"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1899 directive. |
246 | 1900 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1901 </listitem> |
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 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1904 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1905 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1906 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1907 The directive has the following parameters: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1908 <list type="tag"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1909 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1910 <tag-name> |
271 | 1911 <literal>max</literal> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1912 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1913 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1914 sets the maximum number of elements in the cache; |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1915 on cache overflow the least recently used (LRU) elements are removed; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1916 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1917 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1918 <tag-name> |
271 | 1919 <literal>inactive</literal> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1920 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1921 <tag-desc> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1922 defines a time after which an element is removed from the cache |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
1923 if it has not been accessed during this time; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1924 by default, it is 60 seconds; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1925 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1926 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1927 <tag-name> |
271 | 1928 <literal>off</literal> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1929 </tag-name> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1930 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1931 disables the cache. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1932 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1933 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1934 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1935 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1936 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1937 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1938 Example: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1939 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1940 open_file_cache max=1000 inactive=20s; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1941 open_file_cache_valid 30s; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1942 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
|
1943 open_file_cache_errors on;<!-- |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1944 open_file_cache_events on; |
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 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1947 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1948 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1949 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1950 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1951 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1952 <directive name="open_file_cache_errors"> |
271 | 1953 <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
|
1954 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1955 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1956 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1957 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1958 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1959 <para> |
68
9de85defbcf8
- "optimize_server_names" is deprecated in favour of "server_name_in_redirects"
Ruslan Ermilov <ru@nginx.com>
parents:
67
diff
changeset
|
1960 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
|
1961 <link id="open_file_cache"/>. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1962 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1963 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1964 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1965 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1966 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1967 <!-- |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1968 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1969 <directive name="open_file_cache_events"> |
271 | 1970 <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
|
1971 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1972 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1973 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1974 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1975 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1976 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1977 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
|
1978 <link id="open_file_cache"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1979 elements. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1980 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
|
1981 <link doc="../events.xml" id="kqueue"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1982 method only. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1983 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
|
1984 support events for arbitrary file system types. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1985 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
|
1986 file systems such as UFS or FFS. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1987 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1988 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1989 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1990 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1991 --> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1992 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1993 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1994 <directive name="open_file_cache_min_uses"> |
271 | 1995 <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
|
1996 <default>1</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1997 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1998 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1999 <context>location</context> |
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 <para> |
271 | 2002 Sets the minimum <value>number</value> of file accesses during |
2003 the period configured by the <literal>inactive</literal> parameter | |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2004 of the <link id="open_file_cache"/> directive, required for a file |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2005 descriptor to remain open in the cache. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2006 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2007 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2008 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2009 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2010 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2011 <directive name="open_file_cache_valid"> |
271 | 2012 <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
|
2013 <default>60s</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2014 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2015 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2016 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2017 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2018 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2019 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
|
2020 <link id="open_file_cache"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2021 elements should be validated. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2022 <!-- |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2023 When |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
2024 <link id="open_file_cache_events"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2025 is enabled, open file descriptors |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2026 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
|
2027 --> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2028 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2029 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2030 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2031 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2032 |
1024
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2033 <directive name="output_buffers"> |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2034 <syntax><value>number</value> <value>size</value></syntax> |
1576
7f97ab081d24
Changed default value in the output_buffers directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1567
diff
changeset
|
2035 <default>2 32k</default> |
1024
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2036 <context>http</context> |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2037 <context>server</context> |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2038 <context>location</context> |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2039 |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2040 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
2041 Sets the <value>number</value> and <value>size</value> of the |
1024
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2042 buffers used for reading a response from a disk. |
1576
7f97ab081d24
Changed default value in the output_buffers directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1567
diff
changeset
|
2043 <note> |
7f97ab081d24
Changed default value in the output_buffers directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1567
diff
changeset
|
2044 Prior to version 1.9.5, the default value was 1 32k. |
7f97ab081d24
Changed default value in the output_buffers directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1567
diff
changeset
|
2045 </note> |
1024
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2046 </para> |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2047 |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2048 </directive> |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2049 |
e47971bf6619
Documented output_buffers directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1023
diff
changeset
|
2050 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2051 <directive name="port_in_redirect"> |
271 | 2052 <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
|
2053 <default>on</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2054 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2055 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2056 <context>location</context> |
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 <para> |
1879
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
2059 Enables or disables specifying the port in |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
2060 <link id="absolute_redirect">absolute</link> redirects issued by nginx. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2061 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2062 |
159
8c124aef0041
Cross-linked "server_name_in_redirect" and "port_in_redirect" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
152
diff
changeset
|
2063 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2064 The use of the primary server name in redirects is controlled by |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2065 the <link id="server_name_in_redirect"/> directive. |
159
8c124aef0041
Cross-linked "server_name_in_redirect" and "port_in_redirect" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
152
diff
changeset
|
2066 </para> |
8c124aef0041
Cross-linked "server_name_in_redirect" and "port_in_redirect" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
152
diff
changeset
|
2067 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2068 </directive> |
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 |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2071 <directive name="postpone_output"> |
271 | 2072 <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
|
2073 <default>1460</default> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2074 <context>http</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2075 <context>server</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2076 <context>location</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2077 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2078 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2079 If possible, the transmission of client data will be postponed until |
271 | 2080 nginx has at least <value>size</value> bytes of data to send. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2081 The zero value disables postponing data transmission. |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2082 </para> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2083 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2084 </directive> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2085 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2086 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2087 <directive name="read_ahead"> |
271 | 2088 <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
|
2089 <default>0</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2090 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2091 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2092 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2093 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2094 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2095 Sets the amount of pre-reading for the kernel when working with file. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2096 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2097 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2098 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2099 On Linux, the |
271 | 2100 <literal>posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL)</literal> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2101 system call is used, and so the <value>size</value> parameter is ignored. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2102 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2103 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2104 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2105 On FreeBSD, the |
271 | 2106 <literal>fcntl(O_READAHEAD,</literal> |
2107 <value>size</value><literal>)</literal> | |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2108 system call, supported since FreeBSD 9.0-CURRENT, is used. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2109 FreeBSD 7 has to be |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2110 <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
|
2111 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2112 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2113 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2114 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2115 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2116 <directive name="recursive_error_pages"> |
271 | 2117 <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
|
2118 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2119 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2120 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2121 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2122 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2123 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2124 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
|
2125 <link id="error_page"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2126 directive. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2127 The number of such redirects is <link id="internal">limited</link>. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2128 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2129 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2130 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2131 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2132 |
169
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2133 <directive name="request_pool_size"> |
271 | 2134 <syntax><value>size</value></syntax> |
169
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2135 <default>4k</default> |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2136 <context>http</context> |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2137 <context>server</context> |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2138 |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2139 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2140 Allows accurate tuning of per-request memory allocations. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2141 This directive has minimal impact on performance |
169
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2142 and should not generally be used. |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2143 </para> |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2144 |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2145 </directive> |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2146 |
b7b160e4e046
Rstored alphabetical order of directives.
Ruslan Ermilov <ru@nginx.com>
parents:
162
diff
changeset
|
2147 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2148 <directive name="reset_timedout_connection"> |
364 | 2149 <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
|
2150 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2151 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2152 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2153 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2154 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2155 <para> |
2390
655e7de7fd4b
Documented "return 444" when reset_timedout_connection is on.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2384
diff
changeset
|
2156 Enables or disables resetting timed out connections |
655e7de7fd4b
Documented "return 444" when reset_timedout_connection is on.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2384
diff
changeset
|
2157 and connections |
655e7de7fd4b
Documented "return 444" when reset_timedout_connection is on.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2384
diff
changeset
|
2158 <link doc="ngx_http_rewrite_module.xml" id="return">closed</link> |
655e7de7fd4b
Documented "return 444" when reset_timedout_connection is on.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2384
diff
changeset
|
2159 with the non-standard code 444 (1.15.2). |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2160 The reset is performed as follows. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2161 Before closing a socket, the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2162 <c-def>SO_LINGER</c-def> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2163 option is set on it with a timeout value of 0. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2164 When the socket is closed, TCP RST is sent to the client, and all memory |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2165 occupied by this socket is released. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2166 This helps avoid keeping an already closed socket with filled buffers |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2167 in a FIN_WAIT1 state for a long time. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2168 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2169 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2170 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2171 It should be noted that timed out keep-alive connections are |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2172 closed normally. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2173 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2174 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2175 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2176 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2177 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2178 <directive name="resolver"> |
185
05e7496801ec
Documented recent changes in the "resolver" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
176
diff
changeset
|
2179 <syntax> |
1031
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2180 <value>address</value> ... |
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2181 [<literal>valid</literal>=<value>time</value>] |
2870
e06cf66a9f63
Documented the "ipv4=off" parameter of the "resolver" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2831
diff
changeset
|
2182 [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>] |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2183 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>] |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2184 [<literal>status_zone</literal>=<value>zone</value>]</syntax> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2185 <default/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2186 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2187 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2188 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2189 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2190 <para> |
527
58d79f8c412d
Documented 1.3.1 changes in "resolver".
Ruslan Ermilov <ru@nginx.com>
parents:
522
diff
changeset
|
2191 Configures name servers used to resolve names of upstream servers |
58d79f8c412d
Documented 1.3.1 changes in "resolver".
Ruslan Ermilov <ru@nginx.com>
parents:
522
diff
changeset
|
2192 into addresses, for example: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2193 <example> |
527
58d79f8c412d
Documented 1.3.1 changes in "resolver".
Ruslan Ermilov <ru@nginx.com>
parents:
522
diff
changeset
|
2194 resolver 127.0.0.1 [::1]:5353; |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2195 </example> |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2196 The address can be specified as a domain name or IP address, |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2197 with an optional port (1.3.1, 1.2.2). |
527
58d79f8c412d
Documented 1.3.1 changes in "resolver".
Ruslan Ermilov <ru@nginx.com>
parents:
522
diff
changeset
|
2198 If port is not specified, the port 53 is used. |
143
370cf5ccd3ca
The "resolver" directive now allows specifying multiple name servers.
Ruslan Ermilov <ru@nginx.com>
parents:
140
diff
changeset
|
2199 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
|
2200 <note> |
370cf5ccd3ca
The "resolver" directive now allows specifying multiple name servers.
Ruslan Ermilov <ru@nginx.com>
parents:
140
diff
changeset
|
2201 Before version 1.1.7, only a single name server could be configured. |
527
58d79f8c412d
Documented 1.3.1 changes in "resolver".
Ruslan Ermilov <ru@nginx.com>
parents:
522
diff
changeset
|
2202 Specifying name servers using IPv6 addresses is supported |
566 | 2203 starting from versions 1.3.1 and 1.2.2. |
143
370cf5ccd3ca
The "resolver" directive now allows specifying multiple name servers.
Ruslan Ermilov <ru@nginx.com>
parents:
140
diff
changeset
|
2204 </note> |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2205 </para> |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2206 |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2207 <para id="resolver_ipv6"> |
1031
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2208 By default, nginx will look up both IPv4 and IPv6 addresses while resolving. |
2870
e06cf66a9f63
Documented the "ipv4=off" parameter of the "resolver" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2831
diff
changeset
|
2209 If looking up of IPv4 or IPv6 addresses is not desired, |
e06cf66a9f63
Documented the "ipv4=off" parameter of the "resolver" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2831
diff
changeset
|
2210 the <literal>ipv4=off</literal> (1.23.1) or |
1031
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2211 the <literal>ipv6=off</literal> parameter can be specified. |
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2212 <note> |
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2213 Resolving of names into IPv6 addresses is supported |
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2214 starting from version 1.5.8. |
f7f23f5928ef
Documented "resolver ipv6=" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1024
diff
changeset
|
2215 </note> |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2216 </para> |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2217 |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
2218 <para id="resolver_valid"> |
185
05e7496801ec
Documented recent changes in the "resolver" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
176
diff
changeset
|
2219 By default, nginx caches answers using the TTL value of a response. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2220 An optional <literal>valid</literal> parameter allows overriding it: |
185
05e7496801ec
Documented recent changes in the "resolver" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
176
diff
changeset
|
2221 <example> |
527
58d79f8c412d
Documented 1.3.1 changes in "resolver".
Ruslan Ermilov <ru@nginx.com>
parents:
522
diff
changeset
|
2222 resolver 127.0.0.1 [::1]:5353 valid=30s; |
185
05e7496801ec
Documented recent changes in the "resolver" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
176
diff
changeset
|
2223 </example> |
05e7496801ec
Documented recent changes in the "resolver" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
176
diff
changeset
|
2224 <note> |
05e7496801ec
Documented recent changes in the "resolver" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
176
diff
changeset
|
2225 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
|
2226 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
|
2227 </note> |
1770
ae46e57cecba
Added note to the "resover" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1763
diff
changeset
|
2228 <note> |
ae46e57cecba
Added note to the "resover" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1763
diff
changeset
|
2229 To prevent DNS spoofing, it is recommended |
ae46e57cecba
Added note to the "resover" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1763
diff
changeset
|
2230 configuring DNS servers in a properly secured trusted local network. |
ae46e57cecba
Added note to the "resover" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1763
diff
changeset
|
2231 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2232 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2233 |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2234 <para id="resolver_status_zone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2235 The optional <literal>status_zone</literal> parameter (1.17.1) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2236 enables |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2237 <link doc="ngx_http_api_module.xml" id="resolvers_">collection</link> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2238 of DNS server statistics of requests and responses |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2239 in the specified <value>zone</value>. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2240 The parameter is available as part of our |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2241 <commercial_version>commercial subscription</commercial_version>. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2242 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2391
diff
changeset
|
2243 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2244 </directive> |
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 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2247 <directive name="resolver_timeout"> |
271 | 2248 <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
|
2249 <default>30s</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2250 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2251 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2252 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2253 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2254 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2255 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
|
2256 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2257 resolver_timeout 5s; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2258 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2259 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2260 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2261 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2262 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2263 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2264 <directive name="root"> |
271 | 2265 <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
|
2266 <default>html</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2267 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2268 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2269 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2270 <context>if in location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2271 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2272 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2273 Sets the root directory for requests. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2274 For example, with the following configuration |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2275 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2276 location /i/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2277 root /data/w3; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2278 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2279 </example> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2280 The <path>/data/w3/i/top.gif</path> file will be sent in response to |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2281 the “<literal>/i/top.gif</literal>” request. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2282 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2283 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2284 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2285 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
|
2286 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
|
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 A path to the file is constructed by merely adding a URI to the value |
271 | 2291 of the <literal>root</literal> directive. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2292 If a URI has to be modified, the |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
2293 <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
|
2294 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2295 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2296 </directive> |
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 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2299 <directive name="satisfy"> |
271 | 2300 <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
|
2301 <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
|
2302 <context>http</context> |
935beaa561b3
- use of $document_root and $realpath_root in "root" is prohibited
Ruslan Ermilov <ru@nginx.com>
parents:
68
diff
changeset
|
2303 <context>server</context> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2304 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2305 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2306 <para> |
971
6316a7579448
Documented the "ngx_http_auth_request" module.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
2307 Allows access if all (<literal>all</literal>) or at least one |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2308 (<literal>any</literal>) of the |
971
6316a7579448
Documented the "ngx_http_auth_request" module.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
2309 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>, |
1763
a7974b8d2a23
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1732
diff
changeset
|
2310 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>, |
a7974b8d2a23
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1732
diff
changeset
|
2311 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>, |
a7974b8d2a23
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1732
diff
changeset
|
2312 or |
a7974b8d2a23
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1732
diff
changeset
|
2313 <link doc="ngx_http_auth_jwt_module.xml">ngx_http_auth_jwt_module</link> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2314 modules allow access. |
246 | 2315 </para> |
2316 | |
2317 <para> | |
2318 Example: | |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2319 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2320 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2321 satisfy any; |
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 allow 192.168.1.0/32; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2324 deny all; |
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 auth_basic "closed site"; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2327 auth_basic_user_file conf/htpasswd; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2328 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2329 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2330 </para> |
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 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2333 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2334 |
176
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2335 <directive name="send_lowat"> |
271 | 2336 <syntax><value>size</value></syntax> |
176
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2337 <default>0</default> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2338 <context>http</context> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2339 <context>server</context> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2340 <context>location</context> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2341 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2342 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2343 If the directive is set to a non-zero value, nginx will try to minimize |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2344 the number of send operations on client sockets by using either |
553
6330ca27a485
Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
541
diff
changeset
|
2345 <c-def>NOTE_LOWAT</c-def> flag of the |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2346 <link doc="../events.xml" id="kqueue"/> method |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2347 or the <c-def>SO_SNDLOWAT</c-def> socket option. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2348 In both cases the specified <value>size</value> is used. |
176
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2349 </para> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2350 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2351 <para> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2352 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
|
2353 </para> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2354 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2355 </directive> |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2356 |
0883fc5aabc9
Documented the "keepalive_disable" and "send_lowat" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
175
diff
changeset
|
2357 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2358 <directive name="send_timeout"> |
271 | 2359 <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
|
2360 <default>60s</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2361 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2362 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2363 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2364 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2365 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2366 Sets a timeout for transmitting a response to the client. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1132
diff
changeset
|
2367 The timeout is set only between two successive write operations, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2368 not for the transmission of the whole response. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1132
diff
changeset
|
2369 If the client does not receive anything within this time, |
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1132
diff
changeset
|
2370 the connection is closed. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2371 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2372 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2373 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2374 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2375 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2376 <directive name="sendfile"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2377 |
271 | 2378 <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
|
2379 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2380 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2381 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2382 <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
|
2383 <context>if in location</context> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2384 |
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 Enables or disables the use of |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2387 <c-func>sendfile</c-func>. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2388 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2389 |
1432
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2390 <para> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2391 Starting from nginx 0.8.12 and FreeBSD 5.2.1, |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2392 <link id="aio"/> can be used to pre-load data |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2393 for <c-func>sendfile</c-func>: |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2394 <example> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2395 location /video/ { |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2396 sendfile on; |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2397 tcp_nopush on; |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2398 aio on; |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2399 } |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2400 </example> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2401 In this configuration, <c-func>sendfile</c-func> is called with |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2402 the <c-def>SF_NODISKIO</c-def> flag which causes it not to block on disk I/O, |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2403 but, instead, report back that the data are not in memory. |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2404 nginx then initiates an asynchronous data load by reading one byte. |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2405 On the first read, the FreeBSD kernel loads the first 128K bytes |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2406 of a file into memory, although next reads will only load data in 16K chunks. |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2407 This can be changed using the |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2408 <link id="read_ahead"/> directive. |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2409 <note> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2410 Before version 1.7.11, pre-loading could be enabled with |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2411 <literal>aio sendfile;</literal>. |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2412 </note> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2413 </para> |
9012d7935c9b
Documented that "aio sendfile" is deprecated.
Ruslan Ermilov <ru@nginx.com>
parents:
1430
diff
changeset
|
2414 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2415 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2416 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2417 |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2418 <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
|
2419 |
271 | 2420 <syntax><value>size</value></syntax> |
2793
4934cbc1db19
Changed default value of sendfile_max_chunk to 2m.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
2421 <default>2m</default> |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2422 <context>http</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2423 <context>server</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2424 <context>location</context> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2425 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2426 <para> |
2793
4934cbc1db19
Changed default value of sendfile_max_chunk to 2m.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
2427 Limits the amount of data that can be |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2428 transferred in a single <c-func>sendfile</c-func> call. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2429 Without the limit, one fast connection may seize the worker process entirely. |
2793
4934cbc1db19
Changed default value of sendfile_max_chunk to 2m.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
2430 <note> |
4934cbc1db19
Changed default value of sendfile_max_chunk to 2m.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
2431 Prior to version 1.21.4, by default there was no limit. |
4934cbc1db19
Changed default value of sendfile_max_chunk to 2m.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
2432 </note> |
175
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2433 </para> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2434 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2435 </directive> |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2436 |
3381ae6a93e4
Documented the max_ranges, postpone_output, and sendfile_max_chunk directives.
Ruslan Ermilov <ru@nginx.com>
parents:
174
diff
changeset
|
2437 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2438 <directive name="server"> |
108
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
106
diff
changeset
|
2439 <syntax block="yes"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2440 <default/> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2441 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2442 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2443 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2444 Sets configuration for a virtual server. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2445 There is no clear separation between IP-based (based on the IP address) |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2446 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
|
2447 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
|
2448 Instead, the <link id="listen"/> directives describe all |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2449 addresses and ports that should accept connections for the server, and the |
106
56457a474903
If text of the link is not provided, the @id is used.
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
2450 <link id="server_name"/> directive lists all server names. |
522
ef11546f75ee
Translated "request_processing" into Russian, removed "virtual_hosts"
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
2451 Example configurations are provided in the |
ef11546f75ee
Translated "request_processing" into Russian, removed "virtual_hosts"
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
2452 “<link doc="request_processing.xml"/>” document. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2453 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2454 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2455 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2456 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2457 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2458 <directive name="server_name"> |
271 | 2459 <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
|
2460 <default>""</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2461 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2462 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2463 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2464 Sets names of a virtual server, for example: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2465 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2466 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2467 server_name example.com www.example.com; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2468 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2469 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2470 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2471 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2472 <para> |
70 | 2473 The first name becomes the primary server name. |
628
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2474 </para> |
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2475 |
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2476 <para> |
271 | 2477 Server names can include an asterisk (“<literal>*</literal>”) |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2478 replacing the first or last part of a name: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2479 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2480 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2481 server_name example.com *.example.com www.example.*; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2482 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2483 </example> |
628
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2484 Such names are called wildcard names. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2485 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2486 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2487 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2488 The first two of the names mentioned above can be combined in one: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2489 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2490 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2491 server_name .example.com; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2492 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2493 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2494 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2495 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2496 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2497 It is also possible to use regular expressions in server names, |
1101 | 2498 preceding the name with a tilde (“<literal>~</literal>”): |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2499 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2500 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2501 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
|
2502 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2503 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2504 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2505 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2506 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2507 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
|
2508 be used in other directives: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2509 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2510 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2511 server_name ~^(www\.)?(.+)$; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2512 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2513 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2514 root /sites/$2; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2515 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2516 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2517 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2518 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2519 server_name _; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2520 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2521 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2522 root /sites/default; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2523 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2524 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2525 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2526 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2527 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2528 <para> |
70 | 2529 Named captures in regular expressions create variables (0.8.25) |
2530 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
|
2531 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2532 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2533 server_name ~^(www\.)?(?<domain>.+)$; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2534 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2535 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2536 root /sites/$domain; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2537 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2538 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2539 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2540 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2541 server_name _; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2542 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2543 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2544 root /sites/default; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2545 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2546 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2547 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2548 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2549 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2550 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2551 If the directive’s parameter is set to “<var>$hostname</var>” (0.9.4), the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2552 machine’s hostname is inserted. |
628
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2553 </para> |
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2554 |
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2555 <para> |
70 | 2556 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
|
2557 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2558 server { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2559 server_name www.example.com ""; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2560 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2561 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2562 It allows this server to process requests without the <header>Host</header> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2563 header field — instead of the default server — for the given address:port pair. |
70 | 2564 This is the default setting. |
2565 <note> | |
625
af3f38e349eb
Removed terminal whitespace and fixed apostrophes used.
Ruslan Ermilov <ru@nginx.com>
parents:
617
diff
changeset
|
2566 Before 0.8.48, the machine’s hostname was used by default. |
70 | 2567 </note> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2568 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2569 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2570 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2571 During searching for a virtual server by name, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2572 if the name matches more than one of the specified variants, |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2573 (e.g. both a wildcard name and regular expression match), the first matching |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2574 variant will be chosen, in the following order of priority: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2575 <list type="enum"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2576 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2577 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2578 the exact name |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2579 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2580 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2581 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2582 the longest wildcard name starting with an asterisk, |
587
5bb7716cae7e
Documented in more depth how server names are matched.
Ruslan Ermilov <ru@nginx.com>
parents:
580
diff
changeset
|
2583 e.g. “<literal>*.example.com</literal>” |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2584 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2585 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2586 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2587 the longest wildcard name ending with an asterisk, |
587
5bb7716cae7e
Documented in more depth how server names are matched.
Ruslan Ermilov <ru@nginx.com>
parents:
580
diff
changeset
|
2588 e.g. “<literal>mail.*</literal>” |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2589 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2590 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2591 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2592 the first matching regular expression |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2593 (in order of appearance in the configuration file) |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2594 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2595 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2596 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2597 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2598 |
628
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2599 <para> |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2600 Detailed description of server names is provided in a separate |
628
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2601 <link doc="server_names.xml"/> document. |
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2602 </para> |
779a47d0acb0
Unified terminology used in the "server_name" directive and server_names.xml.
Vladimir Homutov <vl@nginx.com>
parents:
627
diff
changeset
|
2603 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2604 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2605 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2606 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2607 <directive name="server_name_in_redirect"> |
271 | 2608 <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
|
2609 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2610 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2611 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2612 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2613 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2614 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2615 Enables or disables the use of the primary server name, specified by the |
1879
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
2616 <link id="server_name"/> directive, |
3685d90e133e
Documented the "absolute_redirect" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1859
diff
changeset
|
2617 in <link id="absolute_redirect">absolute</link> redirects issued by nginx. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2618 When the use of the primary server name is disabled, the name from the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2619 <header>Host</header> request header field is used. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2620 If this field is not present, the IP address of the server is used. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2621 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2622 |
159
8c124aef0041
Cross-linked "server_name_in_redirect" and "port_in_redirect" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
152
diff
changeset
|
2623 <para> |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2624 The use of a port in redirects is controlled by |
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2625 the <link id="port_in_redirect"/> directive. |
159
8c124aef0041
Cross-linked "server_name_in_redirect" and "port_in_redirect" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
152
diff
changeset
|
2626 </para> |
8c124aef0041
Cross-linked "server_name_in_redirect" and "port_in_redirect" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
152
diff
changeset
|
2627 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2628 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2629 |
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 <directive name="server_names_hash_bucket_size"> |
271 | 2632 <syntax><value>size</value></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
2633 <default>32|64|128</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2634 <context>http</context> |
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 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2637 Sets the bucket size for the server names hash tables. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2638 The default value depends on the size of the processor’s cache line. |
966 | 2639 The details of setting up hash tables are provided in a separate |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2640 <link doc="../hash.xml">document</link>. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2641 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2642 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2643 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2644 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2645 |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2646 <directive name="server_names_hash_max_size"> |
271 | 2647 <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
|
2648 <default>512</default> |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2649 <context>http</context> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2650 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2651 <para> |
271 | 2652 Sets the maximum <value>size</value> of the server names hash tables. |
966 | 2653 The details of setting up hash tables are provided in a separate |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2654 <link doc="../hash.xml">document</link>. |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2655 </para> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2656 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2657 </directive> |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2658 |
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
2659 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2660 <directive name="server_tokens"> |
1680
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2661 <syntax> |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2662 <literal>on</literal> | |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2663 <literal>off</literal> | |
1904
d59199b0c022
Documented the "build" parameter of the "server_tokens" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1903
diff
changeset
|
2664 <literal>build</literal> | |
1680
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2665 <value>string</value></syntax> |
102
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
2666 <default>on</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2667 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2668 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2669 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2670 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2671 <para> |
1903
da00a2526415
Replaced "error messages" with "error pages" in server_tokens.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1879
diff
changeset
|
2672 Enables or disables emitting nginx version on error pages and in the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2673 <header>Server</header> response header field. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2674 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2675 |
1904
d59199b0c022
Documented the "build" parameter of the "server_tokens" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1903
diff
changeset
|
2676 <para id="server_tokens_build"> |
1953
408eed0bf491
Clarified description of server_tokens build.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
2677 The <literal>build</literal> parameter (1.11.10) enables emitting |
408eed0bf491
Clarified description of server_tokens build.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
2678 a <link doc="../configure.xml" id="build">build name</link> |
408eed0bf491
Clarified description of server_tokens build.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
2679 along with nginx version. |
1904
d59199b0c022
Documented the "build" parameter of the "server_tokens" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1903
diff
changeset
|
2680 </para> |
d59199b0c022
Documented the "build" parameter of the "server_tokens" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1903
diff
changeset
|
2681 |
1680
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2682 <para> |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2683 Additionally, as part of our |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2684 <commercial_version>commercial subscription</commercial_version>, |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2685 starting from version 1.9.13 |
1903
da00a2526415
Replaced "error messages" with "error pages" in server_tokens.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1879
diff
changeset
|
2686 the signature on error pages and |
1680
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2687 the <header>Server</header> response header field value |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2688 can be set explicitly using the <value>string</value> with variables. |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2689 An empty string disables the emission of the <header>Server</header> field. |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2690 </para> |
57c3f36b3b6a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1665
diff
changeset
|
2691 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2692 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2693 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2694 |
2118
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2695 <directive name="subrequest_output_buffer_size"> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2696 <syntax><value>size</value></syntax> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2697 <default>4k|8k</default> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2698 <context>http</context> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2699 <context>server</context> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2700 <context>location</context> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2701 <appeared-in>1.13.10</appeared-in> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2702 |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2703 <para> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2704 Sets the <value>size</value> of the buffer used for |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2705 storing the response body of a subrequest. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2706 By default, the buffer size is equal to one memory page. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2707 This is either 4K or 8K, depending on a platform. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2708 It can be made smaller, however. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2709 </para> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2710 |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2711 <para> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2712 The directive is applicable only for subrequests |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2713 with response bodies saved into memory. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2714 For example, such subrequests are created by |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2715 <link doc="ngx_http_ssi_module.xml" id="ssi_include_set">SSI</link>. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2716 </para> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2717 |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2718 </directive> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2719 |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2039
diff
changeset
|
2720 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2721 <directive name="tcp_nodelay"> |
271 | 2722 <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
|
2723 <default>on</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2724 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2725 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2726 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2727 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2728 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2729 Enables or disables the use of the <c-def>TCP_NODELAY</c-def> option. |
2121
cf9e3d2893b6
Fixed description of the http tcp_nodelay directive.
Ruslan Ermilov <ru@nginx.com>
parents:
2118
diff
changeset
|
2730 The option is enabled when a connection is transitioned into the |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2731 keep-alive state. |
2121
cf9e3d2893b6
Fixed description of the http tcp_nodelay directive.
Ruslan Ermilov <ru@nginx.com>
parents:
2118
diff
changeset
|
2732 Additionally, it is enabled on SSL connections, |
cf9e3d2893b6
Fixed description of the http tcp_nodelay directive.
Ruslan Ermilov <ru@nginx.com>
parents:
2118
diff
changeset
|
2733 for unbuffered proxying, |
cf9e3d2893b6
Fixed description of the http tcp_nodelay directive.
Ruslan Ermilov <ru@nginx.com>
parents:
2118
diff
changeset
|
2734 and for <link doc="websocket.xml">WebSocket</link> proxying. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2735 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2736 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2737 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2738 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2739 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2740 <directive name="tcp_nopush"> |
271 | 2741 <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
|
2742 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2743 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2744 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2745 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2746 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2747 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2748 Enables or disables the use of |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2749 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
|
2750 or the <c-def>TCP_CORK</c-def> socket option on Linux. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2751 The options are enabled only when <link id="sendfile"/> is used. |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2752 Enabling the option allows |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2753 <list type="bullet"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2754 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2755 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2756 sending the response header and the beginning of a file in one packet, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2757 on Linux and FreeBSD 4.*; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2758 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2759 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2760 <listitem> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2761 sending a file in full packets. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2762 </listitem> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2763 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2764 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2765 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2766 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2767 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2768 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2769 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2770 <directive name="try_files"> |
364 | 2771 <syntax><value>file</value> ... <value>uri</value></syntax> |
2772 <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
|
2773 <default/> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2774 <context>server</context> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2775 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2776 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2777 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2778 Checks the existence of files in the specified order and uses |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2779 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
|
2780 is performed in the current context. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2781 The path to a file is constructed from the |
271 | 2782 <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
|
2783 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
|
2784 <link id="root"/> and <link id="alias"/> directives. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2785 It is possible to check directory’s existence by specifying |
271 | 2786 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
|
2787 If none of the files were found, an internal redirect to the |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2788 <value>uri</value> specified in the last parameter is made. |
173
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2789 For example: |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2790 <example> |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2791 location /images/ { |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2792 try_files $uri /images/default.gif; |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2793 } |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2794 |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2795 location = /images/default.gif { |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2796 expires 30s; |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2797 } |
6b81a1950ecb
Improved on "try_files" documentation:
Ruslan Ermilov <ru@nginx.com>
parents:
172
diff
changeset
|
2798 </example> |
271 | 2799 The last parameter can also point to a named location, |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2800 as shown in examples below. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2801 Starting from version 0.7.51, the last parameter can also be a |
271 | 2802 <value>code</value>: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2803 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2804 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2805 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
|
2806 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2807 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2808 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2809 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2810 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2811 Example in proxying Mongrel: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2812 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2813 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2814 try_files /system/maintenance.html |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2815 $uri $uri/index.html $uri.html |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2816 @mongrel; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2817 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2818 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2819 location @mongrel { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2820 proxy_pass http://mongrel; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2821 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2822 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2823 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2824 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2825 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2826 Example for Drupal/FastCGI: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2827 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2828 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2829 try_files $uri $uri/ @drupal; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2830 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2831 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2832 location ~ \.php$ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2833 try_files $uri @drupal; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2834 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2835 fastcgi_pass ...; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2836 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2837 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
|
2838 fastcgi_param SCRIPT_NAME $fastcgi_script_name; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2839 fastcgi_param QUERY_STRING $args; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2840 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2841 ... other fastcgi_param's |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2842 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2843 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2844 location @drupal { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2845 fastcgi_pass ...; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2846 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2847 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
|
2848 fastcgi_param SCRIPT_NAME /index.php; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2849 fastcgi_param QUERY_STRING q=$uri&$args; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2850 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2851 ... other fastcgi_param's |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2852 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2853 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2854 In the following example, |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2855 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2856 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2857 try_files $uri $uri/ @drupal; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2858 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2859 </example> |
271 | 2860 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
|
2861 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2862 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2863 error_page 404 = @drupal; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2864 log_not_found off; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2865 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2866 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2867 And here, |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2868 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2869 location ~ \.php$ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2870 try_files $uri @drupal; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2871 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2872 fastcgi_pass ...; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2873 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2874 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
|
2875 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2876 ... |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2877 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2878 </example> |
271 | 2879 <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
|
2880 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
|
2881 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2882 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2883 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2884 Example for Wordpress and Joomla: |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2885 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2886 location / { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2887 try_files $uri $uri/ @wordpress; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2888 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2889 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2890 location ~ \.php$ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2891 try_files $uri @wordpress; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2892 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2893 fastcgi_pass ...; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2894 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2895 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
|
2896 ... other fastcgi_param's |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2897 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2898 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2899 location @wordpress { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2900 fastcgi_pass ...; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2901 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2902 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
|
2903 ... other fastcgi_param's |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2904 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2905 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2906 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2907 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2908 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2909 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2910 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2911 <directive name="types"> |
108
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
106
diff
changeset
|
2912 <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
|
2913 <default> |
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
2914 text/html html; |
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
2915 image/gif gif; |
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
2916 image/jpeg jpg; |
c76a257f3fd4
The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents:
98
diff
changeset
|
2917 </default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2918 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2919 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2920 <context>location</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2921 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2922 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2923 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
|
2924 Extensions are case-insensitive. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2925 Several extensions can be mapped to one type, for example: |
160
0b65e87daa8a
Documented that filename extensions that map to MIME types are
Ruslan Ermilov <ru@nginx.com>
parents:
159
diff
changeset
|
2926 <example> |
0b65e87daa8a
Documented that filename extensions that map to MIME types are
Ruslan Ermilov <ru@nginx.com>
parents:
159
diff
changeset
|
2927 types { |
0b65e87daa8a
Documented that filename extensions that map to MIME types are
Ruslan Ermilov <ru@nginx.com>
parents:
159
diff
changeset
|
2928 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
|
2929 application/octet-stream deb; |
0b65e87daa8a
Documented that filename extensions that map to MIME types are
Ruslan Ermilov <ru@nginx.com>
parents:
159
diff
changeset
|
2930 application/octet-stream dmg; |
0b65e87daa8a
Documented that filename extensions that map to MIME types are
Ruslan Ermilov <ru@nginx.com>
parents:
159
diff
changeset
|
2931 } |
0b65e87daa8a
Documented that filename extensions that map to MIME types are
Ruslan Ermilov <ru@nginx.com>
parents:
159
diff
changeset
|
2932 </example> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2933 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2934 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2935 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2936 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
|
2937 <path>conf/mime.types</path> file. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2938 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2939 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2940 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2941 To make a particular location emit the |
271 | 2942 “<literal>application/octet-stream</literal>” |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2943 MIME type for all requests, the following configuration can be used: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2944 <example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2945 location /download/ { |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2946 types { } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2947 default_type application/octet-stream; |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2948 } |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2949 </example> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2950 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2951 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2952 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2953 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2954 |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2955 <directive name="types_hash_bucket_size"> |
271 | 2956 <syntax><value>size</value></syntax> |
1132
8bdb4eb27f48
Documented the new default of "types_hash_bucket_size".
Ruslan Ermilov <ru@nginx.com>
parents:
1110
diff
changeset
|
2957 <default>64</default> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2958 <context>http</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2959 <context>server</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2960 <context>location</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2961 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2962 <para> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2963 Sets the bucket size for the types hash tables. |
966 | 2964 The details of setting up hash tables are provided in a separate |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2965 <link doc="../hash.xml">document</link>. |
1132
8bdb4eb27f48
Documented the new default of "types_hash_bucket_size".
Ruslan Ermilov <ru@nginx.com>
parents:
1110
diff
changeset
|
2966 <note> |
8bdb4eb27f48
Documented the new default of "types_hash_bucket_size".
Ruslan Ermilov <ru@nginx.com>
parents:
1110
diff
changeset
|
2967 Prior to version 1.5.13, |
8bdb4eb27f48
Documented the new default of "types_hash_bucket_size".
Ruslan Ermilov <ru@nginx.com>
parents:
1110
diff
changeset
|
2968 the default value depended on the size of the processor’s cache line. |
8bdb4eb27f48
Documented the new default of "types_hash_bucket_size".
Ruslan Ermilov <ru@nginx.com>
parents:
1110
diff
changeset
|
2969 </note> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2970 </para> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2971 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2972 </directive> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2973 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2974 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2975 <directive name="types_hash_max_size"> |
271 | 2976 <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
|
2977 <default>1024</default> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2978 <context>http</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2979 <context>server</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2980 <context>location</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2981 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2982 <para> |
271 | 2983 Sets the maximum <value>size</value> of the types hash tables. |
966 | 2984 The details of setting up hash tables are provided in a separate |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
2985 <link doc="../hash.xml">document</link>. |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2986 </para> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2987 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2988 </directive> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2989 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
2990 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2991 <directive name="underscores_in_headers"> |
271 | 2992 <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
|
2993 <default>off</default> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2994 <context>http</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2995 <context>server</context> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2996 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2997 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2998 Enables or disables the use of underscores in client request header fields. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
2999 When the use of underscores is disabled, request header fields whose names |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3000 contain underscores are |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3001 marked as invalid and become subject to the |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3002 <link id="ignore_invalid_headers"/> directive. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3003 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3004 |
426
1d6dc85ed324
Specifying "ignore_invalid_headers" or "underscores_in_headers" on the
Ruslan Ermilov <ru@nginx.com>
parents:
419
diff
changeset
|
3005 <para> |
1023
375055da60fa
Improved wording of merge_slashes etc. (ticket #448).
Maxim Dounin <mdounin@mdounin.ru>
parents:
1022
diff
changeset
|
3006 If the directive is specified on the <link id="server"/> level, |
2795
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
3007 the value from the default server can be used. |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
3008 Details are provided in the |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
3009 “<link doc="server_names.xml" id="virtual_server_selection">Virtual |
691de23367a7
Added link to "Virtual server Selection" in buffer directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2793
diff
changeset
|
3010 server selection</link>” section. |
426
1d6dc85ed324
Specifying "ignore_invalid_headers" or "underscores_in_headers" on the
Ruslan Ermilov <ru@nginx.com>
parents:
419
diff
changeset
|
3011 </para> |
1d6dc85ed324
Specifying "ignore_invalid_headers" or "underscores_in_headers" on the
Ruslan Ermilov <ru@nginx.com>
parents:
419
diff
changeset
|
3012 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3013 </directive> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3014 |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3015 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3016 <directive name="variables_hash_bucket_size"> |
271 | 3017 <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
|
3018 <default>64</default> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3019 <context>http</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3020 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3021 <para> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3022 Sets the bucket size for the variables hash table. |
966 | 3023 The details of setting up hash tables are provided in a separate |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
3024 <link doc="../hash.xml">document</link>. |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3025 </para> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3026 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3027 </directive> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3028 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3029 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3030 <directive name="variables_hash_max_size"> |
271 | 3031 <syntax><value>size</value></syntax> |
1108
a0543e9213e7
New default value for the variables_hash_max_size directive.
Andrei Belov <defan@nginx.com>
parents:
1101
diff
changeset
|
3032 <default>1024</default> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3033 <context>http</context> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3034 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3035 <para> |
271 | 3036 Sets the maximum <value>size</value> of the variables hash table. |
966 | 3037 The details of setting up hash tables are provided in a separate |
659
77a3314c74a7
Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents:
651
diff
changeset
|
3038 <link doc="../hash.xml">document</link>. |
1108
a0543e9213e7
New default value for the variables_hash_max_size directive.
Andrei Belov <defan@nginx.com>
parents:
1101
diff
changeset
|
3039 <note> |
a0543e9213e7
New default value for the variables_hash_max_size directive.
Andrei Belov <defan@nginx.com>
parents:
1101
diff
changeset
|
3040 Prior to version 1.5.13, the default value was 512. |
a0543e9213e7
New default value for the variables_hash_max_size directive.
Andrei Belov <defan@nginx.com>
parents:
1101
diff
changeset
|
3041 </note> |
1110
4a4fe2d79d14
a0543e9213e7 nit fixed: "note" block moved inside "para".
Maxim Konovalov <maxim@nginx.com>
parents:
1108
diff
changeset
|
3042 </para> |
72
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3043 |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3044 </directive> |
0987079ad08f
- "try_files" can be specified in the "server" context,
Ruslan Ermilov <ru@nginx.com>
parents:
70
diff
changeset
|
3045 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3046 </section> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3047 |
364 | 3048 |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3049 <section id="variables" name="Embedded Variables"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3050 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3051 <para> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3052 The <literal>ngx_http_core_module</literal> module supports embedded variables |
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3053 with names matching the Apache Server variables. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3054 First of all, these are variables representing client request header |
82
89c31b453d40
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
72
diff
changeset
|
3055 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
|
3056 and so on. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3057 Also there are other variables: |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3058 <list type="tag"> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3059 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3060 <tag-name id="var_arg_"><var>$arg_</var><value>name</value></tag-name> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3061 <tag-desc> |
271 | 3062 argument <value>name</value> in the request line |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3063 </tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3064 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3065 <tag-name id="var_args"><var>$args</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3066 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3067 arguments in the request line |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3068 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3069 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3070 <tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3071 <tag-desc> |
625
af3f38e349eb
Removed terminal whitespace and fixed apostrophes used.
Ruslan Ermilov <ru@nginx.com>
parents:
617
diff
changeset
|
3072 client address in a binary form, value’s length is always 4 bytes |
1699
6c96a644b0b3
Corrected description of $binary_remote_addr and saved state.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1692
diff
changeset
|
3073 for IPv4 addresses or 16 bytes for IPv6 addresses |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3074 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3075 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3076 <tag-name id="var_body_bytes_sent"><var>$body_bytes_sent</var></tag-name> |
86
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3077 <tag-desc> |
769
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3078 number of bytes sent to a client, not counting the response header; |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3079 this variable is compatible with the “<literal>%B</literal>” parameter of the |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3080 <literal>mod_log_config</literal> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3081 Apache module |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3082 </tag-desc> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3083 |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3084 <tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3085 <tag-desc> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3086 number of bytes sent to a client (1.3.8, 1.2.5) |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3087 </tag-desc> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3088 |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3089 <tag-name id="var_connection"><var>$connection</var></tag-name> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3090 <tag-desc> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3091 connection serial number (1.3.8, 1.2.5) |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3092 </tag-desc> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3093 |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3094 <tag-name id="var_connection_requests"><var>$connection_requests</var></tag-name> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3095 <tag-desc> |
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3096 current number of requests made through a connection (1.3.8, 1.2.5) |
86
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3097 </tag-desc> |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3098 |
2707
c1d62e514b3c
Documented the $connection_time variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2706
diff
changeset
|
3099 <tag-name id="var_connection_time"><var>$connection_time</var></tag-name> |
c1d62e514b3c
Documented the $connection_time variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2706
diff
changeset
|
3100 <tag-desc> |
c1d62e514b3c
Documented the $connection_time variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2706
diff
changeset
|
3101 connection time in seconds with a milliseconds resolution (1.19.10) |
c1d62e514b3c
Documented the $connection_time variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2706
diff
changeset
|
3102 </tag-desc> |
c1d62e514b3c
Documented the $connection_time variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2706
diff
changeset
|
3103 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3104 <tag-name id="var_content_length"><var>$content_length</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3105 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3106 <header>Content-Length</header> request header field |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3107 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3108 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3109 <tag-name id="var_content_type"><var>$content_type</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3110 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3111 <header>Content-Type</header> request header field |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3112 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3113 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3114 <tag-name id="var_cookie_"><var>$cookie_</var><value>name</value></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3115 <tag-desc> |
271 | 3116 the <value>name</value> cookie |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3117 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3118 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3119 <tag-name id="var_document_root"><var>$document_root</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3120 <tag-desc> |
625
af3f38e349eb
Removed terminal whitespace and fixed apostrophes used.
Ruslan Ermilov <ru@nginx.com>
parents:
617
diff
changeset
|
3121 <link id="root"/> or <link id="alias"/> directive’s value |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
3122 for the current request |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3123 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3124 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3125 <tag-name id="var_document_uri"><var>$document_uri</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3126 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3127 same as <var>$uri</var> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3128 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3129 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3130 <tag-name id="var_host"><var>$host</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3131 <tag-desc> |
940
ded8f4a5de28
Corrected description of the $host variable.
Ruslan Ermilov <ru@nginx.com>
parents:
914
diff
changeset
|
3132 in this order of precedence: |
ded8f4a5de28
Corrected description of the $host variable.
Ruslan Ermilov <ru@nginx.com>
parents:
914
diff
changeset
|
3133 host name from the request line, or |
ded8f4a5de28
Corrected description of the $host variable.
Ruslan Ermilov <ru@nginx.com>
parents:
914
diff
changeset
|
3134 host name from the <header>Host</header> request header field, or |
ded8f4a5de28
Corrected description of the $host variable.
Ruslan Ermilov <ru@nginx.com>
parents:
914
diff
changeset
|
3135 the server name matching a request |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3136 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3137 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3138 <tag-name id="var_hostname"><var>$hostname</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3139 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3140 host name |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3141 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3142 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3143 <tag-name id="var_http_"><var>$http_</var><value>name</value></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3144 <tag-desc> |
448
92672f6f0ee1
Elaborated on $http_* and $sent_http_* syntax.
Ruslan Ermilov <ru@nginx.com>
parents:
442
diff
changeset
|
3145 arbitrary request header field; |
92672f6f0ee1
Elaborated on $http_* and $sent_http_* syntax.
Ruslan Ermilov <ru@nginx.com>
parents:
442
diff
changeset
|
3146 the last part of a variable name is the field name converted |
92672f6f0ee1
Elaborated on $http_* and $sent_http_* syntax.
Ruslan Ermilov <ru@nginx.com>
parents:
442
diff
changeset
|
3147 to lower case with dashes replaced by underscores |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3148 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3149 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3150 <tag-name id="var_https"><var>$https</var></tag-name> |
234
ad26f0ae970f
Documented the $https variable.
Ruslan Ermilov <ru@nginx.com>
parents:
225
diff
changeset
|
3151 <tag-desc> |
271 | 3152 “<literal>on</literal>” |
234
ad26f0ae970f
Documented the $https variable.
Ruslan Ermilov <ru@nginx.com>
parents:
225
diff
changeset
|
3153 if connection operates in SSL mode, |
ad26f0ae970f
Documented the $https variable.
Ruslan Ermilov <ru@nginx.com>
parents:
225
diff
changeset
|
3154 or an empty string otherwise |
ad26f0ae970f
Documented the $https variable.
Ruslan Ermilov <ru@nginx.com>
parents:
225
diff
changeset
|
3155 </tag-desc> |
ad26f0ae970f
Documented the $https variable.
Ruslan Ermilov <ru@nginx.com>
parents:
225
diff
changeset
|
3156 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3157 <tag-name id="var_is_args"><var>$is_args</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3158 <tag-desc> |
271 | 3159 “<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
|
3160 or an empty string otherwise |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3161 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3162 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3163 <tag-name id="var_limit_rate"><var>$limit_rate</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3164 <tag-desc> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3165 setting this variable enables response rate limiting; |
767
1bb8b733416a
Clarified the description of the limit_rate directive
Ruslan Ermilov <ru@nginx.com>
parents:
747
diff
changeset
|
3166 see <link id="limit_rate"/> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3167 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3168 |
771
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3169 <tag-name id="var_msec"><var>$msec</var></tag-name> |
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3170 <tag-desc> |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3171 current time in seconds with the milliseconds resolution (1.3.9, 1.2.6) |
771
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3172 </tag-desc> |
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3173 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3174 <tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name> |
86
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3175 <tag-desc> |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3176 nginx version |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3177 </tag-desc> |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3178 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3179 <tag-name id="var_pid"><var>$pid</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3180 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3181 PID of the worker process |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3182 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3183 |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3184 <tag-name id="var_pipe"><var>$pipe</var></tag-name> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3185 <tag-desc> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3186 “<literal>p</literal>” if request was pipelined, “<literal>.</literal>” |
840
9dab69f2b71d
Documented nginx 1.2.7 changes.
Ruslan Ermilov <ru@nginx.com>
parents:
835
diff
changeset
|
3187 otherwise (1.3.12, 1.2.7) |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3188 </tag-desc> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3189 |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3190 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name> |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3191 <tag-desc> |
2457
3896055c397e
Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
3192 client address from the PROXY protocol header (1.5.12) |
1097
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3193 <para> |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3194 The PROXY protocol must be previously enabled by setting the |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3195 <literal>proxy_protocol</literal> parameter |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3196 in the <link id="listen"/> directive. |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3197 </para> |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3198 </tag-desc> |
eeb690d4212b
Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1037
diff
changeset
|
3199 |
1704
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3200 <tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name> |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3201 <tag-desc> |
2457
3896055c397e
Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
3202 client port from the PROXY protocol header (1.11.0) |
1704
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3203 <para> |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3204 The PROXY protocol must be previously enabled by setting the |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3205 <literal>proxy_protocol</literal> parameter |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3206 in the <link id="listen"/> directive. |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3207 </para> |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3208 </tag-desc> |
792478434bb1
Documented the $proxy_protocol_port variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1699
diff
changeset
|
3209 |
2458
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3210 <tag-name id="var_proxy_protocol_server_addr"><var>$proxy_protocol_server_addr</var></tag-name> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3211 <tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3212 server address from the PROXY protocol header (1.17.6) |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3213 <para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3214 The PROXY protocol must be previously enabled by setting the |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3215 <literal>proxy_protocol</literal> parameter |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3216 in the <link id="listen"/> directive. |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3217 </para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3218 </tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3219 |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3220 <tag-name id="var_proxy_protocol_server_port"><var>$proxy_protocol_server_port</var></tag-name> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3221 <tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3222 server port from the PROXY protocol header (1.17.6) |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3223 <para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3224 The PROXY protocol must be previously enabled by setting the |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3225 <literal>proxy_protocol</literal> parameter |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3226 in the <link id="listen"/> directive. |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3227 </para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3228 </tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
3229 |
2903
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3230 <tag-name id="var_proxy_protocol_tlv_"><var>$proxy_protocol_tlv_</var><value>name</value></tag-name> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3231 <tag-desc> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3232 TLV from the PROXY Protocol header (1.23.2). |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3233 The <literal>name</literal> can be a TLV type name or its numeric value. |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3234 In the latter case, the value is hexadecimal |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3235 and should be prefixed with <literal>0x</literal>: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3236 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3237 <example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3238 $proxy_protocol_tlv_alpn |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3239 $proxy_protocol_tlv_0x01 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3240 </example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3241 SSL TLVs can also be accessed by TLV type name |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3242 or its numeric value, |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3243 both prefixed by <literal>ssl_</literal>: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3244 <example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3245 $proxy_protocol_tlv_ssl_version |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3246 $proxy_protocol_tlv_ssl_0x21 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3247 </example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3248 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3249 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3250 The following TLV type names are supported: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3251 <list type="bullet"> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3252 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3253 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3254 <literal>alpn</literal> (<literal>0x01</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3255 upper layer protocol used over the connection |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3256 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3257 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3258 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3259 <literal>authority</literal> (<literal>0x02</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3260 host name value passed by the client |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3261 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3262 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3263 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3264 <literal>unique_id</literal> (<literal>0x05</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3265 unique connection id |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3266 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3267 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3268 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3269 <literal>netns</literal> (<literal>0x30</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3270 name of the namespace |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3271 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3272 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3273 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3274 <literal>ssl</literal> (<literal>0x20</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3275 binary SSL TLV structure |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3276 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3277 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3278 </list> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3279 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3280 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3281 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3282 The following SSL TLV type names are supported: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3283 <list type="bullet"> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3284 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3285 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3286 <literal>ssl_version</literal> (<literal>0x21</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3287 SSL version used in client connection |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3288 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3289 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3290 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3291 <literal>ssl_cn</literal> (<literal>0x22</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3292 SSL certificate Common Name |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3293 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3294 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3295 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3296 <literal>ssl_cipher</literal> (<literal>0x23</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3297 name of the used cipher |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3298 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3299 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3300 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3301 <literal>ssl_sig_alg</literal> (<literal>0x24</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3302 algorithm used to sign the certificate |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3303 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3304 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3305 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3306 <literal>ssl_key_alg</literal> (<literal>0x25</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3307 public-key algorithm |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3308 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3309 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3310 </list> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3311 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3312 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3313 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3314 Also, the following special SSL TLV type name is supported: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3315 <list type="bullet"> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3316 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3317 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3318 <literal>ssl_verify</literal>— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3319 client SSL certificate verification result, |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3320 <literal>0</literal> if the client presented a certificate |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3321 and it was successfully verified, |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3322 non-zero otherwise. |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3323 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3324 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3325 </list> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3326 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3327 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3328 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3329 The PROXY protocol must be previously enabled by setting the |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3330 <literal>proxy_protocol</literal> parameter |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3331 in the <link id="listen"/> directive. |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3332 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3333 </tag-desc> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
3334 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3335 <tag-name id="var_query_string"><var>$query_string</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3336 <tag-desc> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3337 same as <var>$args</var> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3338 </tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3339 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3340 <tag-name id="var_realpath_root"><var>$realpath_root</var></tag-name> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3341 <tag-desc> |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
3342 an absolute pathname corresponding to the |
625
af3f38e349eb
Removed terminal whitespace and fixed apostrophes used.
Ruslan Ermilov <ru@nginx.com>
parents:
617
diff
changeset
|
3343 <link id="root"/> or <link id="alias"/> directive’s value |
436
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
3344 for the current request, |
3a9f39341c7c
- Documented the "from" parameter of the "disable_symlinks" directive,
Ruslan Ermilov <ru@nginx.com>
parents:
429
diff
changeset
|
3345 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
|
3346 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3347 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3348 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3349 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3350 client address |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3351 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3352 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3353 <tag-name id="var_remote_port"><var>$remote_port</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3354 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3355 client port |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3356 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3357 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3358 <tag-name id="var_remote_user"><var>$remote_user</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3359 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3360 user name supplied with the Basic authentication |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3361 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3362 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3363 <tag-name id="var_request"><var>$request</var></tag-name> |
86
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3364 <tag-desc> |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3365 full original request line |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3366 </tag-desc> |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3367 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3368 <tag-name id="var_request_body"><var>$request_body</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3369 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3370 request body |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3371 <para> |
625
af3f38e349eb
Removed terminal whitespace and fixed apostrophes used.
Ruslan Ermilov <ru@nginx.com>
parents:
617
diff
changeset
|
3372 The variable’s value is made available in locations |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3373 processed by the |
1181 | 3374 <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>, |
3375 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>, | |
1194 | 3376 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>, |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3377 and |
1181 | 3378 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/> |
1732
5eb54b170c74
Clarified cases when $request_body is not empty.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1721
diff
changeset
|
3379 directives when the request body was read to |
5eb54b170c74
Clarified cases when $request_body is not empty.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1721
diff
changeset
|
3380 a <link id="client_body_buffer_size">memory buffer</link>. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3381 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3382 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3383 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3384 <tag-name id="var_request_body_file"><var>$request_body_file</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3385 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3386 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
|
3387 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3388 At the end of processing, the file needs to be removed. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3389 To always write the request body to a file, |
406
98dac2bd7598
Links with mixed underscores and spaces were hard to read, eliminated them.
Ruslan Ermilov <ru@nginx.com>
parents:
400
diff
changeset
|
3390 <link id="client_body_in_file_only"/> needs to be enabled. |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3391 When the name of a temporary file is passed in a proxied request |
1194 | 3392 or in a request to a FastCGI/uwsgi/SCGI server, |
958
fd1f8e0a405e
Text review of ngx_http_core_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
941
diff
changeset
|
3393 passing the request body should be disabled by the |
246 | 3394 <link doc="ngx_http_proxy_module.xml" id="proxy_pass_request_body"> |
1181 | 3395 proxy_pass_request_body off</link>, |
246 | 3396 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass_request_body"> |
1194 | 3397 fastcgi_pass_request_body off</link>, |
3398 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass_request_body"> | |
3399 uwsgi_pass_request_body off</link>, or | |
1181 | 3400 <link doc="ngx_http_scgi_module.xml" id="scgi_pass_request_body"> |
3401 scgi_pass_request_body off</link> | |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3402 directives, respectively. |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3403 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3404 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3405 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3406 <tag-name id="var_request_completion"><var>$request_completion</var></tag-name> |
88 | 3407 <tag-desc> |
271 | 3408 “<literal>OK</literal>” if a request has completed, |
88 | 3409 or an empty string otherwise |
3410 </tag-desc> | |
3411 | |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3412 <tag-name id="var_request_filename"><var>$request_filename</var></tag-name> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3413 <tag-desc> |
530 | 3414 file path for the current request, based on the |
246 | 3415 <link id="root"/> or <link id="alias"/> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3416 directives, and the request URI |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3417 </tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3418 |
1692
4319f72f11f5
Documented the $request_id variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1680
diff
changeset
|
3419 <tag-name id="var_request_id"><var>$request_id</var></tag-name> |
4319f72f11f5
Documented the $request_id variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1680
diff
changeset
|
3420 <tag-desc> |
1721
737c86e8b316
Clarified meaning of the $request_id variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1704
diff
changeset
|
3421 unique request identifier |
737c86e8b316
Clarified meaning of the $request_id variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1704
diff
changeset
|
3422 generated from 16 random bytes, in hexadecimal (1.11.0) |
1692
4319f72f11f5
Documented the $request_id variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1680
diff
changeset
|
3423 </tag-desc> |
4319f72f11f5
Documented the $request_id variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1680
diff
changeset
|
3424 |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3425 <tag-name id="var_request_length"><var>$request_length</var></tag-name> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3426 <tag-desc> |
840
9dab69f2b71d
Documented nginx 1.2.7 changes.
Ruslan Ermilov <ru@nginx.com>
parents:
835
diff
changeset
|
3427 request length (including request line, header, and request body) |
9dab69f2b71d
Documented nginx 1.2.7 changes.
Ruslan Ermilov <ru@nginx.com>
parents:
835
diff
changeset
|
3428 (1.3.12, 1.2.7) |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3429 </tag-desc> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3430 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3431 <tag-name id="var_request_method"><var>$request_method</var></tag-name> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3432 <tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3433 request method, usually |
271 | 3434 “<literal>GET</literal>” or “<literal>POST</literal>” |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3435 </tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3436 |
771
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3437 <tag-name id="var_request_time"><var>$request_time</var></tag-name> |
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3438 <tag-desc> |
779
32b8498cfb40
$msec and $request_time have become generic variables in 1.2.6.
Ruslan Ermilov <ru@nginx.com>
parents:
771
diff
changeset
|
3439 request processing time in seconds with a milliseconds resolution |
32b8498cfb40
$msec and $request_time have become generic variables in 1.2.6.
Ruslan Ermilov <ru@nginx.com>
parents:
771
diff
changeset
|
3440 (1.3.9, 1.2.6); |
771
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3441 time elapsed since the first bytes were read from the client |
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3442 </tag-desc> |
47ad88faaa3f
$msec and $request_time have become generic variables in 1.3.9.
Ruslan Ermilov <ru@nginx.com>
parents:
769
diff
changeset
|
3443 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3444 <tag-name id="var_request_uri"><var>$request_uri</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3445 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3446 full original request URI (with arguments) |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3447 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3448 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3449 <tag-name id="var_scheme"><var>$scheme</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3450 <tag-desc> |
271 | 3451 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
|
3452 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3453 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3454 <tag-name id="var_sent_http_"><var>$sent_http_</var><value>name</value></tag-name> |
86
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3455 <tag-desc> |
448
92672f6f0ee1
Elaborated on $http_* and $sent_http_* syntax.
Ruslan Ermilov <ru@nginx.com>
parents:
442
diff
changeset
|
3456 arbitrary response header field; |
92672f6f0ee1
Elaborated on $http_* and $sent_http_* syntax.
Ruslan Ermilov <ru@nginx.com>
parents:
442
diff
changeset
|
3457 the last part of a variable name is the field name converted |
92672f6f0ee1
Elaborated on $http_* and $sent_http_* syntax.
Ruslan Ermilov <ru@nginx.com>
parents:
442
diff
changeset
|
3458 to lower case with dashes replaced by underscores |
86
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3459 </tag-desc> |
341dc6392e8a
Documented $body_bytes_sent, $nginx_version, $request, and $sent_http_*.
Ruslan Ermilov <ru@nginx.com>
parents:
83
diff
changeset
|
3460 |
2003
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3461 <tag-name id="var_sent_trailer_"><var>$sent_trailer_</var><value>name</value></tag-name> |
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3462 <tag-desc> |
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3463 arbitrary field sent at the end of the response (1.13.2); |
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3464 the last part of a variable name is the field name converted |
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3465 to lower case with dashes replaced by underscores |
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3466 </tag-desc> |
be779702663e
Documented the "sent_trailer_" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1964
diff
changeset
|
3467 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3468 <tag-name id="var_server_addr"><var>$server_addr</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3469 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3470 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
|
3471 <para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3472 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
|
3473 To avoid a system call, the <link id="listen"/> directives |
271 | 3474 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
|
3475 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3476 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3477 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3478 <tag-name id="var_server_name"><var>$server_name</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3479 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3480 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
|
3481 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3482 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3483 <tag-name id="var_server_port"><var>$server_port</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3484 <tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3485 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
|
3486 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3487 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3488 <tag-name id="var_server_protocol"><var>$server_protocol</var></tag-name> |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3489 <tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3490 request protocol, usually |
1597
8b97ba73129b
Added HTTP/2.0 to the "server_protocol" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1576
diff
changeset
|
3491 “<literal>HTTP/1.0</literal>”, |
1614
1bab8e5f53c6
Added Oxford comma to "$server_protocol".
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1597
diff
changeset
|
3492 “<literal>HTTP/1.1</literal>”, |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3493 or |
1597
8b97ba73129b
Added HTTP/2.0 to the "server_protocol" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1576
diff
changeset
|
3494 “<link doc="ngx_http_v2_module.xml">HTTP/2.0</link>” |
83
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3495 </tag-desc> |
e8ed74d3fa0e
Sorted variables alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
82
diff
changeset
|
3496 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3497 <tag-name id="var_status"><var>$status</var></tag-name> |
541
a8971cf346be
Documented the $status core variable.
Andrey Belov <defan@nginx.com>
parents:
537
diff
changeset
|
3498 <tag-desc> |
769
d71e56d56ada
Documented variables relocations between http log and core modules.
Vladimir Homutov <vl@nginx.com>
parents:
768
diff
changeset
|
3499 response status (1.3.2, 1.2.2) |
541
a8971cf346be
Documented the $status core variable.
Andrey Belov <defan@nginx.com>
parents:
537
diff
changeset
|
3500 </tag-desc> |
a8971cf346be
Documented the $status core variable.
Andrey Belov <defan@nginx.com>
parents:
537
diff
changeset
|
3501 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3502 <tag-name id="var_tcpinfo_"> |
453
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3503 <var>$tcpinfo_rtt</var>, |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3504 <var>$tcpinfo_rttvar</var>, |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3505 <var>$tcpinfo_snd_cwnd</var>, |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3506 <var>$tcpinfo_rcv_space</var> |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3507 </tag-name> |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3508 <tag-desc> |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3509 information about the client TCP connection; available on systems |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3510 that support the <c-def>TCP_INFO</c-def> socket option |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3511 </tag-desc> |
98ee97a382d3
Documented the $tcpinfo_* variables.
Ruslan Ermilov <ru@nginx.com>
parents:
448
diff
changeset
|
3512 |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3513 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3514 <tag-desc> |
840
9dab69f2b71d
Documented nginx 1.2.7 changes.
Ruslan Ermilov <ru@nginx.com>
parents:
835
diff
changeset
|
3515 local time in the ISO 8601 standard format (1.3.12, 1.2.7) |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3516 </tag-desc> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3517 |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3518 <tag-name id="var_time_local"><var>$time_local</var></tag-name> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3519 <tag-desc> |
840
9dab69f2b71d
Documented nginx 1.2.7 changes.
Ruslan Ermilov <ru@nginx.com>
parents:
835
diff
changeset
|
3520 local time in the Common Log Format (1.3.12, 1.2.7) |
826
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3521 </tag-desc> |
ddd22f571529
Variables $pipe, $request_length, $time_iso8601, and $time_local.
Ruslan Ermilov <ru@nginx.com>
parents:
810
diff
changeset
|
3522 |
768
f63b7fa3bf17
Added "id" attributes to http core module variables.
Vladimir Homutov <vl@nginx.com>
parents:
767
diff
changeset
|
3523 <tag-name id="var_uri"><var>$uri</var></tag-name> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3524 <tag-desc> |
503
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
3525 current URI in request, <link id="location">normalized</link> |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3526 <para> |
503
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
3527 The value of <var>$uri</var> may change during request processing, |
aed015c3dedd
Documented URI normalization rules, including %-decoding.
Ruslan Ermilov <ru@nginx.com>
parents:
499
diff
changeset
|
3528 e.g. when doing internal redirects, or when using index files. |
57
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3529 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3530 </tag-desc> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3531 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3532 </list> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3533 </para> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3534 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3535 </section> |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3536 |
12f1de4539b4
Initial English translation of ngx_http_core_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3537 </module> |