Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_uwsgi_module.xml @ 1499:3687cc9a3592

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