Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_proxy_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
66 <context>http</context> 66 <context>http</context>
67 <context>server</context> 67 <context>server</context>
68 <context>location</context> 68 <context>location</context>
69 69
70 <para> 70 <para>
71 Sets the <value>size</value> of the buffer used for reading the first part 71 Sets the size of the buffer <value>size</value> used for reading the first part
72 of a response received from the proxied server. 72 of the response received from the proxied server.
73 This part usually contains a small response header. 73 This part usually contains a small response header.
74 By default, the buffer size is equal to the size of one 74 By default, the buffer size is equal to the size of one
75 buffer set by the <link id="proxy_buffers"/> directive. 75 buffer set by the <link id="proxy_buffers"/> directive.
76 It can be made smaller however. 76 It can be made smaller, however.
77 </para> 77 </para>
78 78
79 </directive> 79 </directive>
80 80
81 81
100 <link id="proxy_max_temp_file_size"/> and 100 <link id="proxy_max_temp_file_size"/> and
101 <link id="proxy_temp_file_write_size"/> directives. 101 <link id="proxy_temp_file_write_size"/> directives.
102 </para> 102 </para>
103 103
104 <para> 104 <para>
105 When buffering is disabled, a response is passed to a client synchronously, 105 When buffering is disabled, the response is passed to a client synchronously,
106 immediately as it is received. 106 immediately as it is received.
107 nginx will not try to read the whole response from the proxied server. 107 nginx will not try to read the whole response from the proxied server.
108 The maximum size of the data that nginx can receive from the server 108 The maximum size of the data that nginx can receive from the server
109 at a time is set by the <link id="proxy_buffer_size"/> directive. 109 at a time is set by the <link id="proxy_buffer_size"/> directive.
110 </para> 110 </para>
126 <context>http</context> 126 <context>http</context>
127 <context>server</context> 127 <context>server</context>
128 <context>location</context> 128 <context>location</context>
129 129
130 <para> 130 <para>
131 Sets the <value>number</value> and <value>size</value> of 131 Sets the <value>number</value> and <value>size</value> of the
132 buffers used for reading a response from the proxied server, 132 buffers used for reading a response from the proxied server,
133 for a single connection. 133 for a single connection.
134 By default, the buffer size is equal to one memory page. 134 By default, the buffer size is equal to one memory page.
135 This is either 4K or 8K, depending on a platform. 135 This is either 4K or 8K, depending on a platform.
136 </para> 136 </para>
148 <para> 148 <para>
149 When <link id="proxy_buffering">buffering</link> of responses from the proxied 149 When <link id="proxy_buffering">buffering</link> of responses from the proxied
150 server is enabled, limits the total <value>size</value> of buffers that 150 server is enabled, limits the total <value>size</value> of buffers that
151 can be busy sending a response to the client while the response is not 151 can be busy sending a response to the client while the response is not
152 yet fully read. 152 yet fully read.
153 In the meantime, the rest of the buffers can be used for reading a response 153 In the meantime, the rest of the buffers can be used for reading the response
154 and, if needed, buffering part of a response to a temporary file. 154 and, if needed, buffering part of the response to a temporary file.
155 By default, <value>size</value> is limited by the size of two buffers set by the 155 By default, <value>size</value> is limited by the size of two buffers set by the
156 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. 156 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives.
157 </para> 157 </para>
158 158
159 </directive> 159 </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="proxy_ignore_headers"/> directive. 531 using the <link id="proxy_ignore_headers"/> directive.
532 </para> 532 </para>
533 533
770 <context>server</context> 770 <context>server</context>
771 <context>location</context> 771 <context>location</context>
772 772
773 <para> 773 <para>
774 Determines whether the connection with a proxied server should be 774 Determines whether the connection with a proxied server should be
775 closed when a client closes a connection without waiting 775 closed when a client closes the connection without waiting
776 for a response. 776 for a response.
777 </para> 777 </para>
778 778
779 </directive> 779 </directive>
780 780
861 <para> 861 <para>
862 When <link id="proxy_buffering">buffering</link> of responses from the proxied 862 When <link id="proxy_buffering">buffering</link> of responses from the proxied
863 server is enabled, and the whole response does not fit into the memory buffers 863 server is enabled, and the whole response does not fit into the memory buffers
864 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> 864 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/>
865 directives, a part of the response can be saved to a temporary file. 865 directives, a part of the response can be saved to a temporary file.
866 This directive sets the maximum <value>size</value> of a temporary file. 866 This directive sets the maximum <value>size</value> of the temporary file.
867 The size of data written to a temporary file at a time is set 867 The size of data written to the temporary file at a time is set
868 by the <link id="proxy_temp_file_write_size"/> directive. 868 by the <link id="proxy_temp_file_write_size"/> directive.
869 </para> 869 </para>
870 870
871 <para> 871 <para>
872 The zero value disables buffering of responses to temporary files. 872 The zero value disables buffering of responses to temporary files.
1363 <context>server</context> 1363 <context>server</context>
1364 <context>location</context> 1364 <context>location</context>
1365 1365
1366 <para> 1366 <para>
1367 Allows redefining the request body passed to the proxied server. 1367 Allows redefining the request body passed to the proxied server.
1368 A <value>value</value> can contain text, variables, and their combination. 1368 The <value>value</value> can contain text, variables, and their combination.
1369 </para> 1369 </para>
1370 1370
1371 </directive> 1371 </directive>
1372 1372
1373 1373
1380 <context>location</context> 1380 <context>location</context>
1381 1381
1382 <para> 1382 <para>
1383 Allows redefining or appending fields to the request header 1383 Allows redefining or appending fields to the request header
1384 <link id="proxy_pass_request_headers">passed</link> to the proxied server. 1384 <link id="proxy_pass_request_headers">passed</link> to the proxied server.
1385 A <value>value</value> can contain text, variables, and their combinations. 1385 The <value>value</value> can contain text, variables, and their combinations.
1386 These directives are inherited from the previous level if and 1386 These directives are inherited from the previous level if and
1387 only if there are no 1387 only if there are no
1388 <literal>proxy_set_header</literal> 1388 <literal>proxy_set_header</literal>
1389 directives defined on the current level. 1389 directives defined on the current level.
1390 By default, only two fields are redefined: 1390 By default, only two fields are redefined: