Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_scgi_module.xml @ 2522:91d725e52633
Fixed typos (ticket #1949).
author | Sergey Kandaurov <pluknet@nginx.com> |
---|---|
date | Wed, 08 Apr 2020 11:19:30 +0300 |
parents | d765ffffd08c |
children | a5bbfdf88bbd |
rev | line source |
---|---|
1180 | 1 <?xml version="1.0"?> |
2 | |
3 <!-- | |
4 Copyright (C) Igor Sysoev | |
5 Copyright (C) Nginx, Inc. | |
6 --> | |
7 | |
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
9 | |
10 <module name="Module ngx_http_scgi_module" | |
11 link="/en/docs/http/ngx_http_scgi_module.html" | |
12 lang="en" | |
2254
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
13 rev="39"> |
1180 | 14 |
15 <section id="summary"> | |
16 | |
17 <para> | |
18 The <literal>ngx_http_scgi_module</literal> module allows passing | |
19 requests to an SCGI server. | |
20 </para> | |
21 | |
22 </section> | |
23 | |
24 | |
25 <section id="example" name="Example Configuration"> | |
26 | |
27 <para> | |
28 <example> | |
29 location / { | |
30 include scgi_params; | |
31 scgi_pass localhost:9000; | |
32 } | |
33 </example> | |
34 </para> | |
35 | |
36 </section> | |
37 | |
38 | |
39 <section id="directives" name="Directives"> | |
40 | |
41 <directive name="scgi_bind"> | |
1885
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
42 <syntax> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
43 <value>address</value> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
44 [<literal>transparent</literal>] | |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
45 <literal>off</literal></syntax> |
1180 | 46 <default/> |
47 <context>http</context> | |
48 <context>server</context> | |
49 <context>location</context> | |
50 | |
51 <para> | |
52 Makes outgoing connections to an SCGI server originate | |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
53 from the specified local IP address with an optional port (1.11.2). |
1180 | 54 Parameter value can contain variables (1.3.12). |
55 The special value <literal>off</literal> (1.3.12) cancels the effect | |
56 of the <literal>scgi_bind</literal> directive | |
57 inherited from the previous configuration level, which allows the | |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
58 system to auto-assign the local IP address and port. |
1180 | 59 </para> |
60 | |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
61 <para id="scgi_bind_transparent"> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
62 The <literal>transparent</literal> parameter (1.11.0) allows |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
63 outgoing connections to an SCGI server originate |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
64 from a non-local IP address, |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
65 for example, from a real IP address of a client: |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
66 <example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
67 scgi_bind $remote_addr transparent; |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
68 </example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
69 In order for this parameter to work, |
2090
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2083
diff
changeset
|
70 it is usually necessary to run nginx worker processes with the |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2083
diff
changeset
|
71 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges. |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2083
diff
changeset
|
72 On Linux it is not required (1.13.8) as if |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2083
diff
changeset
|
73 the <literal>transparent</literal> parameter is specified, worker processes |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2083
diff
changeset
|
74 inherit the <literal>CAP_NET_RAW</literal> capability from the master process. |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2083
diff
changeset
|
75 It is also necessary to configure kernel routing table |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
76 to intercept network traffic from the SCGI server. |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
77 </para> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
78 |
1180 | 79 </directive> |
80 | |
81 | |
82 <directive name="scgi_buffer_size"> | |
83 <syntax><value>size</value></syntax> | |
84 <default>4k|8k</default> | |
85 <context>http</context> | |
86 <context>server</context> | |
87 <context>location</context> | |
88 | |
89 <para> | |
90 Sets the <value>size</value> of the buffer used for reading the first part | |
91 of the response received from the SCGI server. | |
92 This part usually contains a small response header. | |
1550
305f2c338181
Fixed description of default value of proxy_buffer_size and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
93 By default, the buffer size is equal to one memory page. |
305f2c338181
Fixed description of default value of proxy_buffer_size and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
94 This is either 4K or 8K, depending on a platform. |
1180 | 95 It can be made smaller, however. |
96 </para> | |
97 | |
98 </directive> | |
99 | |
100 | |
101 <directive name="scgi_buffering"> | |
102 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
103 <default>on</default> | |
104 <context>http</context> | |
105 <context>server</context> | |
106 <context>location</context> | |
107 | |
108 <para> | |
109 Enables or disables buffering of responses from the SCGI server. | |
110 </para> | |
111 | |
112 <para> | |
113 When buffering is enabled, nginx receives a response from the SCGI server | |
114 as soon as possible, saving it into the buffers set by the | |
115 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives. | |
116 If the whole response does not fit into memory, a part of it can be saved | |
117 to a <link id="scgi_temp_path">temporary file</link> on the disk. | |
118 Writing to temporary files is controlled by the | |
119 <link id="scgi_max_temp_file_size"/> and | |
120 <link id="scgi_temp_file_write_size"/> directives. | |
121 </para> | |
122 | |
123 <para> | |
124 When buffering is disabled, the response is passed to a client synchronously, | |
125 immediately as it is received. | |
126 nginx will not try to read the whole response from the SCGI server. | |
127 The maximum size of the data that nginx can receive from the server | |
128 at a time is set by the <link id="scgi_buffer_size"/> directive. | |
129 </para> | |
130 | |
131 <para> | |
132 Buffering can also be enabled or disabled by passing | |
133 “<literal>yes</literal>” or “<literal>no</literal>” in the | |
134 <header>X-Accel-Buffering</header> response header field. | |
135 This capability can be disabled using the | |
136 <link id="scgi_ignore_headers"/> directive. | |
137 </para> | |
138 | |
139 </directive> | |
140 | |
141 | |
142 <directive name="scgi_buffers"> | |
143 <syntax><value>number</value> <value>size</value></syntax> | |
144 <default>8 4k|8k</default> | |
145 <context>http</context> | |
146 <context>server</context> | |
147 <context>location</context> | |
148 | |
149 <para> | |
150 Sets the <value>number</value> and <value>size</value> of the | |
151 buffers used for reading a response from the SCGI server, | |
152 for a single connection. | |
153 By default, the buffer size is equal to one memory page. | |
154 This is either 4K or 8K, depending on a platform. | |
155 </para> | |
156 | |
157 </directive> | |
158 | |
159 | |
160 <directive name="scgi_busy_buffers_size"> | |
161 <syntax><value>size</value></syntax> | |
162 <default>8k|16k</default> | |
163 <context>http</context> | |
164 <context>server</context> | |
165 <context>location</context> | |
166 | |
167 <para> | |
168 When <link id="scgi_buffering">buffering</link> of responses from the SCGI | |
169 server is enabled, limits the total <value>size</value> of buffers that | |
170 can be busy sending a response to the client while the response is not | |
171 yet fully read. | |
172 In the meantime, the rest of the buffers can be used for reading the response | |
173 and, if needed, buffering part of the response to a temporary file. | |
174 By default, <value>size</value> is limited by the size of two buffers set by the | |
175 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives. | |
176 </para> | |
177 | |
178 </directive> | |
179 | |
180 | |
181 <directive name="scgi_cache"> | |
182 <syntax><value>zone</value> | <literal>off</literal></syntax> | |
183 <default>off</default> | |
184 <context>http</context> | |
185 <context>server</context> | |
186 <context>location</context> | |
187 | |
188 <para> | |
189 Defines a shared memory zone used for caching. | |
190 The same zone can be used in several places. | |
1382
94cac978bda3
Documented variables support in proxy_cache and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1379
diff
changeset
|
191 Parameter value can contain variables (1.7.9). |
1180 | 192 The <literal>off</literal> parameter disables caching inherited |
193 from the previous configuration level. | |
194 </para> | |
195 | |
196 </directive> | |
197 | |
198 | |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
199 <directive name="scgi_cache_background_update"> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
200 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
201 <default>off</default> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
202 <context>http</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
203 <context>server</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
204 <context>location</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
205 <appeared-in>1.11.10</appeared-in> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
206 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
207 <para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
208 Allows starting a background subrequest |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
209 to update an expired cache item, |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
210 while a stale cached response is returned to the client. |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
211 Note that it is necessary to |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
212 <link id="scgi_cache_use_stale_updating">allow</link> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
213 the usage of a stale cached response when it is being updated. |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
214 </para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
215 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
216 </directive> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
217 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
218 |
1180 | 219 <directive name="scgi_cache_bypass"> |
220 <syntax><value>string</value> ...</syntax> | |
221 <default/> | |
222 <context>http</context> | |
223 <context>server</context> | |
224 <context>location</context> | |
225 | |
226 <para> | |
227 Defines conditions under which the response will not be taken from a cache. | |
228 If at least one value of the string parameters is not empty and is not | |
229 equal to “0” then the response will not be taken from the cache: | |
230 <example> | |
231 scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment; | |
232 scgi_cache_bypass $http_pragma $http_authorization; | |
233 </example> | |
234 Can be used along with the <link id="scgi_no_cache"/> directive. | |
235 </para> | |
236 | |
237 </directive> | |
238 | |
239 | |
240 <directive name="scgi_cache_key"> | |
241 <syntax><value>string</value></syntax> | |
242 <default/> | |
243 <context>http</context> | |
244 <context>server</context> | |
245 <context>location</context> | |
246 | |
247 <para> | |
248 Defines a key for caching, for example | |
249 <example> | |
250 scgi_cache_key localhost:9000$request_uri; | |
251 </example> | |
252 </para> | |
253 | |
254 </directive> | |
255 | |
256 | |
257 <directive name="scgi_cache_lock"> | |
258 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
259 <default>off</default> | |
260 <context>http</context> | |
261 <context>server</context> | |
262 <context>location</context> | |
263 <appeared-in>1.1.12</appeared-in> | |
264 | |
265 <para> | |
266 When enabled, only one request at a time will be allowed to populate | |
267 a new cache element identified according to the <link id="scgi_cache_key"/> | |
268 directive by passing a request to an SCGI server. | |
269 Other requests of the same cache element will either wait | |
270 for a response to appear in the cache or the cache lock for | |
271 this element to be released, up to the time set by the | |
272 <link id="scgi_cache_lock_timeout"/> directive. | |
273 </para> | |
274 | |
275 </directive> | |
276 | |
277 | |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
278 <directive name="scgi_cache_lock_age"> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
279 <syntax><value>time</value></syntax> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
280 <default>5s</default> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
281 <context>http</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
282 <context>server</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
283 <context>location</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
284 <appeared-in>1.7.8</appeared-in> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
285 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
286 <para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
287 If the last request passed to the SCGI server |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
288 for populating a new cache element |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
289 has not completed for the specified <value>time</value>, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
290 one more request may be passed to the SCGI server. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
291 </para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
292 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
293 </directive> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
294 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
295 |
1180 | 296 <directive name="scgi_cache_lock_timeout"> |
297 <syntax><value>time</value></syntax> | |
298 <default>5s</default> | |
299 <context>http</context> | |
300 <context>server</context> | |
301 <context>location</context> | |
302 <appeared-in>1.1.12</appeared-in> | |
303 | |
304 <para> | |
305 Sets a timeout for <link id="scgi_cache_lock"/>. | |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
306 When the <value>time</value> expires, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
307 the request will be passed to the SCGI server, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
308 however, the response will not be cached. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
309 <note> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
310 Before 1.7.8, the response could be cached. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
311 </note> |
1180 | 312 </para> |
313 | |
314 </directive> | |
315 | |
316 | |
1838
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
317 <directive name="scgi_cache_max_range_offset"> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
318 <syntax><value>number</value></syntax> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
319 <default/> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
320 <context>http</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
321 <context>server</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
322 <context>location</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
323 <appeared-in>1.11.6</appeared-in> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
324 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
325 <para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
326 Sets an offset in bytes for byte-range requests. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
327 If the range is beyond the offset, |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
328 the range request will be passed to the SCGI server |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
329 and the response will not be cached. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
330 </para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
331 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
332 </directive> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
333 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
334 |
1180 | 335 <directive name="scgi_cache_methods"> |
336 <syntax> | |
337 <literal>GET</literal> | | |
338 <literal>HEAD</literal> | | |
339 <literal>POST</literal> | |
340 ...</syntax> | |
341 <default>GET HEAD</default> | |
342 <context>http</context> | |
343 <context>server</context> | |
344 <context>location</context> | |
345 | |
346 <para> | |
347 If the client request method is listed in this directive then | |
348 the response will be cached. | |
349 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always | |
350 added to the list, though it is recommended to specify them explicitly. | |
351 See also the <link id="scgi_no_cache"/> directive. | |
352 </para> | |
353 | |
354 </directive> | |
355 | |
356 | |
357 <directive name="scgi_cache_min_uses"> | |
358 <syntax><value>number</value></syntax> | |
359 <default>1</default> | |
360 <context>http</context> | |
361 <context>server</context> | |
362 <context>location</context> | |
363 | |
364 <para> | |
365 Sets the <value>number</value> of requests after which the response | |
366 will be cached. | |
367 </para> | |
368 | |
369 </directive> | |
370 | |
371 | |
372 <directive name="scgi_cache_path"> | |
373 <syntax> | |
374 <value>path</value> | |
375 [<literal>levels</literal>=<value>levels</value>] | |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
376 [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>] |
1180 | 377 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> |
378 [<literal>inactive</literal>=<value>time</value>] | |
379 [<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
|
380 [<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
|
381 [<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
|
382 [<literal>manager_threshold</literal>=<value>time</value>] |
1180 | 383 [<literal>loader_files</literal>=<value>number</value>] |
384 [<literal>loader_sleep</literal>=<value>time</value>] | |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
385 [<literal>loader_threshold</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
386 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
387 [<literal>purger_files</literal>=<value>number</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
388 [<literal>purger_sleep</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
389 [<literal>purger_threshold</literal>=<value>time</value>]</syntax> |
1180 | 390 <default/> |
391 <context>http</context> | |
392 | |
393 <para> | |
394 Sets the path and other parameters of a cache. | |
395 Cache data are stored in files. | |
1190
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
396 The file name in a cache is a result of |
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
397 applying the MD5 function to the |
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
398 <link id="scgi_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
|
399 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
|
400 from 1 to 3, each level accepts values 1 or 2. |
1180 | 401 For example, in the following configuration |
402 <example> | |
403 scgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m; | |
404 </example> | |
405 file names in a cache will look like this: | |
406 <example> | |
407 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis> | |
408 </example> | |
409 </para> | |
410 | |
411 <para> | |
412 A cached response is first written to a temporary file, | |
413 and then the file is renamed. | |
414 Starting from version 0.8.9, temporary files and the cache can be put on | |
415 different file systems. | |
416 However, be aware that in this case a file is copied | |
417 across two file systems instead of the cheap renaming operation. | |
418 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
|
419 holding temporary files |
1180 | 420 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
|
421 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
|
422 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
|
423 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
|
424 the directory set by the <link id="scgi_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
|
425 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
|
426 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
|
427 temporary files will be put directly in the cache directory. |
1180 | 428 </para> |
429 | |
430 <para> | |
431 In addition, all active keys and information about data are stored | |
432 in a shared memory zone, whose <value>name</value> and <value>size</value> | |
433 are configured by the <literal>keys_zone</literal> parameter. | |
1189
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
434 One megabyte zone can store about 8 thousand keys. |
2069
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
435 <note> |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
436 As part of |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
437 <commercial_version>commercial subscription</commercial_version>, |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
438 the shared memory zone also stores extended |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
439 cache <link doc="ngx_http_api_module.xml" id="http_caches_">information</link>, |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
440 thus, it is required to specify a larger zone size for the same number of keys. |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
441 For example, |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
442 one megabyte zone can store about 4 thousand keys. |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1991
diff
changeset
|
443 </note> |
1189
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
444 </para> |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
445 |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
446 <para> |
1180 | 447 Cached data that are not accessed during the time specified by the |
448 <literal>inactive</literal> parameter get removed from the cache | |
449 regardless of their freshness. | |
450 By default, <literal>inactive</literal> is set to 10 minutes. | |
451 </para> | |
452 | |
453 <para> | |
454 The special “cache manager” process monitors the maximum cache size set | |
455 by the <literal>max_size</literal> parameter. | |
456 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
|
457 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
|
458 <literal>manager_files</literal>, |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
459 <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
|
460 <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
|
461 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
|
462 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
|
463 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
|
464 <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
|
465 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
|
466 parameter (by default, 50 milliseconds) is made. |
1180 | 467 </para> |
468 | |
469 <para> | |
470 A minute after the start the special “cache loader” process is activated. | |
471 It loads information about previously cached data stored on file system | |
472 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
|
473 The loading is also done in iterations. |
1180 | 474 During one iteration no more than <literal>loader_files</literal> items |
475 are loaded (by default, 100). | |
476 Besides, the duration of one iteration is limited by the | |
477 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). | |
478 Between iterations, a pause configured by the <literal>loader_sleep</literal> | |
479 parameter (by default, 50 milliseconds) is made. | |
480 </para> | |
481 | |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
482 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
483 Additionally, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
484 the following parameters are available as part of our |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
485 <commercial_version>commercial subscription</commercial_version>: |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
486 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
487 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
488 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
489 <list type="tag"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
490 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
491 <tag-name id="purger"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
492 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
493 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
494 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
495 Instructs whether cache entries that match a |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
496 <link id="scgi_cache_purge">wildcard key</link> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
497 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
|
498 Setting the parameter to <literal>on</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
499 (default is <literal>off</literal>) |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
500 will activate the “cache purger” process that |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
501 permanently iterates through all cache entries |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
502 and deletes the entries that match the wildcard key. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
503 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
504 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
505 <tag-name id="purger_files"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
506 <literal>purger_files</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
507 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
508 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
509 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
|
510 By default, <literal>purger_files</literal> is set to 10. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
511 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
512 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
513 <tag-name id="purger_threshold"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
514 <literal>purger_threshold</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
515 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
516 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
517 Sets the duration of one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
518 By default, <literal>purger_threshold</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
519 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
520 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
521 <tag-name id="purger_sleep"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
522 <literal>purger_sleep</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
523 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
524 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
525 Sets a pause between iterations (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
526 By default, <literal>purger_sleep</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
527 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
528 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
529 </list> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
530 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
531 |
1973
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
532 <para> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
533 <note> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
534 In versions 1.7.3, 1.7.7, and 1.11.10 cache header format has been changed. |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
535 Previously cached responses will be considered invalid |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
536 after upgrading to a newer nginx version. |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
537 </note> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
538 </para> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
539 |
1180 | 540 </directive> |
541 | |
542 | |
543 <directive name="scgi_cache_purge"> | |
544 <syntax>string ...</syntax> | |
545 <default/> | |
546 <context>http</context> | |
547 <context>server</context> | |
548 <context>location</context> | |
549 <appeared-in>1.5.7</appeared-in> | |
550 | |
551 <para> | |
552 Defines conditions under which the request will be considered a cache | |
553 purge request. | |
554 If at least one value of the string parameters is not empty and is not equal | |
555 to “0” then the cache entry with a corresponding | |
556 <link id="scgi_cache_key">cache key</link> is removed. | |
557 The result of successful operation is indicated by returning | |
558 the <http-status code="204" text="No Content"/> response. | |
559 </para> | |
560 | |
561 <para> | |
562 If the <link id="scgi_cache_key">cache key</link> of a purge request ends | |
563 with an asterisk (“<literal>*</literal>”), all cache entries matching the | |
564 wildcard key will be removed from the cache. | |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
565 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
|
566 for either <link id="scgi_cache_path">inactivity</link>, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
567 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
|
568 or a client attempts to access them. |
1180 | 569 </para> |
570 | |
571 <para> | |
572 Example configuration: | |
573 <example> | |
574 scgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m; | |
575 | |
576 map $request_method $purge_method { | |
577 PURGE 1; | |
578 default 0; | |
579 } | |
580 | |
581 server { | |
582 ... | |
583 location / { | |
1185
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1184
diff
changeset
|
584 scgi_pass backend; |
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1184
diff
changeset
|
585 scgi_cache cache_zone; |
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1184
diff
changeset
|
586 scgi_cache_key $uri; |
1180 | 587 scgi_cache_purge $purge_method; |
588 } | |
589 } | |
590 </example> | |
591 <note> | |
592 This functionality is available as part of our | |
593 <commercial_version>commercial subscription</commercial_version>. | |
594 </note> | |
595 </para> | |
596 | |
597 </directive> | |
598 | |
599 | |
600 <directive name="scgi_cache_revalidate"> | |
601 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
602 <default>off</default> | |
603 <context>http</context> | |
604 <context>server</context> | |
605 <context>location</context> | |
606 <appeared-in>1.5.7</appeared-in> | |
607 | |
608 <para> | |
609 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:
1190
diff
changeset
|
610 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:
1190
diff
changeset
|
611 header fields. |
1180 | 612 </para> |
613 | |
614 </directive> | |
615 | |
616 | |
617 <directive name="scgi_cache_use_stale"> | |
618 <syntax> | |
619 <literal>error</literal> | | |
620 <literal>timeout</literal> | | |
621 <literal>invalid_header</literal> | | |
622 <literal>updating</literal> | | |
623 <literal>http_500</literal> | | |
624 <literal>http_503</literal> | | |
625 <literal>http_403</literal> | | |
626 <literal>http_404</literal> | | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
627 <literal>http_429</literal> | |
1180 | 628 <literal>off</literal> |
629 ...</syntax> | |
630 <default>off</default> | |
631 <context>http</context> | |
632 <context>server</context> | |
633 <context>location</context> | |
634 | |
635 <para> | |
636 Determines in which cases a stale cached response can be used | |
637 when an error occurs during communication with the SCGI server. | |
638 The directive’s parameters match the parameters of the | |
639 <link id="scgi_next_upstream"/> directive. | |
640 </para> | |
641 | |
642 <para> | |
1542
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
643 The <literal>error</literal> parameter also permits |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
644 using a stale cached response if an SCGI server to process a request |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
645 cannot be selected. |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
646 </para> |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
647 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
648 <para id="scgi_cache_use_stale_updating"> |
1180 | 649 Additionally, the <literal>updating</literal> parameter permits |
650 using a stale cached response if it is currently being updated. | |
651 This allows minimizing the number of accesses to SCGI servers | |
652 when updating cached data. | |
1912
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
653 </para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
654 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
655 <para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
656 Using a stale cached response |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
657 can also be enabled directly in the response header |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
658 for a specified number of seconds after the response became stale (1.11.10). |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
659 This has lower priority than using the directive parameters. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
660 <list type="bullet" compact="no"> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
661 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
662 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
663 The |
1910
41cf2c2d8c5c
Cache: support for stale-while-revalidate and stale-if-error.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1909
diff
changeset
|
664 “<link url="https://tools.ietf.org/html/rfc5861#section-3">stale-while-revalidate</link>” |
1912
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
665 extension of the <header>Cache-Control</header> header field permits |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
666 using a stale cached response if it is currently being updated. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
667 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
668 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
669 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
670 The |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
671 “<link url="https://tools.ietf.org/html/rfc5861#section-4">stale-if-error</link>” |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
672 extension of the <header>Cache-Control</header> header field permits |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
673 using a stale cached response in case of an error. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
674 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
675 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
676 </list> |
1180 | 677 </para> |
678 | |
679 <para> | |
680 To minimize the number of accesses to SCGI servers when | |
681 populating a new cache element, the <link id="scgi_cache_lock"/> | |
682 directive can be used. | |
683 </para> | |
684 | |
685 </directive> | |
686 | |
687 | |
688 <directive name="scgi_cache_valid"> | |
689 <syntax>[<value>code</value> ...] <value>time</value></syntax> | |
690 <default/> | |
691 <context>http</context> | |
692 <context>server</context> | |
693 <context>location</context> | |
694 | |
695 <para> | |
696 Sets caching time for different response codes. | |
697 For example, the following directives | |
698 <example> | |
699 scgi_cache_valid 200 302 10m; | |
700 scgi_cache_valid 404 1m; | |
701 </example> | |
702 set 10 minutes of caching for responses with codes 200 and 302 | |
703 and 1 minute for responses with code 404. | |
704 </para> | |
705 | |
706 <para> | |
707 If only caching <value>time</value> is specified | |
708 <example> | |
709 scgi_cache_valid 5m; | |
710 </example> | |
711 then only 200, 301, and 302 responses are cached. | |
712 </para> | |
713 | |
714 <para> | |
715 In addition, the <literal>any</literal> parameter can be specified | |
716 to cache any responses: | |
717 <example> | |
718 scgi_cache_valid 200 302 10m; | |
719 scgi_cache_valid 301 1h; | |
720 scgi_cache_valid any 1m; | |
721 </example> | |
722 </para> | |
723 | |
724 <para> | |
725 Parameters of caching can also be set directly | |
726 in the response header. | |
727 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
|
728 <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
|
729 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
730 <listitem> |
1180 | 731 The <header>X-Accel-Expires</header> header field sets caching time of a |
732 response in seconds. | |
733 The zero value disables caching for a response. | |
734 If the value starts with the <literal>@</literal> prefix, it sets an absolute | |
735 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
|
736 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
737 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
738 <listitem> |
1180 | 739 If the header does not include the <header>X-Accel-Expires</header> field, |
740 parameters of caching may be set in the header fields | |
741 <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
|
742 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
743 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
744 <listitem> |
1180 | 745 If the header includes the <header>Set-Cookie</header> field, such a |
746 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
|
747 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
748 |
1353
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
749 <listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
750 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
|
751 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
|
752 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
|
753 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
|
754 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
|
755 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
|
756 </listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
757 |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
758 </list> |
1180 | 759 Processing of one or more of these response header fields can be disabled |
760 using the <link id="scgi_ignore_headers"/> directive. | |
761 </para> | |
762 | |
763 </directive> | |
764 | |
765 | |
766 <directive name="scgi_connect_timeout"> | |
767 <syntax><value>time</value></syntax> | |
768 <default>60s</default> | |
769 <context>http</context> | |
770 <context>server</context> | |
771 <context>location</context> | |
772 | |
773 <para> | |
774 Defines a timeout for establishing a connection with an SCGI server. | |
775 It should be noted that this timeout cannot usually exceed 75 seconds. | |
776 </para> | |
777 | |
778 </directive> | |
779 | |
780 | |
1337
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
781 <directive name="scgi_force_ranges"> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
782 <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
|
783 <default>off</default> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
784 <context>http</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
785 <context>server</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
786 <context>location</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
787 <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
|
788 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
789 <para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
790 Enables byte-range support |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
791 for both cached and uncached responses from the SCGI server |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
792 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
|
793 </para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
794 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
795 </directive> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
796 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
797 |
1180 | 798 <directive name="scgi_hide_header"> |
799 <syntax><value>field</value></syntax> | |
800 <default/> | |
801 <context>http</context> | |
802 <context>server</context> | |
803 <context>location</context> | |
804 | |
805 <para> | |
806 By default, | |
807 nginx does not pass the header fields <header>Status</header> and | |
808 <header>X-Accel-...</header> from the response of an SCGI | |
809 server to a client. | |
810 The <literal>scgi_hide_header</literal> directive sets additional fields | |
811 that will not be passed. | |
812 If, on the contrary, the passing of fields needs to be permitted, | |
813 the <link id="scgi_pass_header"/> directive can be used. | |
814 </para> | |
815 | |
816 </directive> | |
817 | |
818 | |
819 <directive name="scgi_ignore_client_abort"> | |
820 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
821 <default>off</default> | |
822 <context>http</context> | |
823 <context>server</context> | |
824 <context>location</context> | |
825 | |
826 <para> | |
827 Determines whether the connection with an SCGI server should be | |
828 closed when a client closes the connection without waiting | |
829 for a response. | |
830 </para> | |
831 | |
832 </directive> | |
833 | |
834 | |
835 <directive name="scgi_ignore_headers"> | |
836 <syntax><value>field</value> ...</syntax> | |
837 <default/> | |
838 <context>http</context> | |
839 <context>server</context> | |
840 <context>location</context> | |
841 | |
842 <para> | |
843 Disables processing of certain response header fields from the SCGI server. | |
844 The following fields can be ignored: <header>X-Accel-Redirect</header>, | |
845 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6), | |
846 <header>X-Accel-Buffering</header> (1.1.6), | |
847 <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
|
848 <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
|
849 and <header>Vary</header> (1.7.7). |
1180 | 850 </para> |
851 | |
852 <para> | |
853 If not disabled, processing of these header fields has the following | |
854 effect: | |
855 <list type="bullet" compact="no"> | |
856 | |
857 <listitem> | |
858 <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
|
859 <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
|
860 and <header>Vary</header> |
1180 | 861 set the parameters of response <link id="scgi_cache_valid">caching</link>; |
862 </listitem> | |
863 | |
864 <listitem> | |
865 <header>X-Accel-Redirect</header> performs an | |
866 <link doc="ngx_http_core_module.xml" id="internal">internal | |
867 redirect</link> to the specified URI; | |
868 </listitem> | |
869 | |
870 <listitem> | |
871 <header>X-Accel-Limit-Rate</header> sets the | |
872 <link doc="ngx_http_core_module.xml" id="limit_rate">rate | |
873 limit</link> for transmission of a response to a client; | |
874 </listitem> | |
875 | |
876 <listitem> | |
877 <header>X-Accel-Buffering</header> enables or disables | |
878 <link id="scgi_buffering">buffering</link> of a response; | |
879 </listitem> | |
880 | |
881 <listitem> | |
882 <header>X-Accel-Charset</header> sets the desired | |
883 <link doc="ngx_http_charset_module.xml" id="charset"/> | |
884 of a response. | |
885 </listitem> | |
886 | |
887 </list> | |
888 </para> | |
889 | |
890 </directive> | |
891 | |
892 | |
893 <directive name="scgi_intercept_errors"> | |
894 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
895 <default>off</default> | |
896 <context>http</context> | |
897 <context>server</context> | |
898 <context>location</context> | |
899 | |
900 <para> | |
901 Determines whether an SCGI 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
|
902 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
|
903 or be intercepted and redirected to nginx for processing |
1180 | 904 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive. |
905 </para> | |
906 | |
907 </directive> | |
908 | |
909 | |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
910 <directive name="scgi_limit_rate"> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
911 <syntax><value>rate</value></syntax> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
912 <default>0</default> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
913 <context>http</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
914 <context>server</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
915 <context>location</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
916 <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
|
917 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
918 <para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
919 Limits the speed of reading the response from the SCGI server. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
920 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
|
921 The zero value disables rate limiting. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
922 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
|
923 two connections to the SCGI server, |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
924 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
|
925 The limitation works only if |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
926 <link id="scgi_buffering">buffering</link> of responses from the SCGI |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
927 server is enabled. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
928 </para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
929 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
930 </directive> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
931 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
932 |
1180 | 933 <directive name="scgi_max_temp_file_size"> |
934 <syntax><value>size</value></syntax> | |
935 <default>1024m</default> | |
936 <context>http</context> | |
937 <context>server</context> | |
938 <context>location</context> | |
939 | |
940 <para> | |
941 When <link id="scgi_buffering">buffering</link> of responses from the SCGI | |
942 server is enabled, and the whole response does not fit into the buffers | |
943 set by the <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> | |
944 directives, a part of the response can be saved to a temporary file. | |
945 This directive sets the maximum <value>size</value> of the temporary file. | |
946 The size of data written to the temporary file at a time is set | |
947 by the <link id="scgi_temp_file_write_size"/> directive. | |
948 </para> | |
949 | |
950 <para> | |
951 The zero value disables buffering of responses to temporary files. | |
952 </para> | |
953 | |
1352
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
954 <para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
955 <note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
956 This restriction does not apply to responses |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
957 that will be <link id="scgi_cache">cached</link> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
958 or <link id="scgi_store">stored</link> on disk. |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
959 </note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
960 </para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
961 |
1180 | 962 </directive> |
963 | |
964 | |
965 <directive name="scgi_next_upstream"> | |
966 <syntax> | |
967 <literal>error</literal> | | |
968 <literal>timeout</literal> | | |
969 <literal>invalid_header</literal> | | |
970 <literal>http_500</literal> | | |
971 <literal>http_503</literal> | | |
972 <literal>http_403</literal> | | |
973 <literal>http_404</literal> | | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
974 <literal>http_429</literal> | |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
975 <literal>non_idempotent</literal> | |
1180 | 976 <literal>off</literal> |
977 ...</syntax> | |
978 <default>error timeout</default> | |
979 <context>http</context> | |
980 <context>server</context> | |
981 <context>location</context> | |
982 | |
983 <para> | |
984 Specifies in which cases a request should be passed to the next server: | |
985 <list type="tag"> | |
986 | |
987 <tag-name><literal>error</literal></tag-name> | |
988 <tag-desc>an error occurred while establishing a connection with the | |
989 server, passing a request to it, or reading the response header;</tag-desc> | |
990 | |
991 <tag-name><literal>timeout</literal></tag-name> | |
992 <tag-desc>a timeout has occurred while establishing a connection with the | |
993 server, passing a request to it, or reading the response header;</tag-desc> | |
994 | |
995 <tag-name><literal>invalid_header</literal></tag-name> | |
996 <tag-desc>a server returned an empty or invalid response;</tag-desc> | |
997 | |
998 <tag-name><literal>http_500</literal></tag-name> | |
999 <tag-desc>a server returned a response with the code 500;</tag-desc> | |
1000 | |
1001 <tag-name><literal>http_503</literal></tag-name> | |
1002 <tag-desc>a server returned a response with the code 503;</tag-desc> | |
1003 | |
1004 <tag-name><literal>http_403</literal></tag-name> | |
1005 <tag-desc>a server returned a response with the code 403;</tag-desc> | |
1006 | |
1007 <tag-name><literal>http_404</literal></tag-name> | |
1008 <tag-desc>a server returned a response with the code 404;</tag-desc> | |
1009 | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1010 <tag-name><literal>http_429</literal></tag-name> |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1011 <tag-desc>a server returned a response with the code 429 (1.11.13);</tag-desc> |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1012 |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1013 <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
|
1014 <tag-desc>normally, requests with a |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
1015 <link url="https://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link> |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1016 method |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1017 (<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
|
1018 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
|
1019 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
|
1020 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
|
1021 </tag-desc> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1022 |
1180 | 1023 <tag-name><literal>off</literal></tag-name> |
1024 <tag-desc>disables passing a request to the next server.</tag-desc> | |
1025 | |
1026 </list> | |
1027 </para> | |
1028 | |
1029 <para> | |
1030 One should bear in mind that passing a request to the next server is | |
1031 only possible if nothing has been sent to a client yet. | |
1032 That is, if an error or timeout occurs in the middle of the | |
1033 transferring of a response, fixing this is impossible. | |
1034 </para> | |
1035 | |
1036 <para> | |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1037 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
|
1038 <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
|
1039 attempt</link> of communication with a server. |
1180 | 1040 The cases of <literal>error</literal>, <literal>timeout</literal> and |
1041 <literal>invalid_header</literal> are always considered unsuccessful attempts, | |
1042 even if they are not specified in the directive. | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1043 The cases of <literal>http_500</literal>, <literal>http_503</literal>, |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1044 and <literal>http_429</literal> are |
1180 | 1045 considered unsuccessful attempts only if they are specified in the directive. |
1046 The cases of <literal>http_403</literal> and <literal>http_404</literal> | |
1047 are never considered unsuccessful attempts. | |
1048 </para> | |
1049 | |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1050 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1051 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
|
1052 <link id="scgi_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
|
1053 and by <link id="scgi_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
|
1054 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1055 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1056 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1057 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1058 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1059 <directive name="scgi_next_upstream_timeout"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1060 <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
|
1061 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1062 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1063 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1064 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1065 <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
|
1066 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1067 <para> |
1672
9c98c4498f08
Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1669
diff
changeset
|
1068 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
|
1069 <link id="scgi_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
|
1070 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
|
1071 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1072 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1073 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1074 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1075 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1076 <directive name="scgi_next_upstream_tries"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1077 <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
|
1078 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1079 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1080 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1081 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1082 <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
|
1083 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1084 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1085 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
|
1086 <link id="scgi_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
|
1087 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
|
1088 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1089 |
1180 | 1090 </directive> |
1091 | |
1092 | |
1093 <directive name="scgi_no_cache"> | |
1094 <syntax><value>string</value> ...</syntax> | |
1095 <default/> | |
1096 <context>http</context> | |
1097 <context>server</context> | |
1098 <context>location</context> | |
1099 | |
1100 <para> | |
1101 Defines conditions under which the response will not be saved to a cache. | |
1102 If at least one value of the string parameters is not empty and is not | |
1103 equal to “0” then the response will not be saved: | |
1104 <example> | |
1105 scgi_no_cache $cookie_nocache $arg_nocache$arg_comment; | |
1106 scgi_no_cache $http_pragma $http_authorization; | |
1107 </example> | |
1108 Can be used along with the <link id="scgi_cache_bypass"/> directive. | |
1109 </para> | |
1110 | |
1111 </directive> | |
1112 | |
1113 | |
1114 <directive name="scgi_param"> | |
1115 <syntax> | |
1116 <value>parameter</value> <value>value</value> | |
1117 [<literal>if_not_empty</literal>]</syntax> | |
1118 <default/> | |
1119 <context>http</context> | |
1120 <context>server</context> | |
1121 <context>location</context> | |
1122 | |
1123 <para> | |
1124 Sets a <value>parameter</value> that should be passed to the SCGI server. | |
1125 The <value>value</value> can contain text, variables, and their combination. | |
1126 These directives are inherited from the previous level if and | |
1127 only if there are no | |
1128 <literal>scgi_param</literal> | |
1129 directives defined on the current level. | |
1130 </para> | |
1131 | |
1132 <para> | |
1133 Standard | |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
1134 <link url="https://tools.ietf.org/html/rfc3875#section-4.1">CGI |
1180 | 1135 environment variables</link> |
1136 should be provided as SCGI headers, see the <path>scgi_params</path> file | |
1137 provided in the distribution: | |
1138 <example> | |
1139 location / { | |
1140 include scgi_params; | |
1141 ... | |
1142 } | |
1143 </example> | |
1144 </para> | |
1145 | |
1182
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
1146 <para> |
1731
ae6bdb65ca7f
Corrected article in fastcgi_param and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
1147 If the directive is specified with <literal>if_not_empty</literal> (1.1.11) then |
2083
fb5eef3637a4
Avoid double negative in if_not_empty.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2069
diff
changeset
|
1148 such a parameter will be passed to the server only if its value is not empty: |
1182
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
1149 <example> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
1150 scgi_param HTTPS $https if_not_empty; |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
1151 </example> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
1152 </para> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
1153 |
1180 | 1154 </directive> |
1155 | |
1156 | |
1157 <directive name="scgi_pass"> | |
1158 <syntax><value>address</value></syntax> | |
1159 <default/> | |
1160 <context>location</context> | |
1161 <context>if in location</context> | |
1162 | |
1163 <para> | |
1164 Sets the address of an SCGI server. | |
1165 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
|
1166 and a port: |
1180 | 1167 <example> |
1168 scgi_pass localhost:9000; | |
1169 </example> | |
1170 or as a UNIX-domain socket path: | |
1171 <example> | |
1172 scgi_pass unix:/tmp/scgi.socket; | |
1173 </example> | |
1174 </para> | |
1175 | |
1176 <para> | |
1177 If a domain name resolves to several addresses, all of them will be | |
1178 used in a round-robin fashion. | |
1179 In addition, an address can be specified as a | |
1180 <link doc="ngx_http_upstream_module.xml">server group</link>. | |
1181 </para> | |
1182 | |
1991
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1183 <para> |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1184 Parameter value can contain variables. |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1185 In this case, if an address is specified as a domain name, |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1186 the name is searched among the described |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1187 <link doc="ngx_http_upstream_module.xml">server groups</link>, |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1188 and, if not found, is determined using a |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1189 <link doc="ngx_http_core_module.xml" id="resolver"/>. |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1190 </para> |
4f3dd2f548cf
Documented variables in fastcgi_pass, scgi_pass, and uwsgi_pass.
Ruslan Ermilov <ru@nginx.com>
parents:
1973
diff
changeset
|
1191 |
1180 | 1192 </directive> |
1193 | |
1194 | |
1195 <directive name="scgi_pass_header"> | |
1196 <syntax><value>field</value></syntax> | |
1197 <default/> | |
1198 <context>http</context> | |
1199 <context>server</context> | |
1200 <context>location</context> | |
1201 | |
1202 <para> | |
1203 Permits passing <link id="scgi_hide_header">otherwise disabled</link> header | |
1204 fields from an SCGI server to a client. | |
1205 </para> | |
1206 | |
1207 </directive> | |
1208 | |
1209 | |
1210 <directive name="scgi_pass_request_body"> | |
1211 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
1212 <default>on</default> | |
1213 <context>http</context> | |
1214 <context>server</context> | |
1215 <context>location</context> | |
1216 | |
1217 <para> | |
1218 Indicates whether the original request body is passed | |
1219 to the SCGI server. | |
1220 See also the <link id="scgi_pass_request_headers"/> directive. | |
1221 </para> | |
1222 | |
1223 </directive> | |
1224 | |
1225 | |
1226 <directive name="scgi_pass_request_headers"> | |
1227 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
1228 <default>on</default> | |
1229 <context>http</context> | |
1230 <context>server</context> | |
1231 <context>location</context> | |
1232 | |
1233 <para> | |
1234 Indicates whether the header fields of the original request are passed | |
1235 to the SCGI server. | |
1236 See also the <link id="scgi_pass_request_body"/> directive. | |
1237 </para> | |
1238 | |
1239 </directive> | |
1240 | |
1241 | |
1524
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1242 <directive name="scgi_read_timeout"> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1243 <syntax><value>time</value></syntax> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1244 <default>60s</default> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1245 <context>http</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1246 <context>server</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1247 <context>location</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1248 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1249 <para> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1250 Defines a timeout for reading a response from the SCGI server. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1251 The timeout is set only between two successive read operations, |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1252 not for the transmission of the whole response. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1253 If the SCGI server does not transmit anything within this time, |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1254 the connection is closed. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1255 </para> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1256 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1257 </directive> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1258 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1443
diff
changeset
|
1259 |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1260 <directive name="scgi_request_buffering"> |
1659
680cbf783efe
Fixed some misuses of "value".
Ruslan Ermilov <ru@nginx.com>
parents:
1620
diff
changeset
|
1261 <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
|
1262 <default>on</default> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1263 <context>http</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1264 <context>server</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1265 <context>location</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1266 <appeared-in>1.7.11</appeared-in> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1267 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1268 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1269 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
|
1270 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1271 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1272 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1273 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
|
1274 <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
|
1275 from the client before sending the request to an SCGI server. |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1276 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1277 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1278 <para> |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1279 When buffering is disabled, the request body is sent to the SCGI server |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1280 immediately as it is received. |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1281 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
|
1282 <link id="scgi_next_upstream">next server</link> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1283 if nginx already started sending the request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1284 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1285 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1286 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1287 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
|
1288 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
|
1289 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
|
1290 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1291 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1292 </directive> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1293 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1294 |
1180 | 1295 <directive name="scgi_send_timeout"> |
1296 <syntax><value>time</value></syntax> | |
1297 <default>60s</default> | |
1298 <context>http</context> | |
1299 <context>server</context> | |
1300 <context>location</context> | |
1301 | |
1302 <para> | |
1303 Sets a timeout for transmitting a request to the SCGI server. | |
1304 The timeout is set only between two successive write operations, | |
1305 not for the transmission of the whole request. | |
1306 If the SCGI server does not receive anything within this time, | |
1307 the connection is closed. | |
1308 </para> | |
1309 | |
1310 </directive> | |
1311 | |
1312 | |
2254
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1313 <directive name="scgi_socket_keepalive"> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1314 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1315 <default>off</default> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1316 <context>http</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1317 <context>server</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1318 <context>location</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1319 <appeared-in>1.15.6</appeared-in> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1320 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1321 <para> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1322 Configures the “TCP keepalive” behavior |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1323 for outgoing connections to an SCGI server. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1324 By default, the operating system’s settings are in effect for the socket. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1325 If the directive is set to the value “<literal>on</literal>”, the |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1326 <c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1327 </para> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1328 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1329 </directive> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1330 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
1331 |
1180 | 1332 <directive name="scgi_store"> |
1333 <syntax> | |
1334 <literal>on</literal> | | |
1335 <literal>off</literal> | | |
1336 <value>string</value></syntax> | |
1337 <default>off</default> | |
1338 <context>http</context> | |
1339 <context>server</context> | |
1340 <context>location</context> | |
1341 | |
1342 <para> | |
1343 Enables saving of files to a disk. | |
1344 The <literal>on</literal> parameter saves files with paths | |
1345 corresponding to the directives | |
1346 <link doc="ngx_http_core_module.xml" id="alias"/> or | |
1347 <link doc="ngx_http_core_module.xml" id="root"/>. | |
1348 The <literal>off</literal> parameter disables saving of files. | |
1349 In addition, the file name can be set explicitly using the | |
1350 <value>string</value> with variables: | |
1351 <example> | |
1352 scgi_store /data/www$original_uri; | |
1353 </example> | |
1354 </para> | |
1355 | |
1356 <para> | |
1357 The modification time of files is set according to the received | |
1358 <header>Last-Modified</header> response header field. | |
1359 The response is first written to a temporary file, | |
1360 and then the file is renamed. | |
1361 Starting from version 0.8.9, temporary files and the persistent store | |
1362 can be put on different file systems. | |
1363 However, be aware that in this case a file is copied | |
1364 across two file systems instead of the cheap renaming operation. | |
1365 It is thus recommended that for any given location both saved files and a | |
1366 directory holding temporary files, set by the <link id="scgi_temp_path"/> | |
1367 directive, are put on the same file system. | |
1368 </para> | |
1369 | |
1370 <para> | |
1371 This directive can be used to create local copies of static unchangeable | |
1372 files, e.g.: | |
1373 <example> | |
1374 location /images/ { | |
1184
55857cbf562d
Fixed alignment issues after mechanical conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1182
diff
changeset
|
1375 root /data/www; |
55857cbf562d
Fixed alignment issues after mechanical conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1182
diff
changeset
|
1376 error_page 404 = /fetch$uri; |
1180 | 1377 } |
1378 | |
1379 location /fetch/ { | |
1380 internal; | |
1381 | |
1382 scgi_pass backend:9000; | |
1383 ... | |
1384 | |
1385 scgi_store on; | |
1386 scgi_store_access user:rw group:rw all:r; | |
1387 scgi_temp_path /data/temp; | |
1388 | |
1184
55857cbf562d
Fixed alignment issues after mechanical conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1182
diff
changeset
|
1389 alias /data/www/; |
1180 | 1390 } |
1391 </example> | |
1392 </para> | |
1393 | |
1394 </directive> | |
1395 | |
1396 | |
1397 <directive name="scgi_store_access"> | |
1398 <syntax><value>users</value>:<value>permissions</value> ...</syntax> | |
1399 <default>user:rw</default> | |
1400 <context>http</context> | |
1401 <context>server</context> | |
1402 <context>location</context> | |
1403 | |
1404 <para> | |
1405 Sets access permissions for newly created files and directories, e.g.: | |
1406 <example> | |
1407 scgi_store_access user:rw group:rw all:r; | |
1408 </example> | |
1409 </para> | |
1410 | |
1411 <para> | |
1412 If any <literal>group</literal> or <literal>all</literal> access permissions | |
1413 are specified then <literal>user</literal> permissions may be omitted: | |
1414 <example> | |
1415 scgi_store_access group:rw all:r; | |
1416 </example> | |
1417 </para> | |
1418 | |
1419 </directive> | |
1420 | |
1421 | |
1422 <directive name="scgi_temp_file_write_size"> | |
1423 <syntax><value>size</value></syntax> | |
1424 <default>8k|16k</default> | |
1425 <context>http</context> | |
1426 <context>server</context> | |
1427 <context>location</context> | |
1428 | |
1429 <para> | |
1430 Limits the <value>size</value> of data written to a temporary file | |
1431 at a time, when buffering of responses from the SCGI server | |
1432 to temporary files is enabled. | |
1433 By default, <value>size</value> is limited by two buffers set by the | |
1434 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives. | |
1435 The maximum size of a temporary file is set by the | |
1436 <link id="scgi_max_temp_file_size"/> directive. | |
1437 </para> | |
1438 | |
1439 </directive> | |
1440 | |
1441 | |
1442 <directive name="scgi_temp_path"> | |
1443 <syntax> | |
1444 <value>path</value> | |
1445 [<value>level1</value> | |
1446 [<value>level2</value> | |
1447 [<value>level3</value>]]]</syntax> | |
1448 <default>scgi_temp</default> | |
1449 <context>http</context> | |
1450 <context>server</context> | |
1451 <context>location</context> | |
1452 | |
1453 <para> | |
1454 Defines a directory for storing temporary files | |
1455 with data received from SCGI servers. | |
1456 Up to three-level subdirectory hierarchy can be used underneath the specified | |
1457 directory. | |
1458 For example, in the following configuration | |
1459 <example> | |
1460 scgi_temp_path /spool/nginx/scgi_temp 1 2; | |
1461 </example> | |
1462 a temporary file might look like this: | |
1463 <example> | |
1464 /spool/nginx/scgi_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis> | |
1465 </example> | |
1466 </para> | |
1467 | |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1468 <para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1469 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
|
1470 <link id="scgi_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
|
1471 </para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1472 |
1180 | 1473 </directive> |
1474 | |
1475 </section> | |
1476 | |
1477 </module> |