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