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