Mercurial > hg > nginx-quic
comparison docs/html/http/ngx_http_core_module.html @ 4109:dc1fa52222b4
Regenerated after previous commit.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 15 Sep 2011 08:33:25 +0000 |
parents | b7c944d1a5a8 |
children |
comparison
equal
deleted
inserted
replaced
4108:5e2103cffd80 | 4109:dc1fa52222b4 |
---|---|
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>HTTP Core Module</title></head><body><a name="directives"></a><center><h4>Directives</h4></center><hr><a name="aio"></a><strong>syntax</strong>: | 1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>HTTP Core Module</title></head><body><center><h3>HTTP Core Module</h3></center><a name="directives"></a><center><h4>Directives</h4></center><hr><a name="aio"></a><strong>syntax</strong>: |
2 <code>aio | 2 <code>aio |
3 <code>on</code> | | 3 <code>on</code> | |
4 <code>off</code> | | 4 <code>off</code> | |
5 <code>sendfile</code></code><br><strong>default</strong>: | 5 <code>sendfile</code></code><br><strong>default</strong>: |
6 <code>aio off</code><br><strong>context</strong>: | 6 <code>aio off</code><br><strong>context</strong>: |
146 into a file. | 146 into a file. |
147 This directive can be used during debugging, or when using the | 147 This directive can be used during debugging, or when using the |
148 <code>$request_body_file</code> | 148 <code>$request_body_file</code> |
149 variable, or the | 149 variable, or the |
150 <a href="ngx_http_perl_module.html#methods">$r->request_body_file</a> | 150 <a href="ngx_http_perl_module.html#methods">$r->request_body_file</a> |
151 method of the | 151 method of the module |
152 <a href="ngx_http_perl_module.html">http_perl</a> module. | 152 <a href="ngx_http_perl_module.html">ngx_http_perl_module</a>. |
153 </p><p> | 153 </p><p> |
154 When set to the value <code>on</code>, temporary files are not | 154 When set to the value <code>on</code>, temporary files are not |
155 removed after request processing. | 155 removed after request processing. |
156 </p><p> | 156 </p><p> |
157 The value <code>clean</code> will cause the temporary files | 157 The value <code>clean</code> will cause the temporary files |
201 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 201 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
202 Defines a timeout for reading client request body. | 202 Defines a timeout for reading client request body. |
203 A timeout is only set between two successive read operations, | 203 A timeout is only set between two successive read operations, |
204 not for the transmission of the whole request body. | 204 not for the transmission of the whole request body. |
205 If a client does not transmit anything within this time, | 205 If a client does not transmit anything within this time, |
206 the error | 206 the client error |
207 <i>"Request time out"</i> (408) | 207 408 (Request Time-out) |
208 is returned. | 208 is returned. |
209 </p><hr><a name="client_header_buffer_size"></a><strong>syntax</strong>: | 209 </p><hr><a name="client_header_buffer_size"></a><strong>syntax</strong>: |
210 <code>client_header_buffer_size <code><i>size</i></code></code><br><strong>default</strong>: | 210 <code>client_header_buffer_size <code><i>size</i></code></code><br><strong>default</strong>: |
211 <code>client_header_buffer_size 1k</code><br><strong>context</strong>: | 211 <code>client_header_buffer_size 1k</code><br><strong>context</strong>: |
212 <code>http</code>, <code>server</code><br><p> | 212 <code>http</code>, <code>server</code><br><p> |
222 <code>client_header_timeout <code><i>time</i></code></code><br><strong>default</strong>: | 222 <code>client_header_timeout <code><i>time</i></code></code><br><strong>default</strong>: |
223 <code>client_header_timeout 60</code><br><strong>context</strong>: | 223 <code>client_header_timeout 60</code><br><strong>context</strong>: |
224 <code>http</code>, <code>server</code><br><p> | 224 <code>http</code>, <code>server</code><br><p> |
225 Defines a timeout for reading client request header. | 225 Defines a timeout for reading client request header. |
226 If a client does not transmit the entire header within this time, | 226 If a client does not transmit the entire header within this time, |
227 the error | 227 the client error |
228 <i>"Request time out"</i> (408) | 228 408 (Request Time-out) |
229 is returned. | 229 is returned. |
230 </p><hr><a name="client_max_body_size"></a><strong>syntax</strong>: | 230 </p><hr><a name="client_max_body_size"></a><strong>syntax</strong>: |
231 <code>client_max_body_size <code><i>size</i></code></code><br><strong>default</strong>: | 231 <code>client_max_body_size <code><i>size</i></code></code><br><strong>default</strong>: |
232 <code>client_max_body_size 1m</code><br><strong>context</strong>: | 232 <code>client_max_body_size 1m</code><br><strong>context</strong>: |
233 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 233 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
234 Sets the maximum allowed size of the client request body, | 234 Sets the maximum allowed size of the client request body, |
235 specified in the | 235 specified in the |
236 <code>Content-Length</code> | 236 <code>Content-Length</code> |
237 request header field. | 237 request header field. |
238 If <code><i>size</i></code> is greater than the configured value, the | 238 If it exceeds the configured value, the client error |
239 <i>"Request Entity Too Large"</i> (413) | 239 413 (Request Entity Too Large) |
240 error is returned to a client. | 240 is returned. |
241 Please be aware that | 241 Please be aware that |
242 <a href="/web/upload.html">browsers cannot correctly display | 242 <a href="/web/upload.html">browsers cannot correctly display |
243 this error</a>. | 243 this error</a>. |
244 </p><hr><a name="default_type"></a><strong>syntax</strong>: | 244 </p><hr><a name="default_type"></a><strong>syntax</strong>: |
245 <code>default_type <code><i>mime-type</i></code></code><br><strong>default</strong>: | 245 <code>default_type <code><i>mime-type</i></code></code><br><strong>default</strong>: |
339 </dd></dl></p><hr><a name="internal"></a><strong>syntax</strong>: | 339 </dd></dl></p><hr><a name="internal"></a><strong>syntax</strong>: |
340 <code>internal</code><br><strong>default</strong>: | 340 <code>internal</code><br><strong>default</strong>: |
341 <strong>none</strong><br><strong>context</strong>: | 341 <strong>none</strong><br><strong>context</strong>: |
342 <code>location</code><br><p> | 342 <code>location</code><br><p> |
343 Specifies that a given location can only be used for internal requests. | 343 Specifies that a given location can only be used for internal requests. |
344 For external requests, the <i>"Not found"</i> (404) | 344 For external requests, the client error |
345 error is returned. | 345 404 (Not Found) |
346 is returned. | |
346 Internal requests are the following: | 347 Internal requests are the following: |
347 | 348 |
348 <ul><li> | 349 <ul><li> |
349 requests redirected by the <a href="#error_page">error_page</a> directive; | 350 requests redirected by the <a href="#error_page">error_page</a> directive; |
350 </li><li> | 351 </li><li> |
351 subrequests formed by the | 352 subrequests formed by the |
352 <code>include virtual</code> | 353 <code>include virtual</code> |
353 command of the | 354 command of the module |
354 <a href="ngx_http_ssi_module.html">http_ssi</a> module; | 355 <a href="ngx_http_ssi_module.html">ngx_http_ssi_module</a>; |
355 </li><li> | 356 </li><li> |
356 requests changed by the | 357 requests changed by the |
357 <a href="ngx_http_rewrite_module.html#rewrite">rewrite</a> | 358 <a href="ngx_http_rewrite_module.html#rewrite">rewrite</a> |
358 directive of the | 359 directive of the module |
359 <a href="ngx_http_rewrite_module.html">http_rewrite</a> module. | 360 <a href="ngx_http_rewrite_module.html">ngx_http_rewrite_module</a>. |
360 </li></ul></p><p> | 361 </li></ul></p><p> |
361 Example: | 362 Example: |
362 <blockquote><pre> | 363 <blockquote><pre> |
363 error_page 404 /404.html; | 364 error_page 404 /404.html; |
364 | 365 |
394 <code>large_client_header_buffers <code><i>number size</i></code></code><br><strong>default</strong>: | 395 <code>large_client_header_buffers <code><i>number size</i></code></code><br><strong>default</strong>: |
395 <code>large_client_header_buffers 4 4k/8k</code><br><strong>context</strong>: | 396 <code>large_client_header_buffers 4 4k/8k</code><br><strong>context</strong>: |
396 <code>http</code>, <code>server</code><br><p> | 397 <code>http</code>, <code>server</code><br><p> |
397 Sets the maximum <code><i>number</i></code> and <code><i>size</i></code> of | 398 Sets the maximum <code><i>number</i></code> and <code><i>size</i></code> of |
398 buffers used when reading large client request headers. | 399 buffers used when reading large client request headers. |
399 A request line cannot exceed the size of one buffer, or the | 400 A request line cannot exceed the size of one buffer, or the client error |
400 <i>"Request URI too large"</i> (414) | 401 414 (Request-URI Too Large) |
401 error is returned. | 402 is returned. |
402 A request header field cannot exceed the size of one buffer as well, or the | 403 A request header field cannot exceed the size of one buffer as well, or the |
403 <i>"Bad request"</i> (400) | 404 client error |
404 error is returned. | 405 400 (Bad Request) |
406 is returned. | |
405 Buffers are allocated only on demand. | 407 Buffers are allocated only on demand. |
406 By default, the buffer size is equal to one memory page size. | 408 By default, the buffer size is equal to one memory page size. |
407 It is either 4K or 8K, platform dependent. | 409 It is either 4K or 8K, platform dependent. |
408 If after the end of request processing a connection is transitioned | 410 If after the end of request processing a connection is transitioned |
409 into the keep-alive state, these buffers are freed. | 411 into the keep-alive state, these buffers are freed. |
412 <strong>none</strong><br><strong>context</strong>: | 414 <strong>none</strong><br><strong>context</strong>: |
413 <code>location</code><br><p> | 415 <code>location</code><br><p> |
414 Limits allowed HTTP methods inside a location. | 416 Limits allowed HTTP methods inside a location. |
415 The GET method also implies the HEAD method. | 417 The GET method also implies the HEAD method. |
416 Access to other methods can be limited using the | 418 Access to other methods can be limited using the |
417 <a href="ngx_http_access_module.html">http_access</a> | 419 <a href="ngx_http_access_module.html">ngx_http_access_module</a> |
418 and | 420 and |
419 <a href="ngx_http_auth_basic_module.html">http_auth_basic</a> | 421 <a href="ngx_http_auth_basic_module.html">ngx_http_auth_basic_module</a> |
420 modules directives: | 422 modules directives: |
421 <blockquote><pre> | 423 <blockquote><pre> |
422 limit_except GET { | 424 limit_except GET { |
423 allow 192.168.1.0/32; | 425 allow 192.168.1.0/32; |
424 deny all; | 426 deny all; |
864 </p><hr><a name="satisfy"></a><strong>syntax</strong>: | 866 </p><hr><a name="satisfy"></a><strong>syntax</strong>: |
865 <code>satisfy <code>all</code> | <code>any</code></code><br><strong>default</strong>: | 867 <code>satisfy <code>all</code> | <code>any</code></code><br><strong>default</strong>: |
866 <code>satisfy all</code><br><strong>context</strong>: | 868 <code>satisfy all</code><br><strong>context</strong>: |
867 <code>location</code><br><p> | 869 <code>location</code><br><p> |
868 Allows access if any of the | 870 Allows access if any of the |
869 <a href="ngx_http_access_module.html">http_access</a> | 871 <a href="ngx_http_access_module.html">ngx_http_access_module</a> |
870 or <a href="ngx_http_auth_basic_module.html">http_auth_basic</a> | 872 or <a href="ngx_http_auth_basic_module.html">ngx_http_auth_basic_module</a> |
871 modules grant access. | 873 modules grant access. |
872 <blockquote><pre> | 874 <blockquote><pre> |
873 location / { | 875 location / { |
874 satisfy any; | 876 satisfy any; |
875 | 877 |
1190 <code>underscores_in_headers <code>on</code> | <code>off</code></code><br><strong>default</strong>: | 1192 <code>underscores_in_headers <code>on</code> | <code>off</code></code><br><strong>default</strong>: |
1191 <code>underscores_in_headers off</code><br><strong>context</strong>: | 1193 <code>underscores_in_headers off</code><br><strong>context</strong>: |
1192 <code>http</code>, <code>server</code><br><p> | 1194 <code>http</code>, <code>server</code><br><p> |
1193 Enables or disables the use of underscores in client request header fields. | 1195 Enables or disables the use of underscores in client request header fields. |
1194 </p><a name="variables"></a><center><h4>Embedded Variables</h4></center><p> | 1196 </p><a name="variables"></a><center><h4>Embedded Variables</h4></center><p> |
1195 The http_core module supports embedded variables with names matching | 1197 The module <code>ngx_http_core_module</code> supports embedded variables with |
1196 those of the Apache Server. | 1198 names matching those of the Apache Server. |
1197 First of all, these are variables representing client request header | 1199 First of all, these are variables representing client request header |
1198 fields, such as, <code>$http_user_agent</code>, <code>$http_cookie</code>, | 1200 fields, such as, <code>$http_user_agent</code>, <code>$http_cookie</code>, |
1199 and so on. | 1201 and so on. |
1200 It also supports other variables: | 1202 It also supports other variables: |
1201 <dl compact><dt><code>$args</code></dt><dd> | 1203 <dl compact><dt><code>$args</code></dt><dd> |