annotate xml/en/docs/http/ngx_http_uwsgi_module.xml @ 1878:127ae107e5a9

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