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