annotate xml/en/docs/http/ngx_http_uwsgi_module.xml @ 1353:25db29c8875e

Documented how the "Vary" response header field affects caching.
author Ruslan Ermilov <ru@nginx.com>
date Fri, 14 Nov 2014 10:40:00 +0300
parents dbb618f60a54
children e0e1e5db06bb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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"
1353
25db29c8875e Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents: 1352
diff changeset
13 rev="13">
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.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 By default, the buffer size is equal to the size of one
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 buffer set by the <link id="uwsgi_buffers"/> directive.
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.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 The <literal>off</literal> parameter disables caching inherited
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 from the previous configuration level.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175
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 <directive name="uwsgi_cache_bypass">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <syntax><value>string</value> ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 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
186 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
187 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
188 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 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
190 uwsgi_cache_bypass $http_pragma $http_authorization;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 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
193 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196
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 <directive name="uwsgi_cache_key">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 <syntax><value>string</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206 Defines a key for caching, for example
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 uwsgi_cache_key localhost:9000$request_uri;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <directive name="uwsgi_cache_lock">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 <syntax><literal>on</literal> | <literal>off</literal></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 <default>off</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 <appeared-in>1.1.12</appeared-in>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 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
225 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
226 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
227 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
228 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
229 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
230 <link id="uwsgi_cache_lock_timeout"/> directive.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234
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 <directive name="uwsgi_cache_lock_timeout">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 <syntax><value>time</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 <default>5s</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
239 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242 <appeared-in>1.1.12</appeared-in>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 Sets a timeout for <link id="uwsgi_cache_lock"/>.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 <directive name="uwsgi_cache_methods">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 <literal>GET</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254 <literal>HEAD</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 <literal>POST</literal>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256 ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 <default>GET HEAD</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
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263 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
264 the response will be cached.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265 “<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
266 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
267 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
268 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
270 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
271
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
272
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273 <directive name="uwsgi_cache_min_uses">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
274 <syntax><value>number</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
275 <default>1</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
276 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
277 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
278 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
279
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
280 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
281 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
282 will be cached.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
283 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
284
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
285 </directive>
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
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
288 <directive name="uwsgi_cache_path">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
289 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
290 <value>path</value>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
291 [<literal>levels</literal>=<value>levels</value>]
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
292 <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
293 [<literal>inactive</literal>=<value>time</value>]
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
294 [<literal>max_size</literal>=<value>size</value>]
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
295 [<literal>loader_files</literal>=<value>number</value>]
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
296 [<literal>loader_sleep</literal>=<value>time</value>]
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
297 [<literal>loader_threshold</literal>=<value>time</value>]</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
298 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
299 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
300
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
301 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
302 Sets the path and other parameters of a cache.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
303 Cache data are stored in files.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
304 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
305 applying the MD5 function to the
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
306 <link id="uwsgi_cache_key">cache key</link>.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
307 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
308 For example, in the following configuration
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
309 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
310 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
311 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312 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
313 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
314 /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
315 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
316 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
317
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
318 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
319 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
320 and then the file is renamed.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
321 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
322 different file systems.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
323 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
324 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
325 It is thus recommended that for any given location both cache and a directory
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
326 holding temporary files, set by the <link id="uwsgi_temp_path"/> directive,
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
327 are put on the same file system.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
328 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
329
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
330 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
331 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
332 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
333 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
334 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
335 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
336
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
337 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
338 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
339 <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
340 regardless of their freshness.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
341 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
342 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
343
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
344 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
345 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
346 by the <literal>max_size</literal> parameter.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
347 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
348 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
349
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
350 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
351 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
352 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
353 into a cache zone.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
354 The loading is done in iterations.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
355 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
356 are loaded (by default, 100).
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
357 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
358 <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
359 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
360 parameter (by default, 50 milliseconds) is made.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
361 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
362
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
363 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
364
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
365
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
366 <directive name="uwsgi_cache_purge">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
367 <syntax>string ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
368 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
369 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
370 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
371 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
372 <appeared-in>1.5.7</appeared-in>
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 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
376 purge request.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
377 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
378 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
379 <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
380 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
381 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
382 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
383
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
384 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
385 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
386 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
387 wildcard key will be removed from the cache.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
388 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
389
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
390 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
391 Example configuration:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
392 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
393 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
394
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
395 map $request_method $purge_method {
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
396 PURGE 1;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
397 default 0;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
398 }
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
399
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
400 server {
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
401 ...
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
402 location / {
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
403 uwsgi_pass backend;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
404 uwsgi_cache cache_zone;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
405 uwsgi_cache_key $uri;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
406 uwsgi_cache_purge $purge_method;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
407 }
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
408 }
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
409 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
410 <note>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
411 This functionality is available as part of our
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
412 <commercial_version>commercial subscription</commercial_version>.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
413 </note>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
414 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
415
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
416 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
417
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
418
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
419 <directive name="uwsgi_cache_revalidate">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
420 <syntax><literal>on</literal> | <literal>off</literal></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
421 <default>off</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
422 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
423 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
424 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
425 <appeared-in>1.5.7</appeared-in>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
426
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
427 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
428 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
429 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
430 header fields.
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
431 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
432
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
433 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
434
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
435
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
436 <directive name="uwsgi_cache_use_stale">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
437 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
438 <literal>error</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
439 <literal>timeout</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
440 <literal>invalid_header</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
441 <literal>updating</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
442 <literal>http_500</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
443 <literal>http_503</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
444 <literal>http_403</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
445 <literal>http_404</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
446 <literal>off</literal>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
447 ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
448 <default>off</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
449 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
450 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
451 <context>location</context>
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 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
454 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
455 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
456 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
457 <link id="uwsgi_next_upstream"/> directive.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
458 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
459
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
460 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
461 Additionally, the <literal>updating</literal> parameter permits
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
462 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
463 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
464 when updating cached data.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
465 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
466
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
467 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
468 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
469 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
470 directive can be used.
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
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
473 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
474
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
475
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
476 <directive name="uwsgi_cache_valid">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
477 <syntax>[<value>code</value> ...] <value>time</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
478 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
479 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
480 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
481 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
482
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
483 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
484 Sets caching time for different response codes.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
485 For example, the following directives
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
486 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
487 uwsgi_cache_valid 200 302 10m;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
488 uwsgi_cache_valid 404 1m;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
489 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
490 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
491 and 1 minute for responses with code 404.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
492 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
493
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
494 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
495 If only caching <value>time</value> is specified
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
496 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
497 uwsgi_cache_valid 5m;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
498 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
499 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
500 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
501
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
502 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
503 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
504 to cache any responses:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
505 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
506 uwsgi_cache_valid 200 302 10m;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
507 uwsgi_cache_valid 301 1h;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
508 uwsgi_cache_valid any 1m;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
509 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
510 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
511
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
512 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
513 Parameters of caching can also be set directly
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
514 in the response header.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
515 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
516 <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
517
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
518 <listitem>
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
519 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
520 response in seconds.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
521 The zero value disables caching for a response.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
522 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
523 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
524 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
525
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
526 <listitem>
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
527 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
528 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
529 <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
530 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
531
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
532 <listitem>
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
533 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
534 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
535 </listitem>
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
536
1353
25db29c8875e Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents: 1352
diff changeset
537 <listitem>
25db29c8875e Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents: 1352
diff changeset
538 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
539 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
540 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
541 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
542 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
543 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
544 </listitem>
25db29c8875e Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents: 1352
diff changeset
545
1349
97c8b146cb0e Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents: 1345
diff changeset
546 </list>
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
547 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
548 using the <link id="uwsgi_ignore_headers"/> 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 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
552
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
553
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
554 <directive name="uwsgi_connect_timeout">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
555 <syntax><value>time</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
556 <default>60s</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
557 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
558 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
559 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
560
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
561 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
562 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
563 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
564 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
565
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
566 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
567
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
568
1337
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
569 <directive name="uwsgi_force_ranges">
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
570 <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
571 <default>off</default>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
572 <context>http</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
573 <context>server</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
574 <context>location</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
575 <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
576
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
577 <para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
578 Enables byte-range support
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
579 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
580 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
581 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
582
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
583 </directive>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
584
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
585
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
586 <directive name="uwsgi_hide_header">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
587 <syntax><value>field</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
588 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
589 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
590 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
591 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
592
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
593 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
594 By default,
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
595 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
596 <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
597 server to a client.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
598 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
599 that will not be passed.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
600 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
601 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
602 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
603
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
604 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
605
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
606
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
607 <directive name="uwsgi_ignore_client_abort">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
608 <syntax><literal>on</literal> | <literal>off</literal></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
609 <default>off</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
610 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
611 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
612 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
613
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
614 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
615 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
616 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
617 for a response.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
618 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
619
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
620 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
621
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
622
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
623 <directive name="uwsgi_ignore_headers">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
624 <syntax><value>field</value> ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
625 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
626 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
627 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
628 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
629
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
630 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
631 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
632 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
633 <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
634 <header>X-Accel-Buffering</header> (1.1.6),
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
635 <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
636 <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
637 and <header>Vary</header> (1.7.7).
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
638 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
639
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
640 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
641 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
642 effect:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
643 <list type="bullet" compact="no">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
644
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
645 <listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
646 <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
647 <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
648 and <header>Vary</header>
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
649 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
650 </listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
651
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
652 <listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
653 <header>X-Accel-Redirect</header> performs an
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
654 <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
655 redirect</link> to the specified URI;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
656 </listitem>
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 <listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
659 <header>X-Accel-Limit-Rate</header> sets the
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
660 <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
661 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
662 </listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
663
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
664 <listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
665 <header>X-Accel-Buffering</header> enables or disables
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
666 <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
667 </listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
668
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
669 <listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
670 <header>X-Accel-Charset</header> sets the desired
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
671 <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
672 of a response.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
673 </listitem>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
674
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
675 </list>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
676 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
677
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
678 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
679
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
680
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
681 <directive name="uwsgi_intercept_errors">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
682 <syntax><literal>on</literal> | <literal>off</literal></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
683 <default>off</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
684 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
685 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
686 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
687
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
688 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
689 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
690 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
691 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
692 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
693
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
694 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
695
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
696
1342
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
697 <directive name="uwsgi_limit_rate">
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
698 <syntax><value>rate</value></syntax>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
699 <default>0</default>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
700 <context>http</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
701 <context>server</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
702 <context>location</context>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
703 <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
704
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
705 <para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
706 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
707 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
708 The zero value disables rate limiting.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
709 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
710 two connections to the uwsgi server,
1bdde28e359b Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents: 1342
diff changeset
711 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
712 The limitation works only if
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
713 <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
714 server is enabled.
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
715 </para>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
716
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
717 </directive>
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
718
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
719
758fc0b02651 Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1337
diff changeset
720
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
721 <directive name="uwsgi_max_temp_file_size">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
722 <syntax><value>size</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
723 <default>1024m</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
724 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
725 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
726 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
727
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
728 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
729 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
730 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
731 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
732 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
733 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
734 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
735 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
736 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
737
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
738 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
739 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
740 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
741
1352
dbb618f60a54 Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents: 1349
diff changeset
742 <para>
dbb618f60a54 Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents: 1349
diff changeset
743 <note>
dbb618f60a54 Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents: 1349
diff changeset
744 This restriction does not apply to responses
dbb618f60a54 Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents: 1349
diff changeset
745 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
746 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
747 </note>
dbb618f60a54 Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents: 1349
diff changeset
748 </para>
dbb618f60a54 Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents: 1349
diff changeset
749
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
750 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
751
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
752
1199
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
753 <directive name="uwsgi_modifier1">
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
754 <syntax><value>number</value></syntax>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
755 <default>0</default>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
756 <context>http</context>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
757 <context>server</context>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
758 <context>location</context>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
759
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
760 <para>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
761 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
762 <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
763 packet header</link>.
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
764 </para>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
765 </directive>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
766
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
767
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
768 <directive name="uwsgi_modifier2">
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
769 <syntax><value>number</value></syntax>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
770 <default>0</default>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
771 <context>http</context>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
772 <context>server</context>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
773 <context>location</context>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
774
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
775 <para>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
776 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
777 <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
778 packet header</link>.
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
779 </para>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
780 </directive>
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
781
5ee8a00f2bc5 Documented the uwsgi_modifier1 and uwsgi_modifier2 directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1193
diff changeset
782
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
783 <directive name="uwsgi_next_upstream">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
784 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
785 <literal>error</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
786 <literal>timeout</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
787 <literal>invalid_header</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
788 <literal>http_500</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
789 <literal>http_503</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
790 <literal>http_403</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
791 <literal>http_404</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
792 <literal>off</literal>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
793 ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
794 <default>error timeout</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
795 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
796 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
797 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
798
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
799 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
800 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
801 <list type="tag">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
802
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
803 <tag-name><literal>error</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
804 <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
805 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
806
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
807 <tag-name><literal>timeout</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
808 <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
809 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
810
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
811 <tag-name><literal>invalid_header</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
812 <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
813
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
814 <tag-name><literal>http_500</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
815 <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
816
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
817 <tag-name><literal>http_503</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
818 <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
819
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
820 <tag-name><literal>http_403</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
821 <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
822
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
823 <tag-name><literal>http_404</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
824 <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
825
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
826 <tag-name><literal>off</literal></tag-name>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
827 <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
828
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
829 </list>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
830 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
831
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
832 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
833 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
834 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
835 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
836 transferring of a response, fixing this is impossible.
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
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
839 <para>
1289
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1246
diff changeset
840 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
841 <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
842 attempt</link> of communication with a server.
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
843 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
844 <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
845 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
846 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
847 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
848 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
849 are never considered unsuccessful attempts.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
850 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
851
1290
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
852 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
853 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
854 <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
855 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
856 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
857
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
858 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
859
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
860
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
861 <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
862 <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
863 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
864 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
865 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
866 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
867 <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
868
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
869 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
870 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
871 <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
872 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
873 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
874
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
875 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
876
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
877
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
878 <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
879 <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
880 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
881 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
882 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
883 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
884 <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
885
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
886 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
887 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
888 <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
889 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
890 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
891
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
892 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
893
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
894
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
895 <directive name="uwsgi_no_cache">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
896 <syntax><value>string</value> ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
897 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
898 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
899 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
900 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
901
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
902 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
903 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
904 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
905 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
906 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
907 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
908 uwsgi_no_cache $http_pragma $http_authorization;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
909 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
910 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
911 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
912
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
913 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
914
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
915
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
916 <directive name="uwsgi_param">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
917 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
918 <value>parameter</value> <value>value</value>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
919 [<literal>if_not_empty</literal>]</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
920 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
921 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
922 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
923 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
924
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
925 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
926 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
927 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
928 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
929 only if there are no
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
930 <literal>uwsgi_param</literal>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
931 directives defined on the current level.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
932 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
933
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 Standard
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
936 <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
937 environment variables</link>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
938 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
939 provided in the distribution:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
940 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
941 location / {
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
942 include uwsgi_params;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
943 ...
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
944 }
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
945 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
946 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
947
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
948 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
949 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
950 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
951 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
952 uwsgi_param HTTPS $https if_not_empty;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
953 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
954 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
955
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
956 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
957
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
958
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
959 <directive name="uwsgi_pass">
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
960 <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
961 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
962 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
963 <context>if in location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
964
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
965 <para>
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
966 Sets the protocol and address of a uwsgi server.
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
967 As a <value>protocol</value>,
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
968 “<literal>uwsgi</literal>” or “<literal>suwsgi</literal>”
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
969 (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
970 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
971 and an optional port:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
972 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
973 uwsgi_pass localhost:9000;
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
974 uwsgi_pass uwsgi://localhost:9000;
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
975 uwsgi_pass suwsgi://[2001:db8::1]:9090;
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
976 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
977 or as a UNIX-domain socket path:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
978 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
979 uwsgi_pass unix:/tmp/uwsgi.socket;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
980 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
981 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
982
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
983 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
984 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
985 used in a round-robin fashion.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
986 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
987 <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
988 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
989
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
990 <para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
991 <note>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
992 Secured uwsgi protocol is supported since version 1.5.8.
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
993 </note>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
994 </para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
995
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
996 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
997
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 <directive name="uwsgi_pass_header">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1000 <syntax><value>field</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1001 <default/>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1002 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1003 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1004 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1005
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1006 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1007 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
1008 fields from a uwsgi server to a client.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1009 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1010
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1011 </directive>
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
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1014 <directive name="uwsgi_pass_request_body">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1015 <syntax><literal>on</literal> | <literal>off</literal></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1016 <default>on</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1017 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1018 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1019 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1020
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1021 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1022 Indicates whether the original request body is passed
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1023 to the uwsgi server.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1024 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
1025 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1026
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1027 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1028
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1029
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1030 <directive name="uwsgi_pass_request_headers">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1031 <syntax><literal>on</literal> | <literal>off</literal></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1032 <default>on</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1033 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1034 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1035 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1036
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1037 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1038 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
1039 to the uwsgi server.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1040 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
1041 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1042
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1043 </directive>
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
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1046 <directive name="uwsgi_read_timeout">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1047 <syntax><value>time</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1048 <default>60s</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1049 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1050 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1051 <context>location</context>
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 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1054 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
1055 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
1056 not for the transmission of the whole response.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1057 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
1058 the connection is closed.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1059 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1060
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1061 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1062
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1063
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1064 <directive name="uwsgi_send_timeout">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1065 <syntax><value>time</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1066 <default>60s</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1067 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1068 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1069 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1070
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1071 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1072 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
1073 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
1074 not for the transmission of the whole request.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1075 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
1076 the connection is closed.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1077 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1078
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1079 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1080
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1081
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1082 <directive name="uwsgi_ssl_ciphers">
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1083 <syntax><value>ciphers</value></syntax>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1084 <default>DEFAULT</default>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1085 <context>http</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1086 <context>server</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1087 <context>location</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1088 <appeared-in>1.5.8</appeared-in>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1089
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1090 <para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1091 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
1092 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
1093 </para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1094
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1095 <para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1096 The full list can be viewed using the
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1097 “<command>openssl ciphers</command>” command.
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1098 </para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1099
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1100 </directive>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1101
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1102
1193
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1103 <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
1104 <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
1105 <default/>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1106 <context>http</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1107 <context>server</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1108 <context>location</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1109 <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
1110
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1111 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1112 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
1113 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
1114 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
1115 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1116
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1117 </directive>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1118
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1119
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1120 <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
1121 <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
1122 <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
1123 <context>http</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1124 <context>server</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1125 <context>location</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1126 <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
1127
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1128 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1129 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
1130 <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
1131 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
1132 <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
1133 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
1134 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1135
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1136 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1137 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
1138 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1139
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1140 </directive>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1141
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1142
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1143 <directive name="uwsgi_ssl_protocols">
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1144 <syntax>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1145 [<literal>SSLv2</literal>]
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1146 [<literal>SSLv3</literal>]
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1147 [<literal>TLSv1</literal>]
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1148 [<literal>TLSv1.1</literal>]
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1149 [<literal>TLSv1.2</literal>]</syntax>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1150 <default>SSLv3 TLSv1 TLSv1.1 TLSv1.2</default>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1151 <context>http</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1152 <context>server</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1153 <context>location</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1154 <appeared-in>1.5.8</appeared-in>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1155
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1156 <para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1157 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
1158 </para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1159
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1160 </directive>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1161
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1162
1193
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1163 <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
1164 <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
1165 <default>off</default>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1166 <context>http</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1167 <context>server</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1168 <context>location</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1169 <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
1170
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1171 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1172 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
1173 <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
1174 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
1175 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
1176 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1177
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1178 </directive>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1179
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1180
1192
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1181 <directive name="uwsgi_ssl_session_reuse">
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1182 <syntax><literal>on</literal> | <literal>off</literal></syntax>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1183 <default>on</default>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1184 <context>http</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1185 <context>server</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1186 <context>location</context>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1187 <appeared-in>1.5.8</appeared-in>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1188
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1189 <para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1190 Determines whether SSL sessions can be reused when working with
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1191 a secured uwsgi server.
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1192 If the errors
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1193 “<literal>SSL3_GET_FINISHED:digest check failed</literal>”
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1194 appear in the logs, try disabling session reuse.
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1195 </para>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1196
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1197 </directive>
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1198
b5268820c3f3 Documented "suwsgi" protocol support.
Ruslan Ermilov <ru@nginx.com>
parents: 1191
diff changeset
1199
1193
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1200 <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
1201 <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
1202 <default/>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1203 <context>http</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1204 <context>server</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1205 <context>location</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1206 <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
1207
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1208 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1209 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
1210 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
1211 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
1212 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1213
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1214 </directive>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1215
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1216
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1217 <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
1218 <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
1219 <default>off</default>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1220 <context>http</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1221 <context>server</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1222 <context>location</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1223 <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
1224
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1225 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1226 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
1227 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1228
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1229 </directive>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1230
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1231
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1232 <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
1233 <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
1234 <default>1</default>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1235 <context>http</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1236 <context>server</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1237 <context>location</context>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1238 <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
1239
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1240 <para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1241 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
1242 </para>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1243
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1244 </directive>
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1245
0320929f8544 Documented uwsgi_ssl_verify, uwsgi_ssl_server_name, and friends.
Ruslan Ermilov <ru@nginx.com>
parents: 1192
diff changeset
1246
1191
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1247 <directive name="uwsgi_store">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1248 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1249 <literal>on</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1250 <literal>off</literal> |
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1251 <value>string</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1252 <default>off</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1253 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1254 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1255 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1256
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1257 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1258 Enables saving of files to a disk.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1259 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
1260 corresponding to the directives
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1261 <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
1262 <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
1263 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
1264 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
1265 <value>string</value> with variables:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1266 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1267 uwsgi_store /data/www$original_uri;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1268 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1269 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1270
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1271 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1272 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
1273 <header>Last-Modified</header> response header field.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1274 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
1275 and then the file is renamed.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1276 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
1277 can be put on different file systems.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1278 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
1279 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
1280 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
1281 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
1282 directive, are put on the same file system.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1283 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1284
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1285 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1286 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
1287 files, e.g.:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1288 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1289 location /images/ {
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1290 root /data/www;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1291 error_page 404 = /fetch$uri;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1292 }
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1293
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1294 location /fetch/ {
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1295 internal;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1296
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1297 uwsgi_pass backend:9000;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1298 ...
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1299
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1300 uwsgi_store on;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1301 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
1302 uwsgi_temp_path /data/temp;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1303
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1304 alias /data/www/;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1305 }
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1306 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1307 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1308
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1309 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1310
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1311
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1312 <directive name="uwsgi_store_access">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1313 <syntax><value>users</value>:<value>permissions</value> ...</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1314 <default>user:rw</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1315 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1316 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1317 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1318
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1319 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1320 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
1321 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1322 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
1323 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1324 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1325
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1326 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1327 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
1328 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
1329 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1330 uwsgi_store_access group:rw all:r;
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1331 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1332 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1333
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1334 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1335
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1336
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1337 <directive name="uwsgi_temp_file_write_size">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1338 <syntax><value>size</value></syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1339 <default>8k|16k</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1340 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1341 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1342 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1343
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1344 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1345 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
1346 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
1347 to temporary files is enabled.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1348 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
1349 <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
1350 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
1351 <link id="uwsgi_max_temp_file_size"/> directive.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1352 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1353
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1354 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1355
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1356
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1357 <directive name="uwsgi_temp_path">
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1358 <syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1359 <value>path</value>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1360 [<value>level1</value>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1361 [<value>level2</value>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1362 [<value>level3</value>]]]</syntax>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1363 <default>uwsgi_temp</default>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1364 <context>http</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1365 <context>server</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1366 <context>location</context>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1367
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1368 <para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1369 Defines a directory for storing temporary files
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1370 with data received from uwsgi servers.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1371 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
1372 directory.
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1373 For example, in the following configuration
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1374 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1375 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
1376 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1377 a temporary file might look like this:
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1378 <example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1379 /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
1380 </example>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1381 </para>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1382
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1383 </directive>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1384
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1385 </section>
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1386
ea85ba147fe9 Mechanically converted SCGI module docs to uwsgi.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1387 </module>