comparison xml/en/docs/http/ngx_http_fastcgi_module.xml @ 411:f8248d0e3c8f

Documented the following directives: fastcgi_busy_buffers_size, fastcgi_max_temp_file_size, and fastcgi_temp_file_write_size.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 14 Feb 2012 11:03:53 +0000
parents bb51d3e17dd0
children 65843513cff5
comparison
equal deleted inserted replaced
410:e766fa4c2dbb 411:f8248d0e3c8f
68 Sets the <value>number</value> and <value>size</value> of 68 Sets the <value>number</value> and <value>size</value> of
69 buffers used for reading a response from the FastCGI server, 69 buffers used for reading a response from the FastCGI server,
70 for a single connection. 70 for a single connection.
71 By default, the buffer size is equal to one memory page. 71 By default, the buffer size is equal to one memory page.
72 This is either 4K or 8K, depending on a platform. 72 This is either 4K or 8K, depending on a platform.
73 </para>
74
75 </directive>
76
77
78 <directive name="fastcgi_busy_buffers_size">
79 <syntax><value>size</value></syntax>
80 <default>8k|16k</default>
81 <context>http</context>
82 <context>server</context>
83 <context>location</context>
84
85 <para>
86 Limits the total <value>size</value> of buffers that
87 can be busy sending a response to the client while the response is not
88 yet fully read.
89 In the mean time, the rest of the buffers can be used for reading a response
90 and, if needed, buffering part of a response to a temporary file.
91 By default, <value>size</value> is limited by two buffers set by the
92 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives.
73 </para> 93 </para>
74 94
75 </directive> 95 </directive>
76 96
77 97
435 </para> 455 </para>
436 456
437 </directive> 457 </directive>
438 458
439 459
460 <directive name="fastcgi_max_temp_file_size">
461 <syntax><value>size</value></syntax>
462 <default>1024m</default>
463 <context>http</context>
464 <context>server</context>
465 <context>location</context>
466
467 <para>
468 When the whole response does not fit into memory buffers
469 set by the <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/>
470 directives, part of a response can be saved to a temporary file.
471 This directive sets the maximum <value>size</value> of a temporary file.
472 The size of data written to a temporary file at a time is set
473 by the <link id="fastcgi_temp_file_write_size"/> directive.
474 </para>
475
476 <para>
477 Value of zero disables buffering of responses to temporary files.
478 </para>
479
480 </directive>
481
482
440 <directive name="fastcgi_next_upstream"> 483 <directive name="fastcgi_next_upstream">
441 <syntax> 484 <syntax>
442 <literal>error</literal> | 485 <literal>error</literal> |
443 <literal>timeout</literal> | 486 <literal>timeout</literal> |
444 <literal>invalid_header</literal> | 487 <literal>invalid_header</literal> |
770 </para> 813 </para>
771 814
772 </directive> 815 </directive>
773 816
774 817
818 <directive name="fastcgi_temp_file_write_size">
819 <syntax><value>size</value></syntax>
820 <default>8k|16k</default>
821 <context>http</context>
822 <context>server</context>
823 <context>location</context>
824
825 <para>
826 Limits the <value>size</value> of data written to a temporary file
827 at a time, when buffering of responses from the FastCGI server
828 to temporary files is enabled.
829 By default, <value>size</value> is limited by two buffers set by the
830 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives.
831 The maximum size of a temporary file is set by the
832 <link id="fastcgi_max_temp_file_size"/> directive.
833 </para>
834
835 </directive>
836
837
775 <directive name="fastcgi_temp_path"> 838 <directive name="fastcgi_temp_path">
776 <syntax> 839 <syntax>
777 <value>path</value> 840 <value>path</value>
778 [<value>level1</value> 841 [<value>level1</value>
779 [<value>level2</value> 842 [<value>level2</value>
783 <context>server</context> 846 <context>server</context>
784 <context>location</context> 847 <context>location</context>
785 848
786 <para> 849 <para>
787 Defines a directory for storing temporary files 850 Defines a directory for storing temporary files
788 received from another server. 851 with data received from FastCGI servers.
789 Up to three-level subdirectory hierarchy can be used underneath the specified 852 Up to three-level subdirectory hierarchy can be used underneath the specified
790 directory. 853 directory.
791 For example, in the following configuration 854 For example, in the following configuration
792 <example> 855 <example>
793 fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2; 856 fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2;