Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_fastcgi_module.xml @ 1151:4c2324a7eeea

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Corrected the usage of articles and a comma.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 10 Apr 2014 17:56:31 +0400
parents 1501e5848052
children 4e20e4f8f49b
comparison
equal deleted inserted replaced
1150:ed7a62ec7b51 1151:4c2324a7eeea
72 <context>server</context> 72 <context>server</context>
73 <context>location</context> 73 <context>location</context>
74 74
75 <para> 75 <para>
76 Sets the <value>size</value> of the buffer used for reading the first part 76 Sets the <value>size</value> of the buffer used for reading the first part
77 of a response received from the FastCGI server. 77 of the response received from the FastCGI server.
78 This part usually contains a small response header. 78 This part usually contains a small response header.
79 By default, the buffer size is equal to the size of one 79 By default, the buffer size is equal to the size of one
80 buffer set by the <link id="fastcgi_buffers"/> directive. 80 buffer set by the <link id="fastcgi_buffers"/> directive.
81 It can be made smaller however. 81 It can be made smaller, however.
82 </para> 82 </para>
83 83
84 </directive> 84 </directive>
85 85
86 86
106 <link id="fastcgi_max_temp_file_size"/> and 106 <link id="fastcgi_max_temp_file_size"/> and
107 <link id="fastcgi_temp_file_write_size"/> directives. 107 <link id="fastcgi_temp_file_write_size"/> directives.
108 </para> 108 </para>
109 109
110 <para> 110 <para>
111 When buffering is disabled, a response is passed to a client synchronously, 111 When buffering is disabled, the response is passed to a client synchronously,
112 immediately as it is received. 112 immediately as it is received.
113 nginx will not try to read the whole response from the FastCGI server. 113 nginx will not try to read the whole response from the FastCGI server.
114 The maximum size of the data that nginx can receive from the server 114 The maximum size of the data that nginx can receive from the server
115 at a time is set by the <link id="fastcgi_buffer_size"/> directive. 115 at a time is set by the <link id="fastcgi_buffer_size"/> directive.
116 </para> 116 </para>
132 <context>http</context> 132 <context>http</context>
133 <context>server</context> 133 <context>server</context>
134 <context>location</context> 134 <context>location</context>
135 135
136 <para> 136 <para>
137 Sets the <value>number</value> and <value>size</value> of 137 Sets the <value>number</value> and <value>size</value> of the
138 buffers used for reading a response from the FastCGI server, 138 buffers used for reading a response from the FastCGI server,
139 for a single connection. 139 for a single connection.
140 By default, the buffer size is equal to one memory page. 140 By default, the buffer size is equal to one memory page.
141 This is either 4K or 8K, depending on a platform. 141 This is either 4K or 8K, depending on a platform.
142 </para> 142 </para>
154 <para> 154 <para>
155 When <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI 155 When <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI
156 server is enabled, limits the total <value>size</value> of buffers that 156 server is enabled, limits the total <value>size</value> of buffers that
157 can be busy sending a response to the client while the response is not 157 can be busy sending a response to the client while the response is not
158 yet fully read. 158 yet fully read.
159 In the meantime, the rest of the buffers can be used for reading a response 159 In the meantime, the rest of the buffers can be used for reading the response
160 and, if needed, buffering part of a response to a temporary file. 160 and, if needed, buffering part of the response to a temporary file.
161 By default, <value>size</value> is limited by the size of two buffers set by the 161 By default, <value>size</value> is limited by the size of two buffers set by the
162 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives. 162 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives.
163 </para> 163 </para>
164 164
165 </directive> 165 </directive>
518 in the response header. 518 in the response header.
519 This has higher priority than setting of caching time using the directive. 519 This has higher priority than setting of caching time using the directive.
520 The <header>X-Accel-Expires</header> header field sets caching time of a 520 The <header>X-Accel-Expires</header> header field sets caching time of a
521 response in seconds. 521 response in seconds.
522 The zero value disables caching for a response. 522 The zero value disables caching for a response.
523 If a value starts with the <literal>@</literal> prefix, it sets an absolute 523 If the value starts with the <literal>@</literal> prefix, it sets an absolute
524 time in seconds since Epoch, up to which the response may be cached. 524 time in seconds since Epoch, up to which the response may be cached.
525 If header does not include the <header>X-Accel-Expires</header> field, 525 If the header does not include the <header>X-Accel-Expires</header> field,
526 parameters of caching may be set in the header fields 526 parameters of caching may be set in the header fields
527 <header>Expires</header> or <header>Cache-Control</header>. 527 <header>Expires</header> or <header>Cache-Control</header>.
528 If a header includes the <header>Set-Cookie</header> field, such a 528 If the header includes the <header>Set-Cookie</header> field, such a
529 response will not be cached. 529 response will not be cached.
530 Processing of one or more of these response header fields can be disabled 530 Processing of one or more of these response header fields can be disabled
531 using the <link id="fastcgi_ignore_headers"/> directive. 531 using the <link id="fastcgi_ignore_headers"/> directive.
532 </para> 532 </para>
533 533
603 <context>server</context> 603 <context>server</context>
604 <context>location</context> 604 <context>location</context>
605 605
606 <para> 606 <para>
607 Determines whether the connection with a FastCGI server should be 607 Determines whether the connection with a FastCGI server should be
608 closed when a client closes a connection without waiting 608 closed when a client closes the connection without waiting
609 for a response. 609 for a response.
610 </para> 610 </para>
611 611
612 </directive> 612 </directive>
613 613
740 <para> 740 <para>
741 When <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI 741 When <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI
742 server is enabled, and the whole response does not fit into the memory buffers 742 server is enabled, and the whole response does not fit into the memory buffers
743 set by the <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> 743 set by the <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/>
744 directives, a part of the response can be saved to a temporary file. 744 directives, a part of the response can be saved to a temporary file.
745 This directive sets the maximum <value>size</value> of a temporary file. 745 This directive sets the maximum <value>size</value> of the temporary file.
746 The size of data written to a temporary file at a time is set 746 The size of data written to the temporary file at a time is set
747 by the <link id="fastcgi_temp_file_write_size"/> directive. 747 by the <link id="fastcgi_temp_file_write_size"/> directive.
748 </para> 748 </para>
749 749
750 <para> 750 <para>
751 The zero value disables buffering of responses to temporary files. 751 The zero value disables buffering of responses to temporary files.
856 <context>server</context> 856 <context>server</context>
857 <context>location</context> 857 <context>location</context>
858 858
859 <para> 859 <para>
860 Sets a <value>parameter</value> that should be passed to the FastCGI server. 860 Sets a <value>parameter</value> that should be passed to the FastCGI server.
861 A <value>value</value> can contain text, variables, and their combination. 861 The <value>value</value> can contain text, variables, and their combination.
862 These directives are inherited from the previous level if and 862 These directives are inherited from the previous level if and
863 only if there are no 863 only if there are no
864 <literal>fastcgi_param</literal> 864 <literal>fastcgi_param</literal>
865 directives defined on the current level. 865 directives defined on the current level.
866 </para> 866 </para>
1215 1215
1216 1216
1217 <section id="parameters" name="Parameters Passed to a FastCGI Server"> 1217 <section id="parameters" name="Parameters Passed to a FastCGI Server">
1218 1218
1219 <para> 1219 <para>
1220 HTTP request header fields are passed to the FastCGI server as parameters. 1220 HTTP request header fields are passed to a FastCGI server as parameters.
1221 In applications and scripts running as FastCGI servers, 1221 In applications and scripts running as FastCGI servers,
1222 these parameters are usually made available as environment variables. 1222 these parameters are usually made available as environment variables.
1223 For example, the <header>User-Agent</header> header field is passed as the 1223 For example, the <header>User-Agent</header> header field is passed as the
1224 <literal>HTTP_USER_AGENT</literal> parameter. 1224 <literal>HTTP_USER_AGENT</literal> parameter.
1225 In addition to HTTP request header fields, it is possible to pass arbitrary 1225 In addition to HTTP request header fields, it is possible to pass arbitrary