Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_scgi_module.xml @ 1379:91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Fri, 19 Dec 2014 12:26:10 +0300 |
parents | 25db29c8875e |
children | 94cac978bda3 |
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" | |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
13 rev="13"> |
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"> | |
42 <syntax><value>address</value> | <literal>off</literal></syntax> | |
43 <default/> | |
44 <context>http</context> | |
45 <context>server</context> | |
46 <context>location</context> | |
47 | |
48 <para> | |
49 Makes outgoing connections to an SCGI server originate | |
50 from the specified local IP <value>address</value>. | |
51 Parameter value can contain variables (1.3.12). | |
52 The special value <literal>off</literal> (1.3.12) cancels the effect | |
53 of the <literal>scgi_bind</literal> directive | |
54 inherited from the previous configuration level, which allows the | |
55 system to auto-assign the local IP address. | |
56 </para> | |
57 | |
58 </directive> | |
59 | |
60 | |
61 <directive name="scgi_buffer_size"> | |
62 <syntax><value>size</value></syntax> | |
63 <default>4k|8k</default> | |
64 <context>http</context> | |
65 <context>server</context> | |
66 <context>location</context> | |
67 | |
68 <para> | |
69 Sets the <value>size</value> of the buffer used for reading the first part | |
70 of the response received from the SCGI server. | |
71 This part usually contains a small response header. | |
72 By default, the buffer size is equal to the size of one | |
73 buffer set by the <link id="scgi_buffers"/> directive. | |
74 It can be made smaller, however. | |
75 </para> | |
76 | |
77 </directive> | |
78 | |
79 | |
80 <directive name="scgi_buffering"> | |
81 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
82 <default>on</default> | |
83 <context>http</context> | |
84 <context>server</context> | |
85 <context>location</context> | |
86 | |
87 <para> | |
88 Enables or disables buffering of responses from the SCGI server. | |
89 </para> | |
90 | |
91 <para> | |
92 When buffering is enabled, nginx receives a response from the SCGI server | |
93 as soon as possible, saving it into the buffers set by the | |
94 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives. | |
95 If the whole response does not fit into memory, a part of it can be saved | |
96 to a <link id="scgi_temp_path">temporary file</link> on the disk. | |
97 Writing to temporary files is controlled by the | |
98 <link id="scgi_max_temp_file_size"/> and | |
99 <link id="scgi_temp_file_write_size"/> directives. | |
100 </para> | |
101 | |
102 <para> | |
103 When buffering is disabled, the response is passed to a client synchronously, | |
104 immediately as it is received. | |
105 nginx will not try to read the whole response from the SCGI server. | |
106 The maximum size of the data that nginx can receive from the server | |
107 at a time is set by the <link id="scgi_buffer_size"/> directive. | |
108 </para> | |
109 | |
110 <para> | |
111 Buffering can also be enabled or disabled by passing | |
112 “<literal>yes</literal>” or “<literal>no</literal>” in the | |
113 <header>X-Accel-Buffering</header> response header field. | |
114 This capability can be disabled using the | |
115 <link id="scgi_ignore_headers"/> directive. | |
116 </para> | |
117 | |
118 </directive> | |
119 | |
120 | |
121 <directive name="scgi_buffers"> | |
122 <syntax><value>number</value> <value>size</value></syntax> | |
123 <default>8 4k|8k</default> | |
124 <context>http</context> | |
125 <context>server</context> | |
126 <context>location</context> | |
127 | |
128 <para> | |
129 Sets the <value>number</value> and <value>size</value> of the | |
130 buffers used for reading a response from the SCGI server, | |
131 for a single connection. | |
132 By default, the buffer size is equal to one memory page. | |
133 This is either 4K or 8K, depending on a platform. | |
134 </para> | |
135 | |
136 </directive> | |
137 | |
138 | |
139 <directive name="scgi_busy_buffers_size"> | |
140 <syntax><value>size</value></syntax> | |
141 <default>8k|16k</default> | |
142 <context>http</context> | |
143 <context>server</context> | |
144 <context>location</context> | |
145 | |
146 <para> | |
147 When <link id="scgi_buffering">buffering</link> of responses from the SCGI | |
148 server is enabled, limits the total <value>size</value> of buffers that | |
149 can be busy sending a response to the client while the response is not | |
150 yet fully read. | |
151 In the meantime, the rest of the buffers can be used for reading the response | |
152 and, if needed, buffering part of the response to a temporary file. | |
153 By default, <value>size</value> is limited by the size of two buffers set by the | |
154 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives. | |
155 </para> | |
156 | |
157 </directive> | |
158 | |
159 | |
160 <directive name="scgi_cache"> | |
161 <syntax><value>zone</value> | <literal>off</literal></syntax> | |
162 <default>off</default> | |
163 <context>http</context> | |
164 <context>server</context> | |
165 <context>location</context> | |
166 | |
167 <para> | |
168 Defines a shared memory zone used for caching. | |
169 The same zone can be used in several places. | |
170 The <literal>off</literal> parameter disables caching inherited | |
171 from the previous configuration level. | |
172 </para> | |
173 | |
174 </directive> | |
175 | |
176 | |
177 <directive name="scgi_cache_bypass"> | |
178 <syntax><value>string</value> ...</syntax> | |
179 <default/> | |
180 <context>http</context> | |
181 <context>server</context> | |
182 <context>location</context> | |
183 | |
184 <para> | |
185 Defines conditions under which the response will not be taken from a cache. | |
186 If at least one value of the string parameters is not empty and is not | |
187 equal to “0” then the response will not be taken from the cache: | |
188 <example> | |
189 scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment; | |
190 scgi_cache_bypass $http_pragma $http_authorization; | |
191 </example> | |
192 Can be used along with the <link id="scgi_no_cache"/> directive. | |
193 </para> | |
194 | |
195 </directive> | |
196 | |
197 | |
198 <directive name="scgi_cache_key"> | |
199 <syntax><value>string</value></syntax> | |
200 <default/> | |
201 <context>http</context> | |
202 <context>server</context> | |
203 <context>location</context> | |
204 | |
205 <para> | |
206 Defines a key for caching, for example | |
207 <example> | |
208 scgi_cache_key localhost:9000$request_uri; | |
209 </example> | |
210 </para> | |
211 | |
212 </directive> | |
213 | |
214 | |
215 <directive name="scgi_cache_lock"> | |
216 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
217 <default>off</default> | |
218 <context>http</context> | |
219 <context>server</context> | |
220 <context>location</context> | |
221 <appeared-in>1.1.12</appeared-in> | |
222 | |
223 <para> | |
224 When enabled, only one request at a time will be allowed to populate | |
225 a new cache element identified according to the <link id="scgi_cache_key"/> | |
226 directive by passing a request to an SCGI server. | |
227 Other requests of the same cache element will either wait | |
228 for a response to appear in the cache or the cache lock for | |
229 this element to be released, up to the time set by the | |
230 <link id="scgi_cache_lock_timeout"/> directive. | |
231 </para> | |
232 | |
233 </directive> | |
234 | |
235 | |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
236 <directive name="scgi_cache_lock_age"> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
237 <syntax><value>time</value></syntax> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
238 <default>5s</default> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
239 <context>http</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
240 <context>server</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
241 <context>location</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
242 <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
|
243 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
244 <para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
245 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
|
246 for populating a new cache element |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
247 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
|
248 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
|
249 </para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
250 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
251 </directive> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
252 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
253 |
1180 | 254 <directive name="scgi_cache_lock_timeout"> |
255 <syntax><value>time</value></syntax> | |
256 <default>5s</default> | |
257 <context>http</context> | |
258 <context>server</context> | |
259 <context>location</context> | |
260 <appeared-in>1.1.12</appeared-in> | |
261 | |
262 <para> | |
263 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
|
264 When the <value>time</value> expires, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
265 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
|
266 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
|
267 <note> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
268 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
|
269 </note> |
1180 | 270 </para> |
271 | |
272 </directive> | |
273 | |
274 | |
275 <directive name="scgi_cache_methods"> | |
276 <syntax> | |
277 <literal>GET</literal> | | |
278 <literal>HEAD</literal> | | |
279 <literal>POST</literal> | |
280 ...</syntax> | |
281 <default>GET HEAD</default> | |
282 <context>http</context> | |
283 <context>server</context> | |
284 <context>location</context> | |
285 | |
286 <para> | |
287 If the client request method is listed in this directive then | |
288 the response will be cached. | |
289 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always | |
290 added to the list, though it is recommended to specify them explicitly. | |
291 See also the <link id="scgi_no_cache"/> directive. | |
292 </para> | |
293 | |
294 </directive> | |
295 | |
296 | |
297 <directive name="scgi_cache_min_uses"> | |
298 <syntax><value>number</value></syntax> | |
299 <default>1</default> | |
300 <context>http</context> | |
301 <context>server</context> | |
302 <context>location</context> | |
303 | |
304 <para> | |
305 Sets the <value>number</value> of requests after which the response | |
306 will be cached. | |
307 </para> | |
308 | |
309 </directive> | |
310 | |
311 | |
312 <directive name="scgi_cache_path"> | |
313 <syntax> | |
314 <value>path</value> | |
315 [<literal>levels</literal>=<value>levels</value>] | |
316 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> | |
317 [<literal>inactive</literal>=<value>time</value>] | |
318 [<literal>max_size</literal>=<value>size</value>] | |
319 [<literal>loader_files</literal>=<value>number</value>] | |
320 [<literal>loader_sleep</literal>=<value>time</value>] | |
321 [<literal>loader_threshold</literal>=<value>time</value>]</syntax> | |
322 <default/> | |
323 <context>http</context> | |
324 | |
325 <para> | |
326 Sets the path and other parameters of a cache. | |
327 Cache data are stored in files. | |
1190
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
328 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
|
329 applying the MD5 function to the |
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
330 <link id="scgi_cache_key">cache key</link>. |
1180 | 331 The <literal>levels</literal> parameter defines hierarchy levels of a cache. |
332 For example, in the following configuration | |
333 <example> | |
334 scgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m; | |
335 </example> | |
336 file names in a cache will look like this: | |
337 <example> | |
338 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis> | |
339 </example> | |
340 </para> | |
341 | |
342 <para> | |
343 A cached response is first written to a temporary file, | |
344 and then the file is renamed. | |
345 Starting from version 0.8.9, temporary files and the cache can be put on | |
346 different file systems. | |
347 However, be aware that in this case a file is copied | |
348 across two file systems instead of the cheap renaming operation. | |
349 It is thus recommended that for any given location both cache and a directory | |
350 holding temporary files, set by the <link id="scgi_temp_path"/> directive, | |
351 are put on the same file system. | |
352 </para> | |
353 | |
354 <para> | |
355 In addition, all active keys and information about data are stored | |
356 in a shared memory zone, whose <value>name</value> and <value>size</value> | |
357 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
|
358 One megabyte zone can store about 8 thousand keys. |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
359 </para> |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
360 |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
361 <para> |
1180 | 362 Cached data that are not accessed during the time specified by the |
363 <literal>inactive</literal> parameter get removed from the cache | |
364 regardless of their freshness. | |
365 By default, <literal>inactive</literal> is set to 10 minutes. | |
366 </para> | |
367 | |
368 <para> | |
369 The special “cache manager” process monitors the maximum cache size set | |
370 by the <literal>max_size</literal> parameter. | |
371 When this size is exceeded, it removes the least recently used data. | |
372 </para> | |
373 | |
374 <para> | |
375 A minute after the start the special “cache loader” process is activated. | |
376 It loads information about previously cached data stored on file system | |
377 into a cache zone. | |
378 The loading is done in iterations. | |
379 During one iteration no more than <literal>loader_files</literal> items | |
380 are loaded (by default, 100). | |
381 Besides, the duration of one iteration is limited by the | |
382 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). | |
383 Between iterations, a pause configured by the <literal>loader_sleep</literal> | |
384 parameter (by default, 50 milliseconds) is made. | |
385 </para> | |
386 | |
387 </directive> | |
388 | |
389 | |
390 <directive name="scgi_cache_purge"> | |
391 <syntax>string ...</syntax> | |
392 <default/> | |
393 <context>http</context> | |
394 <context>server</context> | |
395 <context>location</context> | |
396 <appeared-in>1.5.7</appeared-in> | |
397 | |
398 <para> | |
399 Defines conditions under which the request will be considered a cache | |
400 purge request. | |
401 If at least one value of the string parameters is not empty and is not equal | |
402 to “0” then the cache entry with a corresponding | |
403 <link id="scgi_cache_key">cache key</link> is removed. | |
404 The result of successful operation is indicated by returning | |
405 the <http-status code="204" text="No Content"/> response. | |
406 </para> | |
407 | |
408 <para> | |
409 If the <link id="scgi_cache_key">cache key</link> of a purge request ends | |
410 with an asterisk (“<literal>*</literal>”), all cache entries matching the | |
411 wildcard key will be removed from the cache. | |
412 </para> | |
413 | |
414 <para> | |
415 Example configuration: | |
416 <example> | |
417 scgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m; | |
418 | |
419 map $request_method $purge_method { | |
420 PURGE 1; | |
421 default 0; | |
422 } | |
423 | |
424 server { | |
425 ... | |
426 location / { | |
1185
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1184
diff
changeset
|
427 scgi_pass backend; |
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1184
diff
changeset
|
428 scgi_cache cache_zone; |
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1184
diff
changeset
|
429 scgi_cache_key $uri; |
1180 | 430 scgi_cache_purge $purge_method; |
431 } | |
432 } | |
433 </example> | |
434 <note> | |
435 This functionality is available as part of our | |
436 <commercial_version>commercial subscription</commercial_version>. | |
437 </note> | |
438 </para> | |
439 | |
440 </directive> | |
441 | |
442 | |
443 <directive name="scgi_cache_revalidate"> | |
444 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
445 <default>off</default> | |
446 <context>http</context> | |
447 <context>server</context> | |
448 <context>location</context> | |
449 <appeared-in>1.5.7</appeared-in> | |
450 | |
451 <para> | |
452 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
|
453 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
|
454 header fields. |
1180 | 455 </para> |
456 | |
457 </directive> | |
458 | |
459 | |
460 <directive name="scgi_cache_use_stale"> | |
461 <syntax> | |
462 <literal>error</literal> | | |
463 <literal>timeout</literal> | | |
464 <literal>invalid_header</literal> | | |
465 <literal>updating</literal> | | |
466 <literal>http_500</literal> | | |
467 <literal>http_503</literal> | | |
468 <literal>http_403</literal> | | |
469 <literal>http_404</literal> | | |
470 <literal>off</literal> | |
471 ...</syntax> | |
472 <default>off</default> | |
473 <context>http</context> | |
474 <context>server</context> | |
475 <context>location</context> | |
476 | |
477 <para> | |
478 Determines in which cases a stale cached response can be used | |
479 when an error occurs during communication with the SCGI server. | |
480 The directive’s parameters match the parameters of the | |
481 <link id="scgi_next_upstream"/> directive. | |
482 </para> | |
483 | |
484 <para> | |
485 Additionally, the <literal>updating</literal> parameter permits | |
486 using a stale cached response if it is currently being updated. | |
487 This allows minimizing the number of accesses to SCGI servers | |
488 when updating cached data. | |
489 </para> | |
490 | |
491 <para> | |
492 To minimize the number of accesses to SCGI servers when | |
493 populating a new cache element, the <link id="scgi_cache_lock"/> | |
494 directive can be used. | |
495 </para> | |
496 | |
497 </directive> | |
498 | |
499 | |
500 <directive name="scgi_cache_valid"> | |
501 <syntax>[<value>code</value> ...] <value>time</value></syntax> | |
502 <default/> | |
503 <context>http</context> | |
504 <context>server</context> | |
505 <context>location</context> | |
506 | |
507 <para> | |
508 Sets caching time for different response codes. | |
509 For example, the following directives | |
510 <example> | |
511 scgi_cache_valid 200 302 10m; | |
512 scgi_cache_valid 404 1m; | |
513 </example> | |
514 set 10 minutes of caching for responses with codes 200 and 302 | |
515 and 1 minute for responses with code 404. | |
516 </para> | |
517 | |
518 <para> | |
519 If only caching <value>time</value> is specified | |
520 <example> | |
521 scgi_cache_valid 5m; | |
522 </example> | |
523 then only 200, 301, and 302 responses are cached. | |
524 </para> | |
525 | |
526 <para> | |
527 In addition, the <literal>any</literal> parameter can be specified | |
528 to cache any responses: | |
529 <example> | |
530 scgi_cache_valid 200 302 10m; | |
531 scgi_cache_valid 301 1h; | |
532 scgi_cache_valid any 1m; | |
533 </example> | |
534 </para> | |
535 | |
536 <para> | |
537 Parameters of caching can also be set directly | |
538 in the response header. | |
539 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
|
540 <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
|
541 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
542 <listitem> |
1180 | 543 The <header>X-Accel-Expires</header> header field sets caching time of a |
544 response in seconds. | |
545 The zero value disables caching for a response. | |
546 If the value starts with the <literal>@</literal> prefix, it sets an absolute | |
547 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
|
548 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
549 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
550 <listitem> |
1180 | 551 If the header does not include the <header>X-Accel-Expires</header> field, |
552 parameters of caching may be set in the header fields | |
553 <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
|
554 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
555 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
556 <listitem> |
1180 | 557 If the header includes the <header>Set-Cookie</header> field, such a |
558 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
|
559 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
560 |
1353
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
561 <listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
562 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
|
563 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
|
564 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
|
565 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
|
566 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
|
567 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
|
568 </listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
569 |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
570 </list> |
1180 | 571 Processing of one or more of these response header fields can be disabled |
572 using the <link id="scgi_ignore_headers"/> directive. | |
573 </para> | |
574 | |
575 </directive> | |
576 | |
577 | |
578 <directive name="scgi_connect_timeout"> | |
579 <syntax><value>time</value></syntax> | |
580 <default>60s</default> | |
581 <context>http</context> | |
582 <context>server</context> | |
583 <context>location</context> | |
584 | |
585 <para> | |
586 Defines a timeout for establishing a connection with an SCGI server. | |
587 It should be noted that this timeout cannot usually exceed 75 seconds. | |
588 </para> | |
589 | |
590 </directive> | |
591 | |
592 | |
1337
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
593 <directive name="scgi_force_ranges"> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
594 <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
|
595 <default>off</default> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
596 <context>http</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
597 <context>server</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
598 <context>location</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
599 <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
|
600 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
601 <para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
602 Enables byte-range support |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
603 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
|
604 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
|
605 </para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
606 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
607 </directive> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
608 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
609 |
1180 | 610 <directive name="scgi_hide_header"> |
611 <syntax><value>field</value></syntax> | |
612 <default/> | |
613 <context>http</context> | |
614 <context>server</context> | |
615 <context>location</context> | |
616 | |
617 <para> | |
618 By default, | |
619 nginx does not pass the header fields <header>Status</header> and | |
620 <header>X-Accel-...</header> from the response of an SCGI | |
621 server to a client. | |
622 The <literal>scgi_hide_header</literal> directive sets additional fields | |
623 that will not be passed. | |
624 If, on the contrary, the passing of fields needs to be permitted, | |
625 the <link id="scgi_pass_header"/> directive can be used. | |
626 </para> | |
627 | |
628 </directive> | |
629 | |
630 | |
631 <directive name="scgi_ignore_client_abort"> | |
632 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
633 <default>off</default> | |
634 <context>http</context> | |
635 <context>server</context> | |
636 <context>location</context> | |
637 | |
638 <para> | |
639 Determines whether the connection with an SCGI server should be | |
640 closed when a client closes the connection without waiting | |
641 for a response. | |
642 </para> | |
643 | |
644 </directive> | |
645 | |
646 | |
647 <directive name="scgi_ignore_headers"> | |
648 <syntax><value>field</value> ...</syntax> | |
649 <default/> | |
650 <context>http</context> | |
651 <context>server</context> | |
652 <context>location</context> | |
653 | |
654 <para> | |
655 Disables processing of certain response header fields from the SCGI server. | |
656 The following fields can be ignored: <header>X-Accel-Redirect</header>, | |
657 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6), | |
658 <header>X-Accel-Buffering</header> (1.1.6), | |
659 <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
|
660 <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
|
661 and <header>Vary</header> (1.7.7). |
1180 | 662 </para> |
663 | |
664 <para> | |
665 If not disabled, processing of these header fields has the following | |
666 effect: | |
667 <list type="bullet" compact="no"> | |
668 | |
669 <listitem> | |
670 <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
|
671 <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
|
672 and <header>Vary</header> |
1180 | 673 set the parameters of response <link id="scgi_cache_valid">caching</link>; |
674 </listitem> | |
675 | |
676 <listitem> | |
677 <header>X-Accel-Redirect</header> performs an | |
678 <link doc="ngx_http_core_module.xml" id="internal">internal | |
679 redirect</link> to the specified URI; | |
680 </listitem> | |
681 | |
682 <listitem> | |
683 <header>X-Accel-Limit-Rate</header> sets the | |
684 <link doc="ngx_http_core_module.xml" id="limit_rate">rate | |
685 limit</link> for transmission of a response to a client; | |
686 </listitem> | |
687 | |
688 <listitem> | |
689 <header>X-Accel-Buffering</header> enables or disables | |
690 <link id="scgi_buffering">buffering</link> of a response; | |
691 </listitem> | |
692 | |
693 <listitem> | |
694 <header>X-Accel-Charset</header> sets the desired | |
695 <link doc="ngx_http_charset_module.xml" id="charset"/> | |
696 of a response. | |
697 </listitem> | |
698 | |
699 </list> | |
700 </para> | |
701 | |
702 </directive> | |
703 | |
704 | |
705 <directive name="scgi_intercept_errors"> | |
706 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
707 <default>off</default> | |
708 <context>http</context> | |
709 <context>server</context> | |
710 <context>location</context> | |
711 | |
712 <para> | |
713 Determines whether an SCGI server responses with codes greater than or equal | |
714 to 300 should be passed to a client or be redirected to nginx for processing | |
715 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive. | |
716 </para> | |
717 | |
718 </directive> | |
719 | |
720 | |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
721 <directive name="scgi_limit_rate"> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
722 <syntax><value>rate</value></syntax> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
723 <default>0</default> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
724 <context>http</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
725 <context>server</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
726 <context>location</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
727 <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
|
728 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
729 <para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
730 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
|
731 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
|
732 The zero value disables rate limiting. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
733 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
|
734 two connections to the SCGI server, |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
735 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
|
736 The limitation works only if |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
737 <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
|
738 server is enabled. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
739 </para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
740 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
741 </directive> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
742 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
743 |
1180 | 744 <directive name="scgi_max_temp_file_size"> |
745 <syntax><value>size</value></syntax> | |
746 <default>1024m</default> | |
747 <context>http</context> | |
748 <context>server</context> | |
749 <context>location</context> | |
750 | |
751 <para> | |
752 When <link id="scgi_buffering">buffering</link> of responses from the SCGI | |
753 server is enabled, and the whole response does not fit into the buffers | |
754 set by the <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> | |
755 directives, a part of the response can be saved to a temporary file. | |
756 This directive sets the maximum <value>size</value> of the temporary file. | |
757 The size of data written to the temporary file at a time is set | |
758 by the <link id="scgi_temp_file_write_size"/> directive. | |
759 </para> | |
760 | |
761 <para> | |
762 The zero value disables buffering of responses to temporary files. | |
763 </para> | |
764 | |
1352
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
765 <para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
766 <note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
767 This restriction does not apply to responses |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
768 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
|
769 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
|
770 </note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
771 </para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
772 |
1180 | 773 </directive> |
774 | |
775 | |
776 <directive name="scgi_next_upstream"> | |
777 <syntax> | |
778 <literal>error</literal> | | |
779 <literal>timeout</literal> | | |
780 <literal>invalid_header</literal> | | |
781 <literal>http_500</literal> | | |
782 <literal>http_503</literal> | | |
783 <literal>http_403</literal> | | |
784 <literal>http_404</literal> | | |
785 <literal>off</literal> | |
786 ...</syntax> | |
787 <default>error timeout</default> | |
788 <context>http</context> | |
789 <context>server</context> | |
790 <context>location</context> | |
791 | |
792 <para> | |
793 Specifies in which cases a request should be passed to the next server: | |
794 <list type="tag"> | |
795 | |
796 <tag-name><literal>error</literal></tag-name> | |
797 <tag-desc>an error occurred while establishing a connection with the | |
798 server, passing a request to it, or reading the response header;</tag-desc> | |
799 | |
800 <tag-name><literal>timeout</literal></tag-name> | |
801 <tag-desc>a timeout has occurred while establishing a connection with the | |
802 server, passing a request to it, or reading the response header;</tag-desc> | |
803 | |
804 <tag-name><literal>invalid_header</literal></tag-name> | |
805 <tag-desc>a server returned an empty or invalid response;</tag-desc> | |
806 | |
807 <tag-name><literal>http_500</literal></tag-name> | |
808 <tag-desc>a server returned a response with the code 500;</tag-desc> | |
809 | |
810 <tag-name><literal>http_503</literal></tag-name> | |
811 <tag-desc>a server returned a response with the code 503;</tag-desc> | |
812 | |
813 <tag-name><literal>http_403</literal></tag-name> | |
814 <tag-desc>a server returned a response with the code 403;</tag-desc> | |
815 | |
816 <tag-name><literal>http_404</literal></tag-name> | |
817 <tag-desc>a server returned a response with the code 404;</tag-desc> | |
818 | |
819 <tag-name><literal>off</literal></tag-name> | |
820 <tag-desc>disables passing a request to the next server.</tag-desc> | |
821 | |
822 </list> | |
823 </para> | |
824 | |
825 <para> | |
826 One should bear in mind that passing a request to the next server is | |
827 only possible if nothing has been sent to a client yet. | |
828 That is, if an error or timeout occurs in the middle of the | |
829 transferring of a response, fixing this is impossible. | |
830 </para> | |
831 | |
832 <para> | |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
833 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
|
834 <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
|
835 attempt</link> of communication with a server. |
1180 | 836 The cases of <literal>error</literal>, <literal>timeout</literal> and |
837 <literal>invalid_header</literal> are always considered unsuccessful attempts, | |
838 even if they are not specified in the directive. | |
839 The cases of <literal>http_500</literal> and <literal>http_503</literal> are | |
840 considered unsuccessful attempts only if they are specified in the directive. | |
841 The cases of <literal>http_403</literal> and <literal>http_404</literal> | |
842 are never considered unsuccessful attempts. | |
843 </para> | |
844 | |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
845 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
846 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
|
847 <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
|
848 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
|
849 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
850 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
851 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
852 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
853 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
854 <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
|
855 <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
|
856 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
857 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
858 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
859 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
860 <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
|
861 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
862 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
863 Limits the time allowed to pass a request to the |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
864 <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
|
865 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
|
866 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
867 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
868 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
869 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
870 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
871 <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
|
872 <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
|
873 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
874 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
875 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
876 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
877 <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
|
878 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
879 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
880 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
|
881 <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
|
882 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
|
883 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
884 |
1180 | 885 </directive> |
886 | |
887 | |
888 <directive name="scgi_no_cache"> | |
889 <syntax><value>string</value> ...</syntax> | |
890 <default/> | |
891 <context>http</context> | |
892 <context>server</context> | |
893 <context>location</context> | |
894 | |
895 <para> | |
896 Defines conditions under which the response will not be saved to a cache. | |
897 If at least one value of the string parameters is not empty and is not | |
898 equal to “0” then the response will not be saved: | |
899 <example> | |
900 scgi_no_cache $cookie_nocache $arg_nocache$arg_comment; | |
901 scgi_no_cache $http_pragma $http_authorization; | |
902 </example> | |
903 Can be used along with the <link id="scgi_cache_bypass"/> directive. | |
904 </para> | |
905 | |
906 </directive> | |
907 | |
908 | |
909 <directive name="scgi_param"> | |
910 <syntax> | |
911 <value>parameter</value> <value>value</value> | |
912 [<literal>if_not_empty</literal>]</syntax> | |
913 <default/> | |
914 <context>http</context> | |
915 <context>server</context> | |
916 <context>location</context> | |
917 | |
918 <para> | |
919 Sets a <value>parameter</value> that should be passed to the SCGI server. | |
920 The <value>value</value> can contain text, variables, and their combination. | |
921 These directives are inherited from the previous level if and | |
922 only if there are no | |
923 <literal>scgi_param</literal> | |
924 directives defined on the current level. | |
925 </para> | |
926 | |
927 <para> | |
928 Standard | |
929 <link url="http://tools.ietf.org/html/rfc3875#section-4.1">CGI | |
930 environment variables</link> | |
931 should be provided as SCGI headers, see the <path>scgi_params</path> file | |
932 provided in the distribution: | |
933 <example> | |
934 location / { | |
935 include scgi_params; | |
936 ... | |
937 } | |
938 </example> | |
939 </para> | |
940 | |
1182
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
941 <para> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
942 If a directive is specified with <literal>if_not_empty</literal> (1.1.11) then |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
943 such a parameter will not be passed to the server until its value is not empty: |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
944 <example> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
945 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
|
946 </example> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
947 </para> |
ec1097156f81
Scgi: restored if_not_empty lost during conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1180
diff
changeset
|
948 |
1180 | 949 </directive> |
950 | |
951 | |
952 <directive name="scgi_pass"> | |
953 <syntax><value>address</value></syntax> | |
954 <default/> | |
955 <context>location</context> | |
956 <context>if in location</context> | |
957 | |
958 <para> | |
959 Sets the address of an SCGI server. | |
960 The address can be specified as a domain name or IP address, | |
961 and an optional port: | |
962 <example> | |
963 scgi_pass localhost:9000; | |
964 </example> | |
965 or as a UNIX-domain socket path: | |
966 <example> | |
967 scgi_pass unix:/tmp/scgi.socket; | |
968 </example> | |
969 </para> | |
970 | |
971 <para> | |
972 If a domain name resolves to several addresses, all of them will be | |
973 used in a round-robin fashion. | |
974 In addition, an address can be specified as a | |
975 <link doc="ngx_http_upstream_module.xml">server group</link>. | |
976 </para> | |
977 | |
978 </directive> | |
979 | |
980 | |
981 <directive name="scgi_pass_header"> | |
982 <syntax><value>field</value></syntax> | |
983 <default/> | |
984 <context>http</context> | |
985 <context>server</context> | |
986 <context>location</context> | |
987 | |
988 <para> | |
989 Permits passing <link id="scgi_hide_header">otherwise disabled</link> header | |
990 fields from an SCGI server to a client. | |
991 </para> | |
992 | |
993 </directive> | |
994 | |
995 | |
996 <directive name="scgi_read_timeout"> | |
997 <syntax><value>time</value></syntax> | |
998 <default>60s</default> | |
999 <context>http</context> | |
1000 <context>server</context> | |
1001 <context>location</context> | |
1002 | |
1003 <para> | |
1004 Defines a timeout for reading a response from the SCGI server. | |
1005 The timeout is set only between two successive read operations, | |
1006 not for the transmission of the whole response. | |
1007 If the SCGI server does not transmit anything within this time, | |
1008 the connection is closed. | |
1009 </para> | |
1010 | |
1011 </directive> | |
1012 | |
1013 | |
1014 <directive name="scgi_pass_request_body"> | |
1015 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
1016 <default>on</default> | |
1017 <context>http</context> | |
1018 <context>server</context> | |
1019 <context>location</context> | |
1020 | |
1021 <para> | |
1022 Indicates whether the original request body is passed | |
1023 to the SCGI server. | |
1024 See also the <link id="scgi_pass_request_headers"/> directive. | |
1025 </para> | |
1026 | |
1027 </directive> | |
1028 | |
1029 | |
1030 <directive name="scgi_pass_request_headers"> | |
1031 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
1032 <default>on</default> | |
1033 <context>http</context> | |
1034 <context>server</context> | |
1035 <context>location</context> | |
1036 | |
1037 <para> | |
1038 Indicates whether the header fields of the original request are passed | |
1039 to the SCGI server. | |
1040 See also the <link id="scgi_pass_request_body"/> directive. | |
1041 </para> | |
1042 | |
1043 </directive> | |
1044 | |
1045 | |
1046 <directive name="scgi_send_timeout"> | |
1047 <syntax><value>time</value></syntax> | |
1048 <default>60s</default> | |
1049 <context>http</context> | |
1050 <context>server</context> | |
1051 <context>location</context> | |
1052 | |
1053 <para> | |
1054 Sets a timeout for transmitting a request to the SCGI server. | |
1055 The timeout is set only between two successive write operations, | |
1056 not for the transmission of the whole request. | |
1057 If the SCGI server does not receive anything within this time, | |
1058 the connection is closed. | |
1059 </para> | |
1060 | |
1061 </directive> | |
1062 | |
1063 | |
1064 <directive name="scgi_store"> | |
1065 <syntax> | |
1066 <literal>on</literal> | | |
1067 <literal>off</literal> | | |
1068 <value>string</value></syntax> | |
1069 <default>off</default> | |
1070 <context>http</context> | |
1071 <context>server</context> | |
1072 <context>location</context> | |
1073 | |
1074 <para> | |
1075 Enables saving of files to a disk. | |
1076 The <literal>on</literal> parameter saves files with paths | |
1077 corresponding to the directives | |
1078 <link doc="ngx_http_core_module.xml" id="alias"/> or | |
1079 <link doc="ngx_http_core_module.xml" id="root"/>. | |
1080 The <literal>off</literal> parameter disables saving of files. | |
1081 In addition, the file name can be set explicitly using the | |
1082 <value>string</value> with variables: | |
1083 <example> | |
1084 scgi_store /data/www$original_uri; | |
1085 </example> | |
1086 </para> | |
1087 | |
1088 <para> | |
1089 The modification time of files is set according to the received | |
1090 <header>Last-Modified</header> response header field. | |
1091 The response is first written to a temporary file, | |
1092 and then the file is renamed. | |
1093 Starting from version 0.8.9, temporary files and the persistent store | |
1094 can be put on different file systems. | |
1095 However, be aware that in this case a file is copied | |
1096 across two file systems instead of the cheap renaming operation. | |
1097 It is thus recommended that for any given location both saved files and a | |
1098 directory holding temporary files, set by the <link id="scgi_temp_path"/> | |
1099 directive, are put on the same file system. | |
1100 </para> | |
1101 | |
1102 <para> | |
1103 This directive can be used to create local copies of static unchangeable | |
1104 files, e.g.: | |
1105 <example> | |
1106 location /images/ { | |
1184
55857cbf562d
Fixed alignment issues after mechanical conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1182
diff
changeset
|
1107 root /data/www; |
55857cbf562d
Fixed alignment issues after mechanical conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1182
diff
changeset
|
1108 error_page 404 = /fetch$uri; |
1180 | 1109 } |
1110 | |
1111 location /fetch/ { | |
1112 internal; | |
1113 | |
1114 scgi_pass backend:9000; | |
1115 ... | |
1116 | |
1117 scgi_store on; | |
1118 scgi_store_access user:rw group:rw all:r; | |
1119 scgi_temp_path /data/temp; | |
1120 | |
1184
55857cbf562d
Fixed alignment issues after mechanical conversion from fastcgi.
Ruslan Ermilov <ru@nginx.com>
parents:
1182
diff
changeset
|
1121 alias /data/www/; |
1180 | 1122 } |
1123 </example> | |
1124 </para> | |
1125 | |
1126 </directive> | |
1127 | |
1128 | |
1129 <directive name="scgi_store_access"> | |
1130 <syntax><value>users</value>:<value>permissions</value> ...</syntax> | |
1131 <default>user:rw</default> | |
1132 <context>http</context> | |
1133 <context>server</context> | |
1134 <context>location</context> | |
1135 | |
1136 <para> | |
1137 Sets access permissions for newly created files and directories, e.g.: | |
1138 <example> | |
1139 scgi_store_access user:rw group:rw all:r; | |
1140 </example> | |
1141 </para> | |
1142 | |
1143 <para> | |
1144 If any <literal>group</literal> or <literal>all</literal> access permissions | |
1145 are specified then <literal>user</literal> permissions may be omitted: | |
1146 <example> | |
1147 scgi_store_access group:rw all:r; | |
1148 </example> | |
1149 </para> | |
1150 | |
1151 </directive> | |
1152 | |
1153 | |
1154 <directive name="scgi_temp_file_write_size"> | |
1155 <syntax><value>size</value></syntax> | |
1156 <default>8k|16k</default> | |
1157 <context>http</context> | |
1158 <context>server</context> | |
1159 <context>location</context> | |
1160 | |
1161 <para> | |
1162 Limits the <value>size</value> of data written to a temporary file | |
1163 at a time, when buffering of responses from the SCGI server | |
1164 to temporary files is enabled. | |
1165 By default, <value>size</value> is limited by two buffers set by the | |
1166 <link id="scgi_buffer_size"/> and <link id="scgi_buffers"/> directives. | |
1167 The maximum size of a temporary file is set by the | |
1168 <link id="scgi_max_temp_file_size"/> directive. | |
1169 </para> | |
1170 | |
1171 </directive> | |
1172 | |
1173 | |
1174 <directive name="scgi_temp_path"> | |
1175 <syntax> | |
1176 <value>path</value> | |
1177 [<value>level1</value> | |
1178 [<value>level2</value> | |
1179 [<value>level3</value>]]]</syntax> | |
1180 <default>scgi_temp</default> | |
1181 <context>http</context> | |
1182 <context>server</context> | |
1183 <context>location</context> | |
1184 | |
1185 <para> | |
1186 Defines a directory for storing temporary files | |
1187 with data received from SCGI servers. | |
1188 Up to three-level subdirectory hierarchy can be used underneath the specified | |
1189 directory. | |
1190 For example, in the following configuration | |
1191 <example> | |
1192 scgi_temp_path /spool/nginx/scgi_temp 1 2; | |
1193 </example> | |
1194 a temporary file might look like this: | |
1195 <example> | |
1196 /spool/nginx/scgi_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis> | |
1197 </example> | |
1198 </para> | |
1199 | |
1200 </directive> | |
1201 | |
1202 </section> | |
1203 | |
1204 </module> |