Mercurial > hg > nginx
comparison docs/html/http/ngx_http_core_module.html @ 4084:b7c944d1a5a8
Regenerate after previous commits.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 08 Sep 2011 13:28:25 +0000 |
parents | a1e1b348bfaf |
children | dc1fa52222b4 |
comparison
equal
deleted
inserted
replaced
4083:44c1953c266c | 4084:b7c944d1a5a8 |
---|---|
145 Determines whether nginx should save the entire client request body | 145 Determines whether nginx should save the entire client request body |
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 <u>$r->request_body_file</u> | 150 <a href="ngx_http_perl_module.html#methods">$r->request_body_file</a> |
151 method of the | 151 method of the |
152 <u>http_perl</u> module. | 152 <a href="ngx_http_perl_module.html">http_perl</a> module. |
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 |
237 request header field. | 237 request header field. |
238 If <code><i>size</i></code> is greater than the configured value, the | 238 If <code><i>size</i></code> is greater than the configured value, the |
239 <i>"Request Entity Too Large"</i> (413) | 239 <i>"Request Entity Too Large"</i> (413) |
240 error is returned to a client. | 240 error is returned to a client. |
241 Please be aware that | 241 Please be aware that |
242 <u>browsers cannot correctly display | 242 <a href="/web/upload.html">browsers cannot correctly display |
243 this error</u>. | 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>: |
246 <code>default_type text/plain</code><br><strong>context</strong>: | 246 <code>default_type text/plain</code><br><strong>context</strong>: |
247 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 247 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
248 Defines a default MIME-type of a response. | 248 Defines a default MIME-type of a response. |
281 <strong>none</strong><br><strong>context</strong>: | 281 <strong>none</strong><br><strong>context</strong>: |
282 <code>http</code>, <code>server</code>, <code>location</code>, <code>if in location</code><br><p> | 282 <code>http</code>, <code>server</code>, <code>location</code>, <code>if in location</code><br><p> |
283 Defines the URI that will be shown for the specified errors. | 283 Defines the URI that will be shown for the specified errors. |
284 These directives are inherited from the previous level if and | 284 These directives are inherited from the previous level if and |
285 only if there are no | 285 only if there are no |
286 <u>error_page</u> | 286 <code>error_page</code> |
287 directives on | 287 directives on |
288 the current level. | 288 the current level. |
289 A URI value can contain variables. | 289 A URI value can contain variables. |
290 </p><p> | 290 </p><p> |
291 Example: | 291 Example: |
349 requests redirected by the <a href="#error_page">error_page</a> directive; | 349 requests redirected by the <a href="#error_page">error_page</a> directive; |
350 </li><li> | 350 </li><li> |
351 subrequests formed by the | 351 subrequests formed by the |
352 <code>include virtual</code> | 352 <code>include virtual</code> |
353 command of the | 353 command of the |
354 <u>http_ssi</u> module; | 354 <a href="ngx_http_ssi_module.html">http_ssi</a> module; |
355 </li><li> | 355 </li><li> |
356 requests changed by the | 356 requests changed by the |
357 <u>rewrite</u> | 357 <a href="ngx_http_rewrite_module.html#rewrite">rewrite</a> |
358 directive of the | 358 directive of the |
359 <u>http_rewrite</u> module. | 359 <a href="ngx_http_rewrite_module.html">http_rewrite</a> module. |
360 </li></ul></p><p> | 360 </li></ul></p><p> |
361 Example: | 361 Example: |
362 <blockquote><pre> | 362 <blockquote><pre> |
363 error_page 404 /404.html; | 363 error_page 404 /404.html; |
364 | 364 |
412 <strong>none</strong><br><strong>context</strong>: | 412 <strong>none</strong><br><strong>context</strong>: |
413 <code>location</code><br><p> | 413 <code>location</code><br><p> |
414 Limits allowed HTTP methods inside a location. | 414 Limits allowed HTTP methods inside a location. |
415 The GET method also implies the HEAD method. | 415 The GET method also implies the HEAD method. |
416 Access to other methods can be limited using the | 416 Access to other methods can be limited using the |
417 <u>http_access</u> | 417 <a href="ngx_http_access_module.html">http_access</a> |
418 and | 418 and |
419 <u>http_auth_basic</u> | 419 <a href="ngx_http_auth_basic_module.html">http_auth_basic</a> |
420 modules directives: | 420 modules directives: |
421 <blockquote><pre> | 421 <blockquote><pre> |
422 limit_except GET { | 422 limit_except GET { |
423 allow 192.168.1.0/32; | 423 allow 192.168.1.0/32; |
424 deny all; | 424 deny all; |
665 </p><hr><a name="log_not_found"></a><strong>syntax</strong>: | 665 </p><hr><a name="log_not_found"></a><strong>syntax</strong>: |
666 <code>log_not_found <code>on</code> | <code>off</code></code><br><strong>default</strong>: | 666 <code>log_not_found <code>on</code> | <code>off</code></code><br><strong>default</strong>: |
667 <code>log_not_found on</code><br><strong>context</strong>: | 667 <code>log_not_found on</code><br><strong>context</strong>: |
668 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 668 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
669 Enables or disables logging of errors about not found files into the | 669 Enables or disables logging of errors about not found files into the |
670 <u>error_log</u>. | 670 <a href="../ngx_core_module.html#error_log">error_log</a>. |
671 </p><hr><a name="log_subrequest"></a><strong>syntax</strong>: | 671 </p><hr><a name="log_subrequest"></a><strong>syntax</strong>: |
672 <code>log_subrequest <code>on</code> | <code>off</code></code><br><strong>default</strong>: | 672 <code>log_subrequest <code>on</code> | <code>off</code></code><br><strong>default</strong>: |
673 <code>log_subrequest off</code><br><strong>context</strong>: | 673 <code>log_subrequest off</code><br><strong>context</strong>: |
674 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 674 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
675 Enables or disables logging of subrequests into the | 675 Enables or disables logging of subrequests into the |
676 <u>access_log</u>. | 676 <a href="ngx_http_log_module.html#access_log">access_log</a>. |
677 </p><hr><a name="merge_slashes"></a><strong>syntax</strong>: | 677 </p><hr><a name="merge_slashes"></a><strong>syntax</strong>: |
678 <code>merge_slashes <code>on</code> | <code>off</code></code><br><strong>default</strong>: | 678 <code>merge_slashes <code>on</code> | <code>off</code></code><br><strong>default</strong>: |
679 <code>merge_slashes on</code><br><strong>context</strong>: | 679 <code>merge_slashes on</code><br><strong>context</strong>: |
680 <code>http</code>, <code>server</code><br><p> | 680 <code>http</code>, <code>server</code><br><p> |
681 Enables or disables compression of two or more adjacent slashes | 681 Enables or disables compression of two or more adjacent slashes |
801 </p><p> | 801 </p><p> |
802 On FreeBSD, the | 802 On FreeBSD, the |
803 <code>fcntl(O_READAHEAD,</code><code><i>size</i></code><code>)</code> | 803 <code>fcntl(O_READAHEAD,</code><code><i>size</i></code><code>)</code> |
804 system call is used, supported in FreeBSD 9.0-CURRENT. | 804 system call is used, supported in FreeBSD 9.0-CURRENT. |
805 FreeBSD 7 needs to be | 805 FreeBSD 7 needs to be |
806 <u>patched</u>. | 806 <a href="http://sysoev.ru/freebsd/patch.readahead.txt">patched</a>. |
807 </p><hr><a name="recursive_error_pages"></a><strong>syntax</strong>: | 807 </p><hr><a name="recursive_error_pages"></a><strong>syntax</strong>: |
808 <code>recursive_error_pages <code>on</code> | <code>off</code></code><br><strong>default</strong>: | 808 <code>recursive_error_pages <code>on</code> | <code>off</code></code><br><strong>default</strong>: |
809 <code>recursive_error_pages off</code><br><strong>context</strong>: | 809 <code>recursive_error_pages off</code><br><strong>context</strong>: |
810 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 810 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
811 Enables or disables doing several redirects using the | 811 Enables or disables doing several redirects using the |
864 </p><hr><a name="satisfy"></a><strong>syntax</strong>: | 864 </p><hr><a name="satisfy"></a><strong>syntax</strong>: |
865 <code>satisfy <code>all</code> | <code>any</code></code><br><strong>default</strong>: | 865 <code>satisfy <code>all</code> | <code>any</code></code><br><strong>default</strong>: |
866 <code>satisfy all</code><br><strong>context</strong>: | 866 <code>satisfy all</code><br><strong>context</strong>: |
867 <code>location</code><br><p> | 867 <code>location</code><br><p> |
868 Allows access if any of the | 868 Allows access if any of the |
869 <u>http_access</u> | 869 <a href="ngx_http_access_module.html">http_access</a> |
870 or <u>http_auth_basic</u> | 870 or <a href="ngx_http_auth_basic_module.html">http_auth_basic</a> |
871 modules grant access. | 871 modules grant access. |
872 <blockquote><pre> | 872 <blockquote><pre> |
873 location / { | 873 location / { |
874 satisfy any; | 874 satisfy any; |
875 | 875 |
909 virtual servers. | 909 virtual servers. |
910 Instead, the <a href="#listen">listen</a> directives describe all | 910 Instead, the <a href="#listen">listen</a> directives describe all |
911 addresses and ports that should accept connections for a server, and the | 911 addresses and ports that should accept connections for a server, and the |
912 <a href="#server_name">server_name</a> directive lists all server names. | 912 <a href="#server_name">server_name</a> directive lists all server names. |
913 An example configuration is provided in the | 913 An example configuration is provided in the |
914 <u> | 914 <a href="../virtual_hosts.html"> |
915 Setting Up Virtual Servers</u> document. | 915 Setting Up Virtual Servers</a> document. |
916 </p><hr><a name="server_name"></a><strong>syntax</strong>: | 916 </p><hr><a name="server_name"></a><strong>syntax</strong>: |
917 <code>server_name <code><i>name</i></code> ...</code><br><strong>default</strong>: | 917 <code>server_name <code><i>name</i></code> ...</code><br><strong>default</strong>: |
918 <code>server_name hostname</code><br><strong>context</strong>: | 918 <code>server_name hostname</code><br><strong>context</strong>: |
919 <code>server</code><br><p> | 919 <code>server</code><br><p> |
920 Sets names of the virtual server, for example: | 920 Sets names of the virtual server, for example: |
1013 <code>server_names_hash_max_size <code><i>size</i></code></code><br><strong>default</strong>: | 1013 <code>server_names_hash_max_size <code><i>size</i></code></code><br><strong>default</strong>: |
1014 <code>server_names_hash_max_size 512</code><br><strong>context</strong>: | 1014 <code>server_names_hash_max_size 512</code><br><strong>context</strong>: |
1015 <code>http</code><br><p> | 1015 <code>http</code><br><p> |
1016 Sets the maximum <code><i>size</i></code> of the server names hash tables. | 1016 Sets the maximum <code><i>size</i></code> of the server names hash tables. |
1017 For more information, please refer to | 1017 For more information, please refer to |
1018 <u>Setting Up Hashes</u>. | 1018 <a href="../hash.html">Setting Up Hashes</a>. |
1019 </p><hr><a name="server_names_hash_bucket_size"></a><strong>syntax</strong>: | 1019 </p><hr><a name="server_names_hash_bucket_size"></a><strong>syntax</strong>: |
1020 <code>server_names_hash_bucket_size <code><i>size</i></code></code><br><strong>default</strong>: | 1020 <code>server_names_hash_bucket_size <code><i>size</i></code></code><br><strong>default</strong>: |
1021 <code>server_names_hash_bucket_size 32/64/128</code><br><strong>context</strong>: | 1021 <code>server_names_hash_bucket_size 32/64/128</code><br><strong>context</strong>: |
1022 <code>http</code><br><p> | 1022 <code>http</code><br><p> |
1023 Sets the bucket size for the server names hash tables. | 1023 Sets the bucket size for the server names hash tables. |
1024 Default value depends on the size of the processor's cache line. | 1024 Default value depends on the size of the processor's cache line. |
1025 For more information, please refer to | 1025 For more information, please refer to |
1026 <u>Setting Up Hashes</u>. | 1026 <a href="../hash.html">Setting Up Hashes</a>. |
1027 </p><hr><a name="server_tokens"></a><strong>syntax</strong>: | 1027 </p><hr><a name="server_tokens"></a><strong>syntax</strong>: |
1028 <code>server_tokens <code>on</code> | <code>off</code></code><br><strong>default</strong>: | 1028 <code>server_tokens <code>on</code> | <code>off</code></code><br><strong>default</strong>: |
1029 <code>server_tokens on</code><br><strong>context</strong>: | 1029 <code>server_tokens on</code><br><strong>context</strong>: |
1030 <code>http</code>, <code>server</code>, <code>location</code><br><p> | 1030 <code>http</code>, <code>server</code>, <code>location</code><br><p> |
1031 Enables or disables emitting of nginx version in error messages and in the | 1031 Enables or disables emitting of nginx version in error messages and in the |
1239 </dd><dt><code>$request_body</code></dt><dd> | 1239 </dd><dt><code>$request_body</code></dt><dd> |
1240 request body | 1240 request body |
1241 <p> | 1241 <p> |
1242 The variable's value is made available in locations | 1242 The variable's value is made available in locations |
1243 processed by the | 1243 processed by the |
1244 <u>proxy_pass</u> | 1244 <a href="ngx_http_proxy_module.html#proxy_pass">proxy_pass</a> |
1245 and | 1245 and |
1246 <u>fastcgi_pass</u> | 1246 <a href="ngx_http_fastcgi_module.html#fastcgi_pass">fastcgi_pass</a> |
1247 directives. | 1247 directives. |
1248 </p></dd><dt><code>$request_body_file</code></dt><dd> | 1248 </p></dd><dt><code>$request_body_file</code></dt><dd> |
1249 name of a temporary file with the request body | 1249 name of a temporary file with the request body |
1250 <p> | 1250 <p> |
1251 At the end of processing, the file needs to be removed. | 1251 At the end of processing, the file needs to be removed. |
1253 <a href="#client_body_in_file_only">client_body_in_file_only on</a> | 1253 <a href="#client_body_in_file_only">client_body_in_file_only on</a> |
1254 needs be specified. | 1254 needs be specified. |
1255 When passing the name of a temporary file in a proxied request, | 1255 When passing the name of a temporary file in a proxied request, |
1256 or in a request to a FastCGI server, | 1256 or in a request to a FastCGI server, |
1257 passing of the request body should be disabled by the | 1257 passing of the request body should be disabled by the |
1258 <u>proxy_pass_request_body</u> | 1258 <a href="ngx_http_proxy_module.html#proxy_pass_request_body">proxy_pass_request_body</a> |
1259 and | 1259 and |
1260 <u>fastcgi_pass_request_body</u> | 1260 <a href="ngx_http_fastcgi_module.html#fastcgi_pass_request_body">fastcgi_pass_request_body</a> |
1261 directives, respectively. | 1261 directives, respectively. |
1262 </p></dd><dt><code>$request_uri</code></dt><dd> | 1262 </p></dd><dt><code>$request_uri</code></dt><dd> |
1263 full original request URI (with arguments) | 1263 full original request URI (with arguments) |
1264 </dd><dt><code>$query_string</code></dt><dd> | 1264 </dd><dt><code>$query_string</code></dt><dd> |
1265 same as <code>$args</code></dd><dt><code>$scheme</code></dt><dd> | 1265 same as <code>$args</code></dd><dt><code>$scheme</code></dt><dd> |
1266 request scheme, “<code>http</code>” or “<code>https</code>>”</dd><dt><code>$server_protocol</code></dt><dd> | 1266 request scheme, “<code>http</code>” or “<code>https</code>”</dd><dt><code>$server_protocol</code></dt><dd> |
1267 request protocol, usually | 1267 request protocol, usually |
1268 “<code>HTTP/1.0</code>” | 1268 “<code>HTTP/1.0</code>” |
1269 or | 1269 or |
1270 “<code>HTTP/1.1</code>”</dd><dt><code>$server_addr</code></dt><dd> | 1270 “<code>HTTP/1.1</code>”</dd><dt><code>$server_addr</code></dt><dd> |
1271 an address of the server which accepted a request | 1271 an address of the server which accepted a request |