Mercurial > hg > nginx-quic
comparison docs/xml/http/ngx_http_core_module.xml @ 4108:5e2103cffd80
- The module name is now also output as an HTML header.
- Agreed that examples can only contain literal text.
- Agreed to call modules "ngx_*_module".
- Renamed XML element "http-error" to a more general "http-status".
- Fixed text of error codes to match the actual code.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 15 Sep 2011 08:24:33 +0000 |
parents | 44c1953c266c |
children | a18b10aea510 |
comparison
equal
deleted
inserted
replaced
4107:7705911c9d10 | 4108:5e2103cffd80 |
---|---|
200 into a file. | 200 into a file. |
201 This directive can be used during debugging, or when using the | 201 This directive can be used during debugging, or when using the |
202 <var>$request_body_file</var> | 202 <var>$request_body_file</var> |
203 variable, or the | 203 variable, or the |
204 <link doc="ngx_http_perl_module.xml" id="methods">$r->request_body_file</link> | 204 <link doc="ngx_http_perl_module.xml" id="methods">$r->request_body_file</link> |
205 method of the | 205 method of the module |
206 <link doc="ngx_http_perl_module.xml">http_perl</link> module. | 206 <link doc="ngx_http_perl_module.xml">ngx_http_perl_module</link>. |
207 </para> | 207 </para> |
208 | 208 |
209 <para> | 209 <para> |
210 When set to the value <value>on</value>, temporary files are not | 210 When set to the value <value>on</value>, temporary files are not |
211 removed after request processing. | 211 removed after request processing. |
298 <para> | 298 <para> |
299 Defines a timeout for reading client request body. | 299 Defines a timeout for reading client request body. |
300 A timeout is only set between two successive read operations, | 300 A timeout is only set between two successive read operations, |
301 not for the transmission of the whole request body. | 301 not for the transmission of the whole request body. |
302 If a client does not transmit anything within this time, | 302 If a client does not transmit anything within this time, |
303 the error | 303 the client error |
304 <http-error code="408" text="Request time out"/> | 304 <http-status code="408" text="Request Time-out"/> |
305 is returned. | 305 is returned. |
306 </para> | 306 </para> |
307 | 307 |
308 </directive> | 308 </directive> |
309 | 309 |
335 <context>server</context> | 335 <context>server</context> |
336 | 336 |
337 <para> | 337 <para> |
338 Defines a timeout for reading client request header. | 338 Defines a timeout for reading client request header. |
339 If a client does not transmit the entire header within this time, | 339 If a client does not transmit the entire header within this time, |
340 the error | 340 the client error |
341 <http-error code="408" text="Request time out"/> | 341 <http-status code="408" text="Request Time-out"/> |
342 is returned. | 342 is returned. |
343 </para> | 343 </para> |
344 | 344 |
345 </directive> | 345 </directive> |
346 | 346 |
355 <para> | 355 <para> |
356 Sets the maximum allowed size of the client request body, | 356 Sets the maximum allowed size of the client request body, |
357 specified in the | 357 specified in the |
358 <header>Content-Length</header> | 358 <header>Content-Length</header> |
359 request header field. | 359 request header field. |
360 If <argument>size</argument> is greater than the configured value, the | 360 If it exceeds the configured value, the client error |
361 <http-error code="413" text="Request Entity Too Large"/> | 361 <http-status code="413" text="Request Entity Too Large"/> |
362 error is returned to a client. | 362 is returned. |
363 Please be aware that | 363 Please be aware that |
364 <link doc="/web/upload.xml">browsers cannot correctly display | 364 <link doc="/web/upload.xml">browsers cannot correctly display |
365 this error</link>. | 365 this error</link>. |
366 </para> | 366 </para> |
367 | 367 |
537 <default/> | 537 <default/> |
538 <context>location</context> | 538 <context>location</context> |
539 | 539 |
540 <para> | 540 <para> |
541 Specifies that a given location can only be used for internal requests. | 541 Specifies that a given location can only be used for internal requests. |
542 For external requests, the <http-error code="404" text="Not found"/> | 542 For external requests, the client error |
543 error is returned. | 543 <http-status code="404" text="Not Found"/> |
544 is returned. | |
544 Internal requests are the following: | 545 Internal requests are the following: |
545 | 546 |
546 <list type="bullet"> | 547 <list type="bullet"> |
547 | 548 |
548 <listitem> | 549 <listitem> |
550 </listitem> | 551 </listitem> |
551 | 552 |
552 <listitem> | 553 <listitem> |
553 subrequests formed by the | 554 subrequests formed by the |
554 <command>include virtual</command> | 555 <command>include virtual</command> |
555 command of the | 556 command of the module |
556 <link doc="ngx_http_ssi_module.xml">http_ssi</link> module; | 557 <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>; |
557 </listitem> | 558 </listitem> |
558 | 559 |
559 <listitem> | 560 <listitem> |
560 requests changed by the | 561 requests changed by the |
561 <link doc="ngx_http_rewrite_module.xml" id="rewrite">rewrite</link> | 562 <link doc="ngx_http_rewrite_module.xml" id="rewrite">rewrite</link> |
562 directive of the | 563 directive of the module |
563 <link doc="ngx_http_rewrite_module.xml">http_rewrite</link> module. | 564 <link doc="ngx_http_rewrite_module.xml">ngx_http_rewrite_module</link>. |
564 </listitem> | 565 </listitem> |
565 | 566 |
566 </list> | 567 </list> |
567 </para> | 568 </para> |
568 | 569 |
631 <context>server</context> | 632 <context>server</context> |
632 | 633 |
633 <para> | 634 <para> |
634 Sets the maximum <argument>number</argument> and <argument>size</argument> of | 635 Sets the maximum <argument>number</argument> and <argument>size</argument> of |
635 buffers used when reading large client request headers. | 636 buffers used when reading large client request headers. |
636 A request line cannot exceed the size of one buffer, or the | 637 A request line cannot exceed the size of one buffer, or the client error |
637 <http-error code="414" text="Request URI too large"/> | 638 <http-status code="414" text="Request-URI Too Large"/> |
638 error is returned. | 639 is returned. |
639 A request header field cannot exceed the size of one buffer as well, or the | 640 A request header field cannot exceed the size of one buffer as well, or the |
640 <http-error code="400" text="Bad request"/> | 641 client error |
641 error is returned. | 642 <http-status code="400" text="Bad Request"/> |
643 is returned. | |
642 Buffers are allocated only on demand. | 644 Buffers are allocated only on demand. |
643 By default, the buffer size is equal to one memory page size. | 645 By default, the buffer size is equal to one memory page size. |
644 It is either 4K or 8K, platform dependent. | 646 It is either 4K or 8K, platform dependent. |
645 If after the end of request processing a connection is transitioned | 647 If after the end of request processing a connection is transitioned |
646 into the keep-alive state, these buffers are freed. | 648 into the keep-alive state, these buffers are freed. |
656 | 658 |
657 <para> | 659 <para> |
658 Limits allowed HTTP methods inside a location. | 660 Limits allowed HTTP methods inside a location. |
659 The GET method also implies the HEAD method. | 661 The GET method also implies the HEAD method. |
660 Access to other methods can be limited using the | 662 Access to other methods can be limited using the |
661 <link doc="ngx_http_access_module.xml">http_access</link> | 663 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link> |
662 and | 664 and |
663 <link doc="ngx_http_auth_basic_module.xml">http_auth_basic</link> | 665 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link> |
664 modules directives: | 666 modules directives: |
665 <example> | 667 <example> |
666 limit_except GET { | 668 limit_except GET { |
667 allow 192.168.1.0/32; | 669 allow 192.168.1.0/32; |
668 deny all; | 670 deny all; |
1475 <default>satisfy all</default> | 1477 <default>satisfy all</default> |
1476 <context>location</context> | 1478 <context>location</context> |
1477 | 1479 |
1478 <para> | 1480 <para> |
1479 Allows access if any of the | 1481 Allows access if any of the |
1480 <link doc="ngx_http_access_module.xml">http_access</link> | 1482 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link> |
1481 or <link doc="ngx_http_auth_basic_module.xml">http_auth_basic</link> | 1483 or <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link> |
1482 modules grant access. | 1484 modules grant access. |
1483 <example> | 1485 <example> |
1484 location / { | 1486 location / { |
1485 satisfy any; | 1487 satisfy any; |
1486 | 1488 |
1983 </section> | 1985 </section> |
1984 | 1986 |
1985 <section id="variables" name="Embedded Variables"> | 1987 <section id="variables" name="Embedded Variables"> |
1986 | 1988 |
1987 <para> | 1989 <para> |
1988 The http_core module supports embedded variables with names matching | 1990 The module <code>ngx_http_core_module</code> supports embedded variables with |
1989 those of the Apache Server. | 1991 names matching those of the Apache Server. |
1990 First of all, these are variables representing client request header | 1992 First of all, these are variables representing client request header |
1991 fields, such as, <var>$http_user_agent</var>, <var>$http_cookie</var>, | 1993 fields, such as, <var>$http_user_agent</var>, <var>$http_cookie</var>, |
1992 and so on. | 1994 and so on. |
1993 It also supports other variables: | 1995 It also supports other variables: |
1994 <list type="tag"> | 1996 <list type="tag"> |