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