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