Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_uwsgi_module.xml @ 1758:2e0d07952c8f
Documented variables support for proxy_pass in stream.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 02 Aug 2016 21:58:31 +0300 |
parents | be371be7a5c8 |
children | 1d576e8d6ead |
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" |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
13 rev="27"> |
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"> |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
42 <syntax><value>address</value> [transparent] | <literal>off</literal></syntax> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 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
|
50 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
|
51 Parameter value can contain variables (1.3.12). |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 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
|
53 of the <literal>uwsgi_bind</literal> directive |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 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
|
55 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
|
56 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
58 <para id="uwsgi_bind_transparent"> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
59 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
|
60 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
|
61 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
|
62 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
|
63 <example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
64 uwsgi_bind $remote_addr transparent; |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
65 </example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
66 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
|
67 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
|
68 <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
|
69 and configure kernel routing table |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
70 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
|
71 </para> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
72 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 <directive name="uwsgi_buffer_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 <default>4k|8k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 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
|
85 of the response received from the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 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
|
87 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
|
88 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
|
89 It can be made smaller, however. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 |
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 name="uwsgi_buffering"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <default>on</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 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
|
104 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 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
|
108 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
|
109 <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
|
110 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
|
111 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
|
112 Writing to temporary files is controlled by the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 <link id="uwsgi_max_temp_file_size"/> and |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <link id="uwsgi_temp_file_write_size"/> directives. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 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
|
119 immediately as it is received. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 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
|
121 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
|
122 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
|
123 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
126 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
|
127 “<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
|
128 <header>X-Accel-Buffering</header> response header field. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 This capability can be disabled using the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 <link id="uwsgi_ignore_headers"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 |
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 name="uwsgi_buffers"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 <syntax><value>number</value> <value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 <default>8 4k|8k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 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
|
145 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
|
146 for a single connection. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 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
|
148 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
|
149 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 |
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 name="uwsgi_busy_buffers_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 <default>8k|16k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 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
|
163 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
|
164 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
|
165 yet fully read. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 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
|
167 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
|
168 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
|
169 <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
|
170 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 |
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 name="uwsgi_cache"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 <syntax><value>zone</value> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 Defines a shared memory zone used for caching. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 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
|
185 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
|
186 The <literal>off</literal> parameter disables caching inherited |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 from the previous configuration level. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 |
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 name="uwsgi_cache_bypass"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 <syntax><value>string</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 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
|
202 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
|
203 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
|
204 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 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
|
206 uwsgi_cache_bypass $http_pragma $http_authorization; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 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
|
209 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 <directive name="uwsgi_cache_key"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 <syntax><value>string</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 Defines a key for caching, for example |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 uwsgi_cache_key localhost:9000$request_uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 <directive name="uwsgi_cache_lock"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 <appeared-in>1.1.12</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 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
|
241 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
|
242 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
|
243 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
|
244 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
|
245 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
|
246 <link id="uwsgi_cache_lock_timeout"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 </directive> |
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 |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
252 <directive name="uwsgi_cache_lock_age"> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
253 <syntax><value>time</value></syntax> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
254 <default>5s</default> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
255 <context>http</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
256 <context>server</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
257 <context>location</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
258 <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
|
259 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
260 <para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
261 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
|
262 for populating a new cache element |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
263 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
|
264 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
|
265 </para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
266 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
267 </directive> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
268 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
269 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 <directive name="uwsgi_cache_lock_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 <default>5s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 <appeared-in>1.1.12</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 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
|
280 When the <value>time</value> expires, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
281 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
|
282 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
|
283 <note> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1372
diff
changeset
|
284 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
|
285 </note> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 <directive name="uwsgi_cache_methods"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 <literal>GET</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 <literal>HEAD</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 <literal>POST</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 <default>GET HEAD</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
302 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 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
|
304 the response will be cached. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
305 “<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
|
306 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
|
307 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
|
308 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 |
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 <directive name="uwsgi_cache_min_uses"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 <syntax><value>number</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 <default>1</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
316 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
317 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
318 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
319 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
320 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 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
|
322 will be cached. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
325 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
326 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
327 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
328 <directive name="uwsgi_cache_path"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
329 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 <value>path</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 [<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
|
332 [<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
|
333 <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
|
334 [<literal>inactive</literal>=<value>time</value>] |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 [<literal>max_size</literal>=<value>size</value>] |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 [<literal>loader_files</literal>=<value>number</value>] |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
337 [<literal>loader_sleep</literal>=<value>time</value>] |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
338 [<literal>loader_threshold</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
339 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
340 [<literal>purger_files</literal>=<value>number</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
341 [<literal>purger_sleep</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
342 [<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
|
343 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
344 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 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
|
348 Cache data are stored in files. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 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
|
350 applying the MD5 function to the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
351 <link id="uwsgi_cache_key">cache key</link>. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 The <literal>levels</literal> parameter defines hierarchy levels of a cache. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 For example, in the following configuration |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 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
|
356 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 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
|
358 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 /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
|
360 </example> |
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 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 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
|
365 and then the file is renamed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 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
|
367 different file systems. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 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
|
369 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
|
370 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
|
371 holding temporary files |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 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
|
373 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
|
374 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
|
375 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
|
376 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
|
377 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
|
378 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
|
379 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
|
380 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 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
|
384 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
|
385 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
|
386 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
|
387 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
389 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
390 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
|
391 <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
|
392 regardless of their freshness. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
393 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
|
394 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
396 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
397 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
|
398 by the <literal>max_size</literal> parameter. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
399 When this size is exceeded, it removes the least recently used data. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
400 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
401 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
402 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
403 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
|
404 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
|
405 into a cache zone. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 The loading is done in iterations. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 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
|
408 are loaded (by default, 100). |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
409 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
|
410 <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
|
411 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
|
412 parameter (by default, 50 milliseconds) is made. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
415 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
416 Additionally, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
417 the following parameters are available as part of our |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
418 <commercial_version>commercial subscription</commercial_version>: |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
419 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
420 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
421 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
422 <list type="tag"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
423 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
424 <tag-name id="purger"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
425 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
426 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
427 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
428 Instructs whether cache entries that match a |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
429 <link id="uwsgi_cache_purge">wildcard key</link> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
430 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
|
431 Setting the parameter to <literal>on</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
432 (default is <literal>off</literal>) |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
433 will activate the “cache purger” process that |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
434 permanently iterates through all cache entries |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
435 and deletes the entries that match the wildcard key. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
436 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
437 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
438 <tag-name id="purger_files"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
439 <literal>purger_files</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
440 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
441 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
442 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
|
443 By default, <literal>purger_files</literal> is set to 10. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
444 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
445 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
446 <tag-name id="purger_threshold"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
447 <literal>purger_threshold</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
448 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
449 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
450 Sets the duration of one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
451 By default, <literal>purger_threshold</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
452 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
453 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
454 <tag-name id="purger_sleep"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
455 <literal>purger_sleep</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
456 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
457 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
458 Sets a pause between iterations (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
459 By default, <literal>purger_sleep</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
460 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
461 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
462 </list> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
463 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
464 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
465 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
466 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
467 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
468 <directive name="uwsgi_cache_purge"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
469 <syntax>string ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
470 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
471 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
472 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
473 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
474 <appeared-in>1.5.7</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
475 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
476 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
477 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
|
478 purge request. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
479 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
|
480 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
|
481 <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
|
482 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
|
483 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
|
484 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
485 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
486 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
487 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
|
488 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
|
489 wildcard key will be removed from the cache. |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
490 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
|
491 for either <link id="uwsgi_cache_path">inactivity</link>, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
492 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
|
493 or a client attempts to access them. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
494 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
495 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
496 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
497 Example configuration: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
498 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
499 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
|
500 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
501 map $request_method $purge_method { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
502 PURGE 1; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
503 default 0; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
504 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
505 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
506 server { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
507 ... |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
508 location / { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
509 uwsgi_pass backend; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
510 uwsgi_cache cache_zone; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
511 uwsgi_cache_key $uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
512 uwsgi_cache_purge $purge_method; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
513 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
514 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
515 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
516 <note> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
517 This functionality is available as part of our |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
518 <commercial_version>commercial subscription</commercial_version>. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
519 </note> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
520 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
521 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
522 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
523 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
524 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
525 <directive name="uwsgi_cache_revalidate"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
526 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
527 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
528 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
529 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
530 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
531 <appeared-in>1.5.7</appeared-in> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
532 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
533 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
534 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
|
535 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
|
536 header fields. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
537 </para> |
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 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
540 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
541 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
542 <directive name="uwsgi_cache_use_stale"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
543 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
544 <literal>error</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
545 <literal>timeout</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
546 <literal>invalid_header</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
547 <literal>updating</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
548 <literal>http_500</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
549 <literal>http_503</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
550 <literal>http_403</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
551 <literal>http_404</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
552 <literal>off</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
553 ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
554 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
555 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
556 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
557 <context>location</context> |
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 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
|
561 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
|
562 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
|
563 <link id="uwsgi_next_upstream"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
564 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
565 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
566 <para> |
1542
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
567 The <literal>error</literal> parameter also permits |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
568 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
|
569 cannot be selected. |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
570 </para> |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
571 |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1499
diff
changeset
|
572 <para> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
573 Additionally, the <literal>updating</literal> parameter permits |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
574 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
|
575 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
|
576 when updating cached data. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
577 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
578 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
579 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
580 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
|
581 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
|
582 directive can be used. |
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_valid"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
589 <syntax>[<value>code</value> ...] <value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
590 <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 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
595 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
596 Sets caching time for different response codes. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
597 For example, the following directives |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
598 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
599 uwsgi_cache_valid 200 302 10m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
600 uwsgi_cache_valid 404 1m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
601 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
602 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
|
603 and 1 minute for responses with code 404. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
604 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
605 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
606 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
607 If only caching <value>time</value> is specified |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
608 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
609 uwsgi_cache_valid 5m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
610 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
611 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
|
612 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
613 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
614 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
615 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
|
616 to cache any responses: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
617 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
618 uwsgi_cache_valid 200 302 10m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
619 uwsgi_cache_valid 301 1h; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
620 uwsgi_cache_valid any 1m; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
621 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
622 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
623 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
624 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
625 Parameters of caching can also be set directly |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
626 in the response header. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
627 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
|
628 <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
|
629 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
630 <listitem> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
631 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
|
632 response in seconds. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
633 The zero value disables caching for a response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
634 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
|
635 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
|
636 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
637 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
638 <listitem> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
639 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
|
640 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
|
641 <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
|
642 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
643 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
644 <listitem> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
645 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
|
646 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
|
647 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
648 |
1353
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
649 <listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
650 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
|
651 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
|
652 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
|
653 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
|
654 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
|
655 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
|
656 </listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
657 |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
658 </list> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
659 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
|
660 using the <link id="uwsgi_ignore_headers"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
661 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
662 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
663 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
664 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
665 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
666 <directive name="uwsgi_connect_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
667 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
668 <default>60s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
669 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
670 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
671 <context>location</context> |
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 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
674 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
|
675 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
|
676 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
677 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
678 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
679 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
680 |
1337
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
681 <directive name="uwsgi_force_ranges"> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
682 <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
|
683 <default>off</default> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
684 <context>http</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
685 <context>server</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
686 <context>location</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
687 <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
|
688 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
689 <para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
690 Enables byte-range support |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
691 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
|
692 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
|
693 </para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
694 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
695 </directive> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
696 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
697 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
698 <directive name="uwsgi_hide_header"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
699 <syntax><value>field</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
700 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
703 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
704 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
705 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 By default, |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 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
|
708 <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
|
709 server to a client. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 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
|
711 that will not be passed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
712 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
|
713 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
|
714 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
715 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
716 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
717 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
718 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
719 <directive name="uwsgi_ignore_client_abort"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
720 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
721 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
722 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
723 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
724 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
725 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
726 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
727 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
|
728 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
|
729 for a response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
730 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
731 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
732 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
733 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
734 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
735 <directive name="uwsgi_ignore_headers"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
736 <syntax><value>field</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
737 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
738 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
739 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
740 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
741 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
742 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
743 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
|
744 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
|
745 <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
|
746 <header>X-Accel-Buffering</header> (1.1.6), |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
747 <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
|
748 <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
|
749 and <header>Vary</header> (1.7.7). |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
750 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
751 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
752 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
753 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
|
754 effect: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
755 <list type="bullet" compact="no"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
756 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
757 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
758 <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
|
759 <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
|
760 and <header>Vary</header> |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
761 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
|
762 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
763 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
764 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
765 <header>X-Accel-Redirect</header> performs an |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
766 <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
|
767 redirect</link> to the specified URI; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
768 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
769 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
770 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
771 <header>X-Accel-Limit-Rate</header> sets the |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
772 <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
|
773 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
|
774 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
775 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
776 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
777 <header>X-Accel-Buffering</header> enables or disables |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
778 <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
|
779 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
780 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
781 <listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
782 <header>X-Accel-Charset</header> sets the desired |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
783 <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
|
784 of a response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
785 </listitem> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
786 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
787 </list> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
788 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
789 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
790 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
791 |
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 <directive name="uwsgi_intercept_errors"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
794 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
795 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
796 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
797 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
798 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
799 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
800 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
801 Determines whether a uwsgi server responses with codes greater than or equal |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
802 to 300 should be passed to a client or be redirected to nginx for processing |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
803 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
|
804 </para> |
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 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
807 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
808 |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
809 <directive name="uwsgi_limit_rate"> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
810 <syntax><value>rate</value></syntax> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
811 <default>0</default> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
812 <context>http</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
813 <context>server</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
814 <context>location</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
815 <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
|
816 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
817 <para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
818 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
|
819 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
|
820 The zero value disables rate limiting. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
821 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
|
822 two connections to the uwsgi server, |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
823 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
|
824 The limitation works only if |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
825 <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
|
826 server is enabled. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
827 </para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
828 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
829 </directive> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
830 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
831 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
832 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
833 <directive name="uwsgi_max_temp_file_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
834 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
835 <default>1024m</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
836 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
837 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
838 <context>location</context> |
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 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
|
842 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
|
843 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
|
844 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
|
845 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
|
846 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
|
847 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
|
848 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
849 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
850 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
851 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
|
852 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
853 |
1352
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
854 <para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
855 <note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
856 This restriction does not apply to responses |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
857 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
|
858 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
|
859 </note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
860 </para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
861 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
862 </directive> |
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 |
1199
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
865 <directive name="uwsgi_modifier1"> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
866 <syntax><value>number</value></syntax> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
867 <default>0</default> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
868 <context>http</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
869 <context>server</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
870 <context>location</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
871 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
872 <para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
873 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
|
874 <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
|
875 packet header</link>. |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
876 </para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
877 </directive> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
878 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
879 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
880 <directive name="uwsgi_modifier2"> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
881 <syntax><value>number</value></syntax> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
882 <default>0</default> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
883 <context>http</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
884 <context>server</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
885 <context>location</context> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
886 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
887 <para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
888 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
|
889 <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
|
890 packet header</link>. |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
891 </para> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
892 </directive> |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
893 |
5ee8a00f2bc5
Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1193
diff
changeset
|
894 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
895 <directive name="uwsgi_next_upstream"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
896 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
897 <literal>error</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
898 <literal>timeout</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
899 <literal>invalid_header</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
900 <literal>http_500</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
901 <literal>http_503</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
902 <literal>http_403</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
903 <literal>http_404</literal> | |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
904 <literal>non_idempotent</literal> | |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
905 <literal>off</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
906 ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
907 <default>error timeout</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
908 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
909 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
910 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
911 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
912 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
913 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
|
914 <list type="tag"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
915 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
916 <tag-name><literal>error</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
917 <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
|
918 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
|
919 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
920 <tag-name><literal>timeout</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
921 <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
|
922 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
|
923 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
924 <tag-name><literal>invalid_header</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
925 <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
|
926 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
927 <tag-name><literal>http_500</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
928 <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
|
929 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
930 <tag-name><literal>http_503</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
931 <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
|
932 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
933 <tag-name><literal>http_403</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
934 <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
|
935 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
936 <tag-name><literal>http_404</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
937 <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
|
938 |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
939 <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
|
940 <tag-desc>normally, requests with a |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
941 <link url="http://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
942 method |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
943 (<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
|
944 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
|
945 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
|
946 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
|
947 </tag-desc> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
948 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
949 <tag-name><literal>off</literal></tag-name> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
950 <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
|
951 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
952 </list> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
953 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
954 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
955 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
956 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
|
957 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
|
958 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
|
959 transferring of a response, fixing this is impossible. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
960 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
961 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
962 <para> |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
963 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
|
964 <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
|
965 attempt</link> of communication with a server. |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
966 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
|
967 <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
|
968 even if they are not specified in the directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
969 The cases of <literal>http_500</literal> and <literal>http_503</literal> are |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
970 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
|
971 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
|
972 are never considered unsuccessful attempts. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
973 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
974 |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
975 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
976 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
|
977 <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
|
978 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
|
979 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
980 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
981 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
982 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
983 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
984 <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
|
985 <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
|
986 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
987 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
988 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
989 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
990 <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
|
991 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
992 <para> |
1672
9c98c4498f08
Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1669
diff
changeset
|
993 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
|
994 <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
|
995 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
|
996 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
997 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
998 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
999 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1000 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1001 <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
|
1002 <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
|
1003 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1004 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1005 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1006 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1007 <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
|
1008 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1009 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1010 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
|
1011 <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
|
1012 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
|
1013 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1014 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1015 </directive> |
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 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1018 <directive name="uwsgi_no_cache"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1019 <syntax><value>string</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1020 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1021 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1022 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1023 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1024 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1025 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1026 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
|
1027 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
|
1028 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
|
1029 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1030 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
|
1031 uwsgi_no_cache $http_pragma $http_authorization; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1032 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1033 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
|
1034 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1035 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1036 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1037 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1038 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1039 <directive name="uwsgi_param"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1040 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1041 <value>parameter</value> <value>value</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1042 [<literal>if_not_empty</literal>]</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1043 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1044 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1045 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1046 <context>location</context> |
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 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
|
1050 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
|
1051 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
|
1052 only if there are no |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1053 <literal>uwsgi_param</literal> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1054 directives defined on the current level. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1055 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1056 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1057 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1058 Standard |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1059 <link url="http://tools.ietf.org/html/rfc3875#section-4.1">CGI |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1060 environment variables</link> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1061 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
|
1062 provided in the distribution: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1063 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1064 location / { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1065 include uwsgi_params; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1066 ... |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1067 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1068 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1069 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1070 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1071 <para> |
1731
ae6bdb65ca7f
Corrected article in fastcgi_param and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
1072 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
|
1073 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
|
1074 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1075 uwsgi_param HTTPS $https if_not_empty; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1076 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1077 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1078 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1079 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1080 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1081 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1082 <directive name="uwsgi_pass"> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1083 <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
|
1084 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1085 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1086 <context>if in location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1087 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1088 <para> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1089 Sets the protocol and address of a uwsgi server. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1090 As a <value>protocol</value>, |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1091 “<literal>uwsgi</literal>” or “<literal>suwsgi</literal>” |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1092 (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
|
1093 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
|
1094 and a port: |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1095 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1096 uwsgi_pass localhost:9000; |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1097 uwsgi_pass uwsgi://localhost:9000; |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1098 uwsgi_pass suwsgi://[2001:db8::1]:9090; |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1099 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1100 or as a UNIX-domain socket path: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1101 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1102 uwsgi_pass unix:/tmp/uwsgi.socket; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1103 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1104 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1105 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1106 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1107 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
|
1108 used in a round-robin fashion. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1109 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
|
1110 <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
|
1111 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1112 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1113 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1114 <note> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1115 Secured uwsgi protocol is supported since version 1.5.8. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1116 </note> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1117 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1118 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1119 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1120 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1121 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1122 <directive name="uwsgi_pass_header"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1123 <syntax><value>field</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1124 <default/> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1125 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1126 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1127 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1128 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1129 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1130 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
|
1131 fields from a uwsgi server to a client. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1132 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1133 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1134 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1135 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1136 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1137 <directive name="uwsgi_pass_request_body"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1138 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1139 <default>on</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1140 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1141 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1142 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1143 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1144 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1145 Indicates whether the original request body is passed |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1146 to the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1147 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
|
1148 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1149 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1150 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1151 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1152 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1153 <directive name="uwsgi_pass_request_headers"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1154 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1155 <default>on</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1156 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1157 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1158 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1159 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1160 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1161 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
|
1162 to the uwsgi server. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1163 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
|
1164 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1165 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1166 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1167 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1168 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1169 <directive name="uwsgi_read_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1170 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1171 <default>60s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1172 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1173 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1174 <context>location</context> |
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 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1177 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
|
1178 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
|
1179 not for the transmission of the whole response. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1180 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
|
1181 the connection is closed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1182 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1183 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1184 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1185 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1186 |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1187 <directive name="uwsgi_request_buffering"> |
1659
680cbf783efe
Fixed some misuses of "value".
Ruslan Ermilov <ru@nginx.com>
parents:
1620
diff
changeset
|
1188 <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
|
1189 <default>on</default> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1190 <context>http</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1191 <context>server</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1192 <context>location</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1193 <appeared-in>1.7.11</appeared-in> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1194 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1195 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1196 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
|
1197 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1198 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1199 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1200 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
|
1201 <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
|
1202 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
|
1203 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1204 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1205 <para> |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1206 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
|
1207 immediately as it is received. |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1208 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
|
1209 <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
|
1210 if nginx already started sending the request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1211 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1212 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1213 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1214 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
|
1215 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
|
1216 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
|
1217 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1218 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1219 </directive> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1220 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1221 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1222 <directive name="uwsgi_send_timeout"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1223 <syntax><value>time</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1224 <default>60s</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1225 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1226 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1227 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1228 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1229 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1230 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
|
1231 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
|
1232 not for the transmission of the whole request. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1233 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
|
1234 the connection is closed. |
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 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1240 <directive name="uwsgi_ssl_certificate"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1241 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1242 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1243 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1244 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1245 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1246 <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
|
1247 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1248 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1249 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
|
1250 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
|
1251 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1252 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1253 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1254 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1255 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1256 <directive name="uwsgi_ssl_certificate_key"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1257 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1258 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1259 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1260 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1261 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1262 <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
|
1263 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1264 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1265 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
|
1266 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
|
1267 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1268 |
1456
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1269 <para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1270 The value |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1271 <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
|
1272 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
|
1273 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
|
1274 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
|
1275 </para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1276 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1277 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1278 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1279 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1280 <directive name="uwsgi_ssl_ciphers"> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1281 <syntax><value>ciphers</value></syntax> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1282 <default>DEFAULT</default> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1283 <context>http</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1284 <context>server</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1285 <context>location</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1286 <appeared-in>1.5.8</appeared-in> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1287 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1288 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1289 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
|
1290 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
|
1291 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1292 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1293 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1294 The full list can be viewed using the |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1295 “<command>openssl ciphers</command>” command. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1296 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1297 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1298 </directive> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1299 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1300 |
1193
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1301 <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
|
1302 <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
|
1303 <default/> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1304 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1305 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1306 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1307 <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
|
1308 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1309 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1310 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
|
1311 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
|
1312 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
|
1313 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1314 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1315 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1316 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1317 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1318 <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
|
1319 <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
|
1320 <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
|
1321 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1322 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1323 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1324 <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
|
1325 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1326 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1327 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
|
1328 <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
|
1329 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
|
1330 <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
|
1331 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
|
1332 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1333 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1334 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1335 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
|
1336 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1337 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1338 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1339 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1340 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1341 <directive name="uwsgi_ssl_password_file"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1342 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1343 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1344 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1345 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1346 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1347 <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
|
1348 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1349 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1350 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
|
1351 <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
|
1352 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
|
1353 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
|
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 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1359 <directive name="uwsgi_ssl_protocols"> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1360 <syntax> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1361 [<literal>SSLv2</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1362 [<literal>SSLv3</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1363 [<literal>TLSv1</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1364 [<literal>TLSv1.1</literal>] |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1365 [<literal>TLSv1.2</literal>]</syntax> |
1499
3687cc9a3592
Removed SSLv3 from the default value of ssl_protocols and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1456
diff
changeset
|
1366 <default>TLSv1 TLSv1.1 TLSv1.2</default> |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1367 <context>http</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1368 <context>server</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1369 <context>location</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1370 <appeared-in>1.5.8</appeared-in> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1371 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1372 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1373 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
|
1374 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1375 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1376 </directive> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1377 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1378 |
1193
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1379 <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
|
1380 <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
|
1381 <default>off</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1382 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1383 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1384 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1385 <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
|
1386 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1387 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1388 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
|
1389 <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
|
1390 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
|
1391 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
|
1392 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1393 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1394 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1395 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1396 |
1192
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1397 <directive name="uwsgi_ssl_session_reuse"> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1398 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1399 <default>on</default> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1400 <context>http</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1401 <context>server</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1402 <context>location</context> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1403 <appeared-in>1.5.8</appeared-in> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1404 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1405 <para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1406 Determines whether SSL sessions can be reused when working with |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1407 a secured uwsgi server. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1408 If the errors |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1409 “<literal>SSL3_GET_FINISHED:digest check failed</literal>” |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1410 appear in the logs, try disabling session reuse. |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1411 </para> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1412 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1413 </directive> |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1414 |
b5268820c3f3
Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents:
1191
diff
changeset
|
1415 |
1193
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1416 <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
|
1417 <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
|
1418 <default/> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1419 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1420 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1421 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1422 <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
|
1423 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1424 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1425 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
|
1426 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
|
1427 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
|
1428 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1429 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1430 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1431 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1432 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1433 <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
|
1434 <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
|
1435 <default>off</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1436 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1437 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1438 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1439 <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
|
1440 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1441 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1442 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
|
1443 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1444 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1445 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1446 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1447 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1448 <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
|
1449 <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
|
1450 <default>1</default> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1451 <context>http</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1452 <context>server</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1453 <context>location</context> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1454 <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
|
1455 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1456 <para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1457 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
|
1458 </para> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1459 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1460 </directive> |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1461 |
0320929f8544
Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents:
1192
diff
changeset
|
1462 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1463 <directive name="uwsgi_store"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1464 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1465 <literal>on</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1466 <literal>off</literal> | |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1467 <value>string</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1468 <default>off</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1469 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1470 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1471 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1472 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1473 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1474 Enables saving of files to a disk. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1475 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
|
1476 corresponding to the directives |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1477 <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
|
1478 <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
|
1479 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
|
1480 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
|
1481 <value>string</value> with variables: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1482 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1483 uwsgi_store /data/www$original_uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1484 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1485 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1486 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1487 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1488 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
|
1489 <header>Last-Modified</header> response header field. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1490 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
|
1491 and then the file is renamed. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1492 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
|
1493 can be put on different file systems. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1494 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
|
1495 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
|
1496 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
|
1497 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
|
1498 directive, are put on the same file system. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1499 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1500 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1501 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1502 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
|
1503 files, e.g.: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1504 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1505 location /images/ { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1506 root /data/www; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1507 error_page 404 = /fetch$uri; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1508 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1509 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1510 location /fetch/ { |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1511 internal; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1512 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1513 uwsgi_pass backend:9000; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1514 ... |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1515 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1516 uwsgi_store on; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1517 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
|
1518 uwsgi_temp_path /data/temp; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1519 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1520 alias /data/www/; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1521 } |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1522 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1523 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1524 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1525 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1526 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1527 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1528 <directive name="uwsgi_store_access"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1529 <syntax><value>users</value>:<value>permissions</value> ...</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1530 <default>user:rw</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1531 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1532 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1533 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1534 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1535 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1536 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
|
1537 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1538 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
|
1539 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1540 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1541 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1542 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1543 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
|
1544 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
|
1545 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1546 uwsgi_store_access group:rw all:r; |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1547 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1548 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1549 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1550 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1551 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1552 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1553 <directive name="uwsgi_temp_file_write_size"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1554 <syntax><value>size</value></syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1555 <default>8k|16k</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1556 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1557 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1558 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1559 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1560 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1561 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
|
1562 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
|
1563 to temporary files is enabled. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1564 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
|
1565 <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
|
1566 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
|
1567 <link id="uwsgi_max_temp_file_size"/> directive. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1568 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1569 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1570 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1571 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1572 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1573 <directive name="uwsgi_temp_path"> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1574 <syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1575 <value>path</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1576 [<value>level1</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1577 [<value>level2</value> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1578 [<value>level3</value>]]]</syntax> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1579 <default>uwsgi_temp</default> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1580 <context>http</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1581 <context>server</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1582 <context>location</context> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1583 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1584 <para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1585 Defines a directory for storing temporary files |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1586 with data received from uwsgi servers. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1587 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
|
1588 directory. |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1589 For example, in the following configuration |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1590 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1591 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
|
1592 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1593 a temporary file might look like this: |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1594 <example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1595 /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
|
1596 </example> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1597 </para> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1598 |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1599 <para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1600 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
|
1601 <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
|
1602 </para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1603 |
1191
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1604 </directive> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1605 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1606 </section> |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1607 |
ea85ba147fe9
Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1608 </module> |