Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_uwsgi_module.xml @ 2058:eb58ee50561d
Documented upstream name in $upstream_addr.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 10 Oct 2017 15:34:03 +0300 |
parents | 4f3dd2f548cf |
children | fc3ba2e76974 |
rev | line source |
---|---|
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3 <!-- |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Igor Sysoev |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
6 --> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
7 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_uwsgi_module" |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_uwsgi_module.html" |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
12 lang="en" |
1991
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
13 rev="40"> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 The <literal>ngx_http_uwsgi_module</literal> module allows passing |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 requests to a uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 </section> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 <section id="example" name="Example Configuration"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 location / { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 include uwsgi_params; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 uwsgi_pass localhost:9000; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 </section> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 <section id="directives" name="Directives"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 <directive name="uwsgi_bind"> |
1885
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
42 <syntax> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
43 <value>address</value> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
44 [<literal>transparent</literal>] | |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
45 <literal>off</literal></syntax> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 Makes outgoing connections to a uwsgi server originate |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
53 from the specified local IP address with an optional port (1.11.2). |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 Parameter value can contain variables (1.3.12). |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 The special value <literal>off</literal> (1.3.12) cancels the effect |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 of the <literal>uwsgi_bind</literal> directive |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 inherited from the previous configuration level, which allows the |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
58 system to auto-assign the local IP address and port. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
61 <para id="uwsgi_bind_transparent"> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
62 The <literal>transparent</literal> parameter (1.11.0) allows |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
63 outgoing connections to a uwsgi server originate |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
64 from a non-local IP address, |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
65 for example, from a real IP address of a client: |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
66 <example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
67 uwsgi_bind $remote_addr transparent; |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
68 </example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
69 In order for this parameter to work, |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
70 it is necessary to run nginx worker processes with the |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
71 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
72 and configure kernel routing table |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
73 to intercept network traffic from the uwsgi server. |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
74 </para> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
75 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 <directive name="uwsgi_buffer_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 <default>4k|8k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 Sets the <value>size</value> of the buffer used for reading the first part |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 of the response received from the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 This part usually contains a small response header. |
1550
305f2c338181
Fixed description of default value of proxy_buffer_size and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
90 By default, the buffer size is equal to one memory page. |
305f2c338181
Fixed description of default value of proxy_buffer_size and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
91 This is either 4K or 8K, depending on a platform. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 It can be made smaller, however. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 <directive name="uwsgi_buffering"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 <default>on</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 Enables or disables buffering of responses from the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 When buffering is enabled, nginx receives a response from the uwsgi server |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 as soon as possible, saving it into the buffers set by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 <link id="uwsgi_buffer_size"/> and <link id="uwsgi_buffers"/> directives. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 If the whole response does not fit into memory, a part of it can be saved |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 to a <link id="uwsgi_temp_path">temporary file</link> on the disk. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 Writing to temporary files is controlled by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 <link id="uwsgi_max_temp_file_size"/> and |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 <link id="uwsgi_temp_file_write_size"/> directives. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 When buffering is disabled, the response is passed to a client synchronously, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 immediately as it is received. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 nginx will not try to read the whole response from the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 The maximum size of the data that nginx can receive from the server |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 at a time is set by the <link id="uwsgi_buffer_size"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
126 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 Buffering can also be enabled or disabled by passing |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 “<literal>yes</literal>” or “<literal>no</literal>” in the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 <header>X-Accel-Buffering</header> response header field. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 This capability can be disabled using the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 <link id="uwsgi_ignore_headers"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
136 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 <directive name="uwsgi_buffers"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 <syntax><value>number</value> <value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 <default>8 4k|8k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 Sets the <value>number</value> and <value>size</value> of the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 buffers used for reading a response from the uwsgi server, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 for a single connection. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 By default, the buffer size is equal to one memory page. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 This is either 4K or 8K, depending on a platform. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 <directive name="uwsgi_busy_buffers_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 <default>8k|16k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 When <link id="uwsgi_buffering">buffering</link> of responses from the uwsgi |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 server is enabled, limits the total <value>size</value> of buffers that |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 can be busy sending a response to the client while the response is not |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 yet fully read. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 In the meantime, the rest of the buffers can be used for reading the response |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 and, if needed, buffering part of the response to a temporary file. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 By default, <value>size</value> is limited by the size of two buffers set by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 <link id="uwsgi_buffer_size"/> and <link id="uwsgi_buffers"/> directives. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 <directive name="uwsgi_cache"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 <syntax><value>zone</value> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 Defines a shared memory zone used for caching. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 The same zone can be used in several places. |
1382
94cac978bda3
Documented variables support in proxy_cache and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1379
diff
changeset
|
188 Parameter value can contain variables (1.7.9). |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 The <literal>off</literal> parameter disables caching inherited |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 from the previous configuration level. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
196 <directive name="uwsgi_cache_background_update"> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
197 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
198 <default>off</default> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
199 <context>http</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
200 <context>server</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
201 <context>location</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
202 <appeared-in>1.11.10</appeared-in> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
203 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
204 <para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
205 Allows starting a background subrequest |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
206 to update an expired cache item, |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
207 while a stale cached response is returned to the client. |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
208 Note that it is necessary to |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
209 <link id="uwsgi_cache_use_stale_updating">allow</link> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
210 the usage of a stale cached response when it is being updated. |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
211 </para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
212 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
213 </directive> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
214 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
215 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 <directive name="uwsgi_cache_bypass"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <syntax><value>string</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 Defines conditions under which the response will not be taken from a cache. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 If at least one value of the string parameters is not empty and is not |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 equal to “0” then the response will not be taken from the cache: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 uwsgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 uwsgi_cache_bypass $http_pragma $http_authorization; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 Can be used along with the <link id="uwsgi_no_cache"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 <directive name="uwsgi_cache_key"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 <syntax><value>string</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 Defines a key for caching, for example |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 uwsgi_cache_key localhost:9000$request_uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
251 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 <directive name="uwsgi_cache_lock"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 <appeared-in>1.1.12</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 When enabled, only one request at a time will be allowed to populate |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 a new cache element identified according to the <link id="uwsgi_cache_key"/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 directive by passing a request to a uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 Other requests of the same cache element will either wait |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 for a response to appear in the cache or the cache lock for |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 this element to be released, up to the time set by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 <link id="uwsgi_cache_lock_timeout"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
275 <directive name="uwsgi_cache_lock_age"> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
276 <syntax><value>time</value></syntax> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
277 <default>5s</default> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
278 <context>http</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
279 <context>server</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
280 <context>location</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
281 <appeared-in>1.7.8</appeared-in> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
282 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
283 <para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
284 If the last request passed to the uwsgi server |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
285 for populating a new cache element |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
286 has not completed for the specified <value>time</value>, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
287 one more request may be passed to the uwsgi server. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
288 </para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
289 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
290 </directive> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
291 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
292 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 <directive name="uwsgi_cache_lock_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 <default>5s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 <appeared-in>1.1.12</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
302 Sets a timeout for <link id="uwsgi_cache_lock"/>. |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
303 When the <value>time</value> expires, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
304 the request will be passed to the uwsgi server, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
305 however, the response will not be cached. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
306 <note> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
307 Before 1.7.8, the response could be cached. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
308 </note> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 |
1838
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
314 <directive name="uwsgi_cache_max_range_offset"> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
315 <syntax><value>number</value></syntax> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
316 <default/> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
317 <context>http</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
318 <context>server</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
319 <context>location</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
320 <appeared-in>1.11.6</appeared-in> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
321 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
322 <para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
323 Sets an offset in bytes for byte-range requests. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
324 If the range is beyond the offset, |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
325 the range request will be passed to the uwsgi server |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
326 and the response will not be cached. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
327 </para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
328 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
329 </directive> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
330 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
331 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 <directive name="uwsgi_cache_methods"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 <literal>GET</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 <literal>HEAD</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 <literal>POST</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
337 ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
338 <default>GET HEAD</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
339 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
340 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
343 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
344 If the client request method is listed in this directive then |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 the response will be cached. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 added to the list, though it is recommended to specify them explicitly. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
348 See also the <link id="uwsgi_no_cache"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
351 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 <directive name="uwsgi_cache_min_uses"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 <syntax><value>number</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 <default>1</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
358 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
361 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 Sets the <value>number</value> of requests after which the response |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 will be cached. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
365 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 <directive name="uwsgi_cache_path"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 <value>path</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 [<literal>levels</literal>=<value>levels</value>] |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
373 [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>] |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
375 [<literal>inactive</literal>=<value>time</value>] |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
376 [<literal>max_size</literal>=<value>size</value>] |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
377 [<literal>manager_files</literal>=<value>number</value>] |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
378 [<literal>manager_sleep</literal>=<value>time</value>] |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
379 [<literal>manager_threshold</literal>=<value>time</value>] |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 [<literal>loader_files</literal>=<value>number</value>] |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 [<literal>loader_sleep</literal>=<value>time</value>] |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
382 [<literal>loader_threshold</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
383 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
384 [<literal>purger_files</literal>=<value>number</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
385 [<literal>purger_sleep</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
386 [<literal>purger_threshold</literal>=<value>time</value>]</syntax> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
387 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
389 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
390 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
391 Sets the path and other parameters of a cache. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
392 Cache data are stored in files. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
393 The file name in a cache is a result of |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 applying the MD5 function to the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 <link id="uwsgi_cache_key">cache key</link>. |
1796
1d576e8d6ead
Clarified the "levels" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
396 The <literal>levels</literal> parameter defines hierarchy levels of a cache: |
1d576e8d6ead
Clarified the "levels" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
397 from 1 to 3, each level accepts values 1 or 2. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
398 For example, in the following configuration |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
399 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
400 uwsgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
401 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
402 file names in a cache will look like this: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
403 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
404 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
405 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
409 A cached response is first written to a temporary file, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
410 and then the file is renamed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 Starting from version 0.8.9, temporary files and the cache can be put on |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 different file systems. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 However, be aware that in this case a file is copied |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 across two file systems instead of the cheap renaming operation. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 It is thus recommended that for any given location both cache and a directory |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
416 holding temporary files |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 are put on the same file system. |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
418 A directory for temporary files is set based on |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
419 the <literal>use_temp_path</literal> parameter (1.7.10). |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
420 If this parameter is omitted or set to the value <literal>on</literal>, |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
421 the directory set by the <link id="uwsgi_temp_path"/> directive |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
422 for the given location will be used. |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
423 If the value is set to <literal>off</literal>, |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
424 temporary files will be put directly in the cache directory. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
425 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
426 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
427 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
428 In addition, all active keys and information about data are stored |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
429 in a shared memory zone, whose <value>name</value> and <value>size</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
430 are configured by the <literal>keys_zone</literal> parameter. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
431 One megabyte zone can store about 8 thousand keys. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
432 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
433 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
434 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
435 Cached data that are not accessed during the time specified by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
436 <literal>inactive</literal> parameter get removed from the cache |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
437 regardless of their freshness. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
438 By default, <literal>inactive</literal> is set to 10 minutes. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
440 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
441 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
442 The special “cache manager” process monitors the maximum cache size set |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
443 by the <literal>max_size</literal> parameter. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
444 When this size is exceeded, it removes the least recently used data. |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
445 The data is removed in iterations configured by |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
446 <literal>manager_files</literal>, |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
447 <literal>manager_threshold</literal>, and |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
448 <literal>manager_sleep</literal> parameters (1.11.5). |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
449 During one iteration no more than <literal>manager_files</literal> items |
1812
35ec213c16cf
Removed extraneous whitespace.
Ruslan Ermilov <ru@nginx.com>
parents:
1810
diff
changeset
|
450 are deleted (by default, 100). |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
451 The duration of one iteration is limited by the |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
452 <literal>manager_threshold</literal> parameter (by default, 200 milliseconds). |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
453 Between iterations, a pause configured by the <literal>manager_sleep</literal> |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
454 parameter (by default, 50 milliseconds) is made. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
455 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
456 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
457 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
458 A minute after the start the special “cache loader” process is activated. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
459 It loads information about previously cached data stored on file system |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
460 into a cache zone. |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
461 The loading is also done in iterations. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
462 During one iteration no more than <literal>loader_files</literal> items |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
463 are loaded (by default, 100). |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
464 Besides, the duration of one iteration is limited by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
465 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
466 Between iterations, a pause configured by the <literal>loader_sleep</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
467 parameter (by default, 50 milliseconds) is made. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
468 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
469 |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
470 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
471 Additionally, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
472 the following parameters are available as part of our |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
473 <commercial_version>commercial subscription</commercial_version>: |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
474 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
475 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
476 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
477 <list type="tag"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
478 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
479 <tag-name id="purger"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
480 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
481 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
482 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
483 Instructs whether cache entries that match a |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
484 <link id="uwsgi_cache_purge">wildcard key</link> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
485 will be removed from the disk by the cache purger (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
486 Setting the parameter to <literal>on</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
487 (default is <literal>off</literal>) |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
488 will activate the “cache purger” process that |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
489 permanently iterates through all cache entries |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
490 and deletes the entries that match the wildcard key. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
491 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
492 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
493 <tag-name id="purger_files"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
494 <literal>purger_files</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
495 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
496 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
497 Sets the number of items that will be scanned during one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
498 By default, <literal>purger_files</literal> is set to 10. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
499 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
500 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
501 <tag-name id="purger_threshold"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
502 <literal>purger_threshold</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
503 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
504 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
505 Sets the duration of one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
506 By default, <literal>purger_threshold</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
507 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
508 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
509 <tag-name id="purger_sleep"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
510 <literal>purger_sleep</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
511 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
512 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
513 Sets a pause between iterations (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
514 By default, <literal>purger_sleep</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
515 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
516 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
517 </list> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
518 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
519 |
1973
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
520 <para> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
521 <note> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
522 In versions 1.7.3, 1.7.7, and 1.11.10 cache header format has been changed. |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
523 Previously cached responses will be considered invalid |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
524 after upgrading to a newer nginx version. |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
525 </note> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
526 </para> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
527 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
528 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
529 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
530 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
531 <directive name="uwsgi_cache_purge"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
532 <syntax>string ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
533 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
534 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
535 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
536 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
537 <appeared-in>1.5.7</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
538 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
539 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
540 Defines conditions under which the request will be considered a cache |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
541 purge request. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
542 If at least one value of the string parameters is not empty and is not equal |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
543 to “0” then the cache entry with a corresponding |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
544 <link id="uwsgi_cache_key">cache key</link> is removed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
545 The result of successful operation is indicated by returning |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
546 the <http-status code="204" text="No Content"/> response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
547 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
548 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
549 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
550 If the <link id="uwsgi_cache_key">cache key</link> of a purge request ends |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
551 with an asterisk (“<literal>*</literal>”), all cache entries matching the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
552 wildcard key will be removed from the cache. |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
553 However, these entries will remain on the disk until they are deleted |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
554 for either <link id="uwsgi_cache_path">inactivity</link>, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
555 or processed by the <link id="purger">cache purger</link> (1.7.12), |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
556 or a client attempts to access them. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
557 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
558 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
559 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
560 Example configuration: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
561 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
562 uwsgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
563 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
564 map $request_method $purge_method { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
565 PURGE 1; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
566 default 0; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
567 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
568 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
569 server { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
570 ... |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
571 location / { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
572 uwsgi_pass backend; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
573 uwsgi_cache cache_zone; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
574 uwsgi_cache_key $uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
575 uwsgi_cache_purge $purge_method; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
576 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
577 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
578 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
579 <note> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
580 This functionality is available as part of our |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
581 <commercial_version>commercial subscription</commercial_version>. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
582 </note> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
583 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
584 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
585 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
586 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
587 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
588 <directive name="uwsgi_cache_revalidate"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
589 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
590 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
591 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
592 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
593 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
594 <appeared-in>1.5.7</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
595 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
596 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
597 Enables revalidation of expired cache items using conditional requests with |
1246
5be7716a5684
Documented If-None-Match in proxy_cache_revalidate and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1199
diff
changeset
|
598 the <header>If-Modified-Since</header> and <header>If-None-Match</header> |
5be7716a5684
Documented If-None-Match in proxy_cache_revalidate and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1199
diff
changeset
|
599 header fields. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
600 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
601 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
602 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
603 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
604 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
605 <directive name="uwsgi_cache_use_stale"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
606 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
607 <literal>error</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
608 <literal>timeout</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
609 <literal>invalid_header</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
610 <literal>updating</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
611 <literal>http_500</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
612 <literal>http_503</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
613 <literal>http_403</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
614 <literal>http_404</literal> | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
615 <literal>http_429</literal> | |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
616 <literal>off</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
617 ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
618 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
619 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
620 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
621 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
622 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
623 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
624 Determines in which cases a stale cached response can be used |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
625 when an error occurs during communication with the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
626 The directive’s parameters match the parameters of the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
627 <link id="uwsgi_next_upstream"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
628 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
629 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
630 <para> |
1542
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
631 The <literal>error</literal> parameter also permits |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
632 using a stale cached response if a uwsgi server to process a request |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
633 cannot be selected. |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
634 </para> |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
635 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
636 <para id="uwsgi_cache_use_stale_updating"> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
637 Additionally, the <literal>updating</literal> parameter permits |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
638 using a stale cached response if it is currently being updated. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
639 This allows minimizing the number of accesses to uwsgi servers |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
640 when updating cached data. |
1912
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
641 </para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
642 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
643 <para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
644 Using a stale cached response |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
645 can also be enabled directly in the response header |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
646 for a specified number of seconds after the response became stale (1.11.10). |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
647 This has lower priority than using the directive parameters. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
648 <list type="bullet" compact="no"> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
649 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
650 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
651 The |
1910
41cf2c2d8c5c
Cache: support for stale-while-revalidate and stale-if-error.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1909
diff
changeset
|
652 “<link url="https://tools.ietf.org/html/rfc5861#section-3">stale-while-revalidate</link>” |
1912
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
653 extension of the <header>Cache-Control</header> header field permits |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
654 using a stale cached response if it is currently being updated. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
655 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
656 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
657 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
658 The |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
659 “<link url="https://tools.ietf.org/html/rfc5861#section-4">stale-if-error</link>” |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
660 extension of the <header>Cache-Control</header> header field permits |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
661 using a stale cached response in case of an error. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
662 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
663 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
664 </list> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
665 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
666 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
667 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
668 To minimize the number of accesses to uwsgi servers when |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
669 populating a new cache element, the <link id="uwsgi_cache_lock"/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
670 directive can be used. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
671 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
672 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
673 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
674 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
675 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
676 <directive name="uwsgi_cache_valid"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
677 <syntax>[<value>code</value> ...] <value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
678 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
679 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
680 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
681 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
682 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
683 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
684 Sets caching time for different response codes. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
685 For example, the following directives |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
686 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
687 uwsgi_cache_valid 200 302 10m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
688 uwsgi_cache_valid 404 1m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
689 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
690 set 10 minutes of caching for responses with codes 200 and 302 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
691 and 1 minute for responses with code 404. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
692 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
693 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
694 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
695 If only caching <value>time</value> is specified |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
696 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
697 uwsgi_cache_valid 5m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
698 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
699 then only 200, 301, and 302 responses are cached. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
700 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
703 In addition, the <literal>any</literal> parameter can be specified |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
704 to cache any responses: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
705 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 uwsgi_cache_valid 200 302 10m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 uwsgi_cache_valid 301 1h; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
708 uwsgi_cache_valid any 1m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
709 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
711 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
712 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
713 Parameters of caching can also be set directly |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
714 in the response header. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
715 This has higher priority than setting of caching time using the directive. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
716 <list type="bullet" compact="no"> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
717 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
718 <listitem> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
719 The <header>X-Accel-Expires</header> header field sets caching time of a |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
720 response in seconds. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
721 The zero value disables caching for a response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
722 If the value starts with the <literal>@</literal> prefix, it sets an absolute |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
723 time in seconds since Epoch, up to which the response may be cached. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
724 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
725 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
726 <listitem> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
727 If the header does not include the <header>X-Accel-Expires</header> field, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
728 parameters of caching may be set in the header fields |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
729 <header>Expires</header> or <header>Cache-Control</header>. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
730 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
731 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
732 <listitem> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
733 If the header includes the <header>Set-Cookie</header> field, such a |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
734 response will not be cached. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
735 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
736 |
1353
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
737 <listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
738 If the header includes the <header>Vary</header> field |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
739 with the special value “<literal>*</literal>”, such a |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
740 response will not be cached (1.7.7). |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
741 If the header includes the <header>Vary</header> field |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
742 with another value, such a response will be cached |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
743 taking into account the corresponding request header fields (1.7.7). |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
744 </listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
745 |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
746 </list> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
747 Processing of one or more of these response header fields can be disabled |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
748 using the <link id="uwsgi_ignore_headers"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
749 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
750 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
751 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
752 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
753 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
754 <directive name="uwsgi_connect_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
755 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
756 <default>60s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
757 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
758 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
759 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
760 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
761 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
762 Defines a timeout for establishing a connection with a uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
763 It should be noted that this timeout cannot usually exceed 75 seconds. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
764 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
765 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
766 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
767 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
768 |
1337
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
769 <directive name="uwsgi_force_ranges"> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
770 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
771 <default>off</default> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
772 <context>http</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
773 <context>server</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
774 <context>location</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
775 <appeared-in>1.7.7</appeared-in> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
776 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
777 <para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
778 Enables byte-range support |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
779 for both cached and uncached responses from the uwsgi server |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
780 regardless of the <header>Accept-Ranges</header> field in these responses. |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
781 </para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
782 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
783 </directive> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
784 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
785 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
786 <directive name="uwsgi_hide_header"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
787 <syntax><value>field</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
788 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
789 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
790 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
791 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
792 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
793 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
794 By default, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
795 nginx does not pass the header fields <header>Status</header> and |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
796 <header>X-Accel-...</header> from the response of a uwsgi |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
797 server to a client. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
798 The <literal>uwsgi_hide_header</literal> directive sets additional fields |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
799 that will not be passed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
800 If, on the contrary, the passing of fields needs to be permitted, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
801 the <link id="uwsgi_pass_header"/> directive can be used. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
802 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
803 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
804 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
805 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
806 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
807 <directive name="uwsgi_ignore_client_abort"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
808 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
809 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
810 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
811 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
812 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
813 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
814 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
815 Determines whether the connection with a uwsgi server should be |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
816 closed when a client closes the connection without waiting |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
817 for a response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
818 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
819 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
820 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
821 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
822 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
823 <directive name="uwsgi_ignore_headers"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
824 <syntax><value>field</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
825 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
826 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
827 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
828 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
829 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
830 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
831 Disables processing of certain response header fields from the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
832 The following fields can be ignored: <header>X-Accel-Redirect</header>, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
833 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6), |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
834 <header>X-Accel-Buffering</header> (1.1.6), |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
835 <header>X-Accel-Charset</header> (1.1.6), <header>Expires</header>, |
1345
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
836 <header>Cache-Control</header>, <header>Set-Cookie</header> (0.8.44), |
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
837 and <header>Vary</header> (1.7.7). |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
838 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
839 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
840 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
841 If not disabled, processing of these header fields has the following |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
842 effect: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
843 <list type="bullet" compact="no"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
844 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
845 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
846 <header>X-Accel-Expires</header>, <header>Expires</header>, |
1345
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
847 <header>Cache-Control</header>, <header>Set-Cookie</header>, |
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
848 and <header>Vary</header> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
849 set the parameters of response <link id="uwsgi_cache_valid">caching</link>; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
850 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
851 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
852 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
853 <header>X-Accel-Redirect</header> performs an |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
854 <link doc="ngx_http_core_module.xml" id="internal">internal |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
855 redirect</link> to the specified URI; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
856 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
857 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
858 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
859 <header>X-Accel-Limit-Rate</header> sets the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
860 <link doc="ngx_http_core_module.xml" id="limit_rate">rate |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
861 limit</link> for transmission of a response to a client; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
862 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
863 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
864 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
865 <header>X-Accel-Buffering</header> enables or disables |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
866 <link id="uwsgi_buffering">buffering</link> of a response; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
867 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
868 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
869 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
870 <header>X-Accel-Charset</header> sets the desired |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
871 <link doc="ngx_http_charset_module.xml" id="charset"/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
872 of a response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
873 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
874 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
875 </list> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
876 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
877 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
878 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
879 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
880 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
881 <directive name="uwsgi_intercept_errors"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
882 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
883 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
884 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
885 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
886 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
887 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
888 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
889 Determines whether a uwsgi server responses with codes greater than or equal |
1803
621d0c682113
Clarified description of proxy_intercept_errors and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1796
diff
changeset
|
890 to 300 should be passed to a client |
621d0c682113
Clarified description of proxy_intercept_errors and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1796
diff
changeset
|
891 or be intercepted and redirected to nginx for processing |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
892 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
893 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
894 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
895 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
896 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
897 |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
898 <directive name="uwsgi_limit_rate"> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
899 <syntax><value>rate</value></syntax> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
900 <default>0</default> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
901 <context>http</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
902 <context>server</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
903 <context>location</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
904 <appeared-in>1.7.7</appeared-in> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
905 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
906 <para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
907 Limits the speed of reading the response from the uwsgi server. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
908 The <value>rate</value> is specified in bytes per second. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
909 The zero value disables rate limiting. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
910 The limit is set per a request, and so if nginx simultaneously opens |
1343
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
911 two connections to the uwsgi server, |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
912 the overall rate will be twice as much as the specified limit. |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
913 The limitation works only if |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
914 <link id="uwsgi_buffering">buffering</link> of responses from the uwsgi |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
915 server is enabled. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
916 </para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
917 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
918 </directive> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
919 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
920 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
921 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
922 <directive name="uwsgi_max_temp_file_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
923 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
924 <default>1024m</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
925 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
926 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
927 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
928 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
929 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
930 When <link id="uwsgi_buffering">buffering</link> of responses from the uwsgi |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
931 server is enabled, and the whole response does not fit into the buffers |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
932 set by the <link id="uwsgi_buffer_size"/> and <link id="uwsgi_buffers"/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
933 directives, a part of the response can be saved to a temporary file. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
934 This directive sets the maximum <value>size</value> of the temporary file. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
935 The size of data written to the temporary file at a time is set |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
936 by the <link id="uwsgi_temp_file_write_size"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
937 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
938 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
939 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
940 The zero value disables buffering of responses to temporary files. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
941 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
942 |
1352
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
943 <para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
944 <note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
945 This restriction does not apply to responses |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
946 that will be <link id="uwsgi_cache">cached</link> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
947 or <link id="uwsgi_store">stored</link> on disk. |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
948 </note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
949 </para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
950 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
951 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
952 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
953 |
1199
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
954 <directive name="uwsgi_modifier1"> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
955 <syntax><value>number</value></syntax> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
956 <default>0</default> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
957 <context>http</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
958 <context>server</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
959 <context>location</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
960 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
961 <para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
962 Sets the value of the <literal>modifier1</literal> field in the |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
963 <link url="http://uwsgi-docs.readthedocs.org/en/latest/Protocol.html#uwsgi-packet-header">uwsgi |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
964 packet header</link>. |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
965 </para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
966 </directive> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
967 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
968 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
969 <directive name="uwsgi_modifier2"> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
970 <syntax><value>number</value></syntax> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
971 <default>0</default> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
972 <context>http</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
973 <context>server</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
974 <context>location</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
975 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
976 <para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
977 Sets the value of the <literal>modifier2</literal> field in the |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
978 <link url="http://uwsgi-docs.readthedocs.org/en/latest/Protocol.html#uwsgi-packet-header">uwsgi |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
979 packet header</link>. |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
980 </para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
981 </directive> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
982 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
983 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
984 <directive name="uwsgi_next_upstream"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
985 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
986 <literal>error</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
987 <literal>timeout</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
988 <literal>invalid_header</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
989 <literal>http_500</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
990 <literal>http_503</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
991 <literal>http_403</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
992 <literal>http_404</literal> | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
993 <literal>http_429</literal> | |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
994 <literal>non_idempotent</literal> | |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
995 <literal>off</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
996 ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
997 <default>error timeout</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
998 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
999 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1000 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1001 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1002 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1003 Specifies in which cases a request should be passed to the next server: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1004 <list type="tag"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1005 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1006 <tag-name><literal>error</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1007 <tag-desc>an error occurred while establishing a connection with the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1008 server, passing a request to it, or reading the response header;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1009 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1010 <tag-name><literal>timeout</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1011 <tag-desc>a timeout has occurred while establishing a connection with the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1012 server, passing a request to it, or reading the response header;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1013 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1014 <tag-name><literal>invalid_header</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1015 <tag-desc>a server returned an empty or invalid response;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1016 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1017 <tag-name><literal>http_500</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1018 <tag-desc>a server returned a response with the code 500;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1019 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1020 <tag-name><literal>http_503</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1021 <tag-desc>a server returned a response with the code 503;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1022 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1023 <tag-name><literal>http_403</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1024 <tag-desc>a server returned a response with the code 403;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1025 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1026 <tag-name><literal>http_404</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1027 <tag-desc>a server returned a response with the code 404;</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1028 |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1029 <tag-name><literal>http_429</literal></tag-name> |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1030 <tag-desc>a server returned a response with the code 429 (1.11.13);</tag-desc> |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1031 |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1032 <tag-name id="non_idempotent"><literal>non_idempotent</literal></tag-name> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1033 <tag-desc>normally, requests with a |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
1034 <link url="https://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link> |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1035 method |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1036 (<literal>POST</literal>, <literal>LOCK</literal>, <literal>PATCH</literal>) |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1037 are not passed to the next server |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1038 if a request has been sent to an upstream server (1.9.13); |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1039 enabling this option explicitly allows retrying such requests; |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1040 </tag-desc> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1041 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1042 <tag-name><literal>off</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1043 <tag-desc>disables passing a request to the next server.</tag-desc> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1044 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1045 </list> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1046 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1047 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1048 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1049 One should bear in mind that passing a request to the next server is |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1050 only possible if nothing has been sent to a client yet. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1051 That is, if an error or timeout occurs in the middle of the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1052 transferring of a response, fixing this is impossible. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1053 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1054 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1055 <para> |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1056 The directive also defines what is considered an |
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1057 <link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful |
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1058 attempt</link> of communication with a server. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1059 The cases of <literal>error</literal>, <literal>timeout</literal> and |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1060 <literal>invalid_header</literal> are always considered unsuccessful attempts, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1061 even if they are not specified in the directive. |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1062 The cases of <literal>http_500</literal>, <literal>http_503</literal>, |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1063 and <literal>http_429</literal> are |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1064 considered unsuccessful attempts only if they are specified in the directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1065 The cases of <literal>http_403</literal> and <literal>http_404</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1066 are never considered unsuccessful attempts. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1067 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1068 |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1069 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1070 Passing a request to the next server can be limited by |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1071 <link id="uwsgi_next_upstream_tries">the number of tries</link> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1072 and by <link id="uwsgi_next_upstream_timeout">time</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1073 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1074 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1075 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1076 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1077 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1078 <directive name="uwsgi_next_upstream_timeout"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1079 <syntax><value>time</value></syntax> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1080 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1081 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1082 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1083 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1084 <appeared-in>1.7.5</appeared-in> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1085 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1086 <para> |
1672
9c98c4498f08
Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1669
diff
changeset
|
1087 Limits the time during which a request can be passed to the |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1088 <link id="uwsgi_next_upstream">next server</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1089 The <literal>0</literal> value turns off this limitation. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1090 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1091 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1092 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1093 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1094 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1095 <directive name="uwsgi_next_upstream_tries"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1096 <syntax><value>number</value></syntax> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1097 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1098 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1099 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1100 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1101 <appeared-in>1.7.5</appeared-in> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1102 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1103 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1104 Limits the number of possible tries for passing a request to the |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1105 <link id="uwsgi_next_upstream">next server</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1106 The <literal>0</literal> value turns off this limitation. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1107 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1108 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1109 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1110 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1111 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1112 <directive name="uwsgi_no_cache"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1113 <syntax><value>string</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1114 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1115 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1116 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1117 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1118 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1119 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1120 Defines conditions under which the response will not be saved to a cache. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1121 If at least one value of the string parameters is not empty and is not |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1122 equal to “0” then the response will not be saved: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1123 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1124 uwsgi_no_cache $cookie_nocache $arg_nocache$arg_comment; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1125 uwsgi_no_cache $http_pragma $http_authorization; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1126 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1127 Can be used along with the <link id="uwsgi_cache_bypass"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1128 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1129 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1130 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1131 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1132 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1133 <directive name="uwsgi_param"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1134 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1135 <value>parameter</value> <value>value</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1136 [<literal>if_not_empty</literal>]</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1137 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1138 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1139 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1140 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1141 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1142 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1143 Sets a <value>parameter</value> that should be passed to the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1144 The <value>value</value> can contain text, variables, and their combination. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1145 These directives are inherited from the previous level if and |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1146 only if there are no |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1147 <literal>uwsgi_param</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1148 directives defined on the current level. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1149 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1150 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1151 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1152 Standard |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
1153 <link url="https://tools.ietf.org/html/rfc3875#section-4.1">CGI |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1154 environment variables</link> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1155 should be provided as uwsgi headers, see the <path>uwsgi_params</path> file |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1156 provided in the distribution: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1157 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1158 location / { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1159 include uwsgi_params; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1160 ... |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1161 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1162 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1163 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1164 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1165 <para> |
1731
ae6bdb65ca7f
Corrected article in fastcgi_param and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
1166 If the directive is specified with <literal>if_not_empty</literal> (1.1.11) then |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1167 such a parameter will not be passed to the server until its value is not empty: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1168 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1169 uwsgi_param HTTPS $https if_not_empty; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1170 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1171 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1172 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1173 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1174 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1175 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1176 <directive name="uwsgi_pass"> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1177 <syntax>[<value>protocol</value>://]<value>address</value></syntax> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1178 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1179 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1180 <context>if in location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1181 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1182 <para> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1183 Sets the protocol and address of a uwsgi server. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1184 As a <value>protocol</value>, |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1185 “<literal>uwsgi</literal>” or “<literal>suwsgi</literal>” |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1186 (secured uwsgi, uwsgi over SSL) can be specified. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1187 The address can be specified as a domain name or IP address, |
1620
a225fa77389a
Port in fastcgi_pass, scgi_pass, and uwsgi_pass is not optional.
Ruslan Ermilov <ru@nginx.com>
parents:
1582
diff
changeset
|
1188 and a port: |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1189 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1190 uwsgi_pass localhost:9000; |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1191 uwsgi_pass uwsgi://localhost:9000; |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1192 uwsgi_pass suwsgi://[2001:db8::1]:9090; |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1193 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1194 or as a UNIX-domain socket path: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1195 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1196 uwsgi_pass unix:/tmp/uwsgi.socket; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1197 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1198 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1199 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1200 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1201 If a domain name resolves to several addresses, all of them will be |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1202 used in a round-robin fashion. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1203 In addition, an address can be specified as a |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1204 <link doc="ngx_http_upstream_module.xml">server group</link>. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1205 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1206 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1207 <para> |
1991
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1208 Parameter value can contain variables. |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1209 In this case, if an address is specified as a domain name, |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1210 the name is searched among the described |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1211 <link doc="ngx_http_upstream_module.xml">server groups</link>, |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1212 and, if not found, is determined using a |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1213 <link doc="ngx_http_core_module.xml" id="resolver"/>. |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1214 </para> |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1215 |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1216 <para> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1217 <note> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1218 Secured uwsgi protocol is supported since version 1.5.8. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1219 </note> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1220 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1221 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1222 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1223 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1224 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1225 <directive name="uwsgi_pass_header"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1226 <syntax><value>field</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1227 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1228 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1229 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1230 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1231 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1232 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1233 Permits passing <link id="uwsgi_hide_header">otherwise disabled</link> header |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1234 fields from a uwsgi server to a client. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1235 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1236 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1237 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1238 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1239 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1240 <directive name="uwsgi_pass_request_body"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1241 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1242 <default>on</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1243 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1244 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1245 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1246 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1247 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1248 Indicates whether the original request body is passed |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1249 to the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1250 See also the <link id="uwsgi_pass_request_headers"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1251 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1252 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1253 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1254 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1255 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1256 <directive name="uwsgi_pass_request_headers"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1257 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1258 <default>on</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1259 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1260 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1261 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1262 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1263 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1264 Indicates whether the header fields of the original request are passed |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1265 to the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1266 See also the <link id="uwsgi_pass_request_body"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1267 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1268 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1269 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1270 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1271 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1272 <directive name="uwsgi_read_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1273 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1274 <default>60s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1275 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1276 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1277 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1278 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1279 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1280 Defines a timeout for reading a response from the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1281 The timeout is set only between two successive read operations, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1282 not for the transmission of the whole response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1283 If the uwsgi server does not transmit anything within this time, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1284 the connection is closed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1285 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1286 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1287 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1288 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1289 |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1290 <directive name="uwsgi_request_buffering"> |
1659
680cbf783efe
Fixed some misuses of "value".
Ruslan Ermilov <ru@nginx.com>
parents:
1620
diff
changeset
|
1291 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1292 <default>on</default> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1293 <context>http</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1294 <context>server</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1295 <context>location</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1296 <appeared-in>1.7.11</appeared-in> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1297 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1298 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1299 Enables or disables buffering of a client request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1300 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1301 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1302 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1303 When buffering is enabled, the entire request body is |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1304 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">read</link> |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1305 from the client before sending the request to a uwsgi server. |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1306 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1307 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1308 <para> |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1309 When buffering is disabled, the request body is sent to the uwsgi server |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1310 immediately as it is received. |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1311 In this case, the request cannot be passed to the |
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1312 <link id="uwsgi_next_upstream">next server</link> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1313 if nginx already started sending the request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1314 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1315 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1316 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1317 When HTTP/1.1 chunked transfer encoding is used |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1318 to send the original request body, |
1443
a55553729d63
Unified text of scgi and uwsgi request buffering with proxy.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1319 the request body will be buffered regardless of the directive value. |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1320 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1321 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1322 </directive> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1323 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1324 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1325 <directive name="uwsgi_send_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1326 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1327 <default>60s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1328 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1329 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1330 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1331 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1332 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1333 Sets a timeout for transmitting a request to the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1334 The timeout is set only between two successive write operations, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1335 not for the transmission of the whole request. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1336 If the uwsgi server does not receive anything within this time, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1337 the connection is closed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1338 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1339 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1340 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1341 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1342 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1343 <directive name="uwsgi_ssl_certificate"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1344 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1345 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1346 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1347 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1348 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1349 <appeared-in>1.7.8</appeared-in> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1350 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1351 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1352 Specifies a <value>file</value> with the certificate in the PEM format |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1353 used for authentication to a secured uwsgi server. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1354 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1355 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1356 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1357 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1358 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1359 <directive name="uwsgi_ssl_certificate_key"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1360 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1361 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1362 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1363 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1364 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1365 <appeared-in>1.7.8</appeared-in> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1366 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1367 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1368 Specifies a <value>file</value> with the secret key in the PEM format |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1369 used for authentication to a secured uwsgi server. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1370 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1371 |
1456
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1372 <para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1373 The value |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1374 <literal>engine</literal>:<value>name</value>:<value>id</value> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1375 can be specified instead of the <value>file</value> (1.7.9), |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1376 which loads a secret key with a specified <value>id</value> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1377 from the OpenSSL engine <value>name</value>. |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1378 </para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1379 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1380 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1381 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1382 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1383 <directive name="uwsgi_ssl_ciphers"> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1384 <syntax><value>ciphers</value></syntax> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1385 <default>DEFAULT</default> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1386 <context>http</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1387 <context>server</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1388 <context>location</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1389 <appeared-in>1.5.8</appeared-in> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1390 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1391 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1392 Specifies the enabled ciphers for requests to a secured uwsgi server. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1393 The ciphers are specified in the format understood by the OpenSSL library. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1394 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1395 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1396 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1397 The full list can be viewed using the |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1398 “<command>openssl ciphers</command>” command. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1399 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1400 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1401 </directive> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1402 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1403 |
1193
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1404 <directive name="uwsgi_ssl_crl"> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1405 <syntax><value>file</value></syntax> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1406 <default/> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1407 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1408 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1409 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1410 <appeared-in>1.7.0</appeared-in> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1411 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1412 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1413 Specifies a <value>file</value> with revoked certificates (CRL) |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1414 in the PEM format used to <link id="uwsgi_ssl_verify">verify</link> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1415 the certificate of the secured uwsgi server. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1416 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1417 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1418 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1419 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1420 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1421 <directive name="uwsgi_ssl_name"> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1422 <syntax><value>name</value></syntax> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1423 <default>host from uwsgi_pass</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1424 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1425 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1426 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1427 <appeared-in>1.7.0</appeared-in> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1428 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1429 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1430 Allows overriding the server name used to |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1431 <link id="uwsgi_ssl_verify">verify</link> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1432 the certificate of the secured uwsgi server and to be |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1433 <link id="uwsgi_ssl_server_name">passed through SNI</link> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1434 when establishing a connection with the secured uwsgi server. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1435 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1436 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1437 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1438 By default, the host part from <link id="uwsgi_pass"/> is used. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1439 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1440 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1441 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1442 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1443 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1444 <directive name="uwsgi_ssl_password_file"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1445 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1446 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1447 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1448 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1449 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1450 <appeared-in>1.7.8</appeared-in> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1451 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1452 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1453 Specifies a <value>file</value> with passphrases for |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1454 <link id="uwsgi_ssl_certificate_key">secret keys</link> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1455 where each passphrase is specified on a separate line. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1456 Passphrases are tried in turn when loading the key. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1457 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1458 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1459 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1460 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1461 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1462 <directive name="uwsgi_ssl_protocols"> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1463 <syntax> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1464 [<literal>SSLv2</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1465 [<literal>SSLv3</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1466 [<literal>TLSv1</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1467 [<literal>TLSv1.1</literal>] |
1978
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1973
diff
changeset
|
1468 [<literal>TLSv1.2</literal>] |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1973
diff
changeset
|
1469 [<literal>TLSv1.3</literal>]</syntax> |
1499
3687cc9a3592
Removed SSLv3 from the default value of ssl_protocols and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1456
diff
changeset
|
1470 <default>TLSv1 TLSv1.1 TLSv1.2</default> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1471 <context>http</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1472 <context>server</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1473 <context>location</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1474 <appeared-in>1.5.8</appeared-in> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1475 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1476 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1477 Enables the specified protocols for requests to a secured uwsgi server. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1478 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1479 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1480 </directive> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1481 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1482 |
1193
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1483 <directive name="uwsgi_ssl_server_name"> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1484 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1485 <default>off</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1486 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1487 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1488 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1489 <appeared-in>1.7.0</appeared-in> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1490 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1491 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1492 Enables or disables passing of the server name through |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1493 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1494 Server Name Indication extension</link> (SNI, RFC 6066) |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1495 when establishing a connection with the secured uwsgi server. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1496 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1497 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1498 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1499 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1500 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1501 <directive name="uwsgi_ssl_session_reuse"> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1502 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1503 <default>on</default> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1504 <context>http</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1505 <context>server</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1506 <context>location</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1507 <appeared-in>1.5.8</appeared-in> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1508 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1509 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1510 Determines whether SSL sessions can be reused when working with |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1511 a secured uwsgi server. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1512 If the errors |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1513 “<literal>SSL3_GET_FINISHED:digest check failed</literal>” |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1514 appear in the logs, try disabling session reuse. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1515 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1516 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1517 </directive> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1518 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1519 |
1193
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1520 <directive name="uwsgi_ssl_trusted_certificate"> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1521 <syntax><value>file</value></syntax> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1522 <default/> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1523 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1524 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1525 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1526 <appeared-in>1.7.0</appeared-in> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1527 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1528 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1529 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1530 used to <link id="uwsgi_ssl_verify">verify</link> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1531 the certificate of the secured uwsgi server. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1532 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1533 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1534 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1535 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1536 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1537 <directive name="uwsgi_ssl_verify"> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1538 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1539 <default>off</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1540 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1541 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1542 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1543 <appeared-in>1.7.0</appeared-in> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1544 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1545 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1546 Enables or disables verification of the secured uwsgi server certificate. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1547 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1548 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1549 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1550 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1551 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1552 <directive name="uwsgi_ssl_verify_depth"> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1553 <syntax><value>number</value></syntax> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1554 <default>1</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1555 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1556 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1557 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1558 <appeared-in>1.7.0</appeared-in> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1559 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1560 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1561 Sets the verification depth in the secured uwsgi server certificates chain. |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1562 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1563 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1564 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1565 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1566 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1567 <directive name="uwsgi_store"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1568 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1569 <literal>on</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1570 <literal>off</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1571 <value>string</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1572 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1573 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1574 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1575 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1576 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1577 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1578 Enables saving of files to a disk. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1579 The <literal>on</literal> parameter saves files with paths |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1580 corresponding to the directives |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1581 <link doc="ngx_http_core_module.xml" id="alias"/> or |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1582 <link doc="ngx_http_core_module.xml" id="root"/>. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1583 The <literal>off</literal> parameter disables saving of files. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1584 In addition, the file name can be set explicitly using the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1585 <value>string</value> with variables: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1586 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1587 uwsgi_store /data/www$original_uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1588 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1589 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1590 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1591 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1592 The modification time of files is set according to the received |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1593 <header>Last-Modified</header> response header field. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1594 The response is first written to a temporary file, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1595 and then the file is renamed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1596 Starting from version 0.8.9, temporary files and the persistent store |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1597 can be put on different file systems. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1598 However, be aware that in this case a file is copied |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1599 across two file systems instead of the cheap renaming operation. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1600 It is thus recommended that for any given location both saved files and a |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1601 directory holding temporary files, set by the <link id="uwsgi_temp_path"/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1602 directive, are put on the same file system. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1603 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1604 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1605 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1606 This directive can be used to create local copies of static unchangeable |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1607 files, e.g.: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1608 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1609 location /images/ { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1610 root /data/www; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1611 error_page 404 = /fetch$uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1612 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1613 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1614 location /fetch/ { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1615 internal; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1616 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1617 uwsgi_pass backend:9000; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1618 ... |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1619 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1620 uwsgi_store on; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1621 uwsgi_store_access user:rw group:rw all:r; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1622 uwsgi_temp_path /data/temp; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1623 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1624 alias /data/www/; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1625 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1626 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1627 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1628 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1629 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1630 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1631 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1632 <directive name="uwsgi_store_access"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1633 <syntax><value>users</value>:<value>permissions</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1634 <default>user:rw</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1635 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1636 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1637 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1638 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1639 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1640 Sets access permissions for newly created files and directories, e.g.: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1641 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1642 uwsgi_store_access user:rw group:rw all:r; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1643 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1644 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1645 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1646 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1647 If any <literal>group</literal> or <literal>all</literal> access permissions |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1648 are specified then <literal>user</literal> permissions may be omitted: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1649 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1650 uwsgi_store_access group:rw all:r; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1651 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1652 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1653 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1654 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1655 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1656 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1657 <directive name="uwsgi_temp_file_write_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1658 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1659 <default>8k|16k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1660 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1661 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1662 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1663 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1664 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1665 Limits the <value>size</value> of data written to a temporary file |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1666 at a time, when buffering of responses from the uwsgi server |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1667 to temporary files is enabled. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1668 By default, <value>size</value> is limited by two buffers set by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1669 <link id="uwsgi_buffer_size"/> and <link id="uwsgi_buffers"/> directives. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1670 The maximum size of a temporary file is set by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1671 <link id="uwsgi_max_temp_file_size"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1672 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1673 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1674 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1675 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1676 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1677 <directive name="uwsgi_temp_path"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1678 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1679 <value>path</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1680 [<value>level1</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1681 [<value>level2</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1682 [<value>level3</value>]]]</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1683 <default>uwsgi_temp</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1684 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1685 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1686 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1687 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1688 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1689 Defines a directory for storing temporary files |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1690 with data received from uwsgi servers. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1691 Up to three-level subdirectory hierarchy can be used underneath the specified |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1692 directory. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1693 For example, in the following configuration |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1694 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1695 uwsgi_temp_path /spool/nginx/uwsgi_temp 1 2; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1696 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1697 a temporary file might look like this: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1698 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1699 /spool/nginx/uwsgi_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1700 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1701 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1702 |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1703 <para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1704 See also the <literal>use_temp_path</literal> parameter of the |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1705 <link id="uwsgi_cache_path"/> directive. |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1706 </para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1707 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1708 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1709 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1710 </section> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1711 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1712 </module> |