Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_proxy_module.xml @ 405:781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
proxy_max_temp_file_size, and proxy_temp_file_write_size.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Fri, 10 Feb 2012 13:27:50 +0000 |
parents | bb51d3e17dd0 |
children | cbc2d1b51cb6 |
comparison
equal
deleted
inserted
replaced
404:1bd794e9cea4 | 405:781b23ba3b0a |
---|---|
58 <context>http</context> | 58 <context>http</context> |
59 <context>server</context> | 59 <context>server</context> |
60 <context>location</context> | 60 <context>location</context> |
61 | 61 |
62 <para> | 62 <para> |
63 Enables or disables buffering a response from the proxied server. | 63 Enables or disables buffering of responses from the proxied server. |
64 </para> | 64 </para> |
65 | 65 |
66 <para> | 66 <para> |
67 When buffering is enabled, nginx receives a response from the proxied server | 67 When buffering is enabled, nginx receives a response from the proxied server |
68 as soon as possible, saving it into buffers set by the | 68 as soon as possible, saving it into buffers set by the |
69 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. | 69 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. |
70 If the whole response does not fit into memory, part of it is saved to a disk. | 70 If the whole response does not fit into memory, part of it can be saved |
71 to a <link id="proxy_temp_path">temporary file</link> on disk. | |
72 Writes to temporary files are controlled by the | |
73 <link id="proxy_max_temp_file_size"/> and | |
74 <link id="proxy_temp_file_write_size"/> directives. | |
71 </para> | 75 </para> |
72 | 76 |
73 <para> | 77 <para> |
74 When buffering is disabled, a response is passed to a client synchronously, | 78 When buffering is disabled, a response is passed to a client synchronously, |
75 immediately as it is received. | 79 immediately as it is received. |
92 Sets the <value>number</value> and <value>size</value> of | 96 Sets the <value>number</value> and <value>size</value> of |
93 buffers used for reading a response from the proxied server, | 97 buffers used for reading a response from the proxied server, |
94 for a single connection. | 98 for a single connection. |
95 By default, the buffer size is equal to one memory page. | 99 By default, the buffer size is equal to one memory page. |
96 This is either 4K or 8K, depending on a platform. | 100 This is either 4K or 8K, depending on a platform. |
101 </para> | |
102 | |
103 </directive> | |
104 | |
105 | |
106 <directive name="proxy_busy_buffers_size"> | |
107 <syntax><value>size</value></syntax> | |
108 <default>8k|16k</default> | |
109 <context>http</context> | |
110 <context>server</context> | |
111 <context>location</context> | |
112 | |
113 <para> | |
114 When <link id="proxy_buffering">buffering</link> of responses from the proxied | |
115 server is enabled, limits the total <value>size</value> of buffers that | |
116 can be busy sending a response to the client while the response is not | |
117 yet fully read. | |
118 In the mean time, the rest of the buffers can be used for reading a response | |
119 and, if needed, buffering part of a response to a temporary file. | |
120 By default, <value>size</value> is limited by two buffers set by the | |
121 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. | |
97 </para> | 122 </para> |
98 | 123 |
99 </directive> | 124 </directive> |
100 | 125 |
101 | 126 |
440 </para> | 465 </para> |
441 | 466 |
442 </directive> | 467 </directive> |
443 | 468 |
444 | 469 |
470 <directive name="proxy_max_temp_file_size"> | |
471 <syntax><value>size</value></syntax> | |
472 <default>1024m</default> | |
473 <context>http</context> | |
474 <context>server</context> | |
475 <context>location</context> | |
476 | |
477 <para> | |
478 When <link id="proxy_buffering">buffering</link> of responses from the proxied | |
479 server is enabled, and the whole response does not fit into memory buffers | |
480 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> | |
481 directives, part of a response can be saved to a temporary file. | |
482 This directive sets the maximum <value>size</value> of a temporary file. | |
483 The size of data written to a temporary file at a time is set | |
484 by the <link id="proxy_temp_file_write_size"/> directive. | |
485 </para> | |
486 | |
487 <para> | |
488 Value of zero disables buffering of responses to temporary files. | |
489 </para> | |
490 | |
491 </directive> | |
492 | |
493 | |
445 <directive name="proxy_next_upstream"> | 494 <directive name="proxy_next_upstream"> |
446 <syntax> | 495 <syntax> |
447 <literal>error</literal> | | 496 <literal>error</literal> | |
448 <literal>timeout</literal> | | 497 <literal>timeout</literal> | |
449 <literal>invalid_header</literal> | | 498 <literal>invalid_header</literal> | |
982 </para> | 1031 </para> |
983 | 1032 |
984 </directive> | 1033 </directive> |
985 | 1034 |
986 | 1035 |
1036 <directive name="proxy_temp_file_write_size"> | |
1037 <syntax><value>size</value></syntax> | |
1038 <default>8k|16k</default> | |
1039 <context>http</context> | |
1040 <context>server</context> | |
1041 <context>location</context> | |
1042 | |
1043 <para> | |
1044 Limits the <value>size</value> of data written to a temporary file | |
1045 at a time, when buffering of responses from the proxied server | |
1046 to temporary files is enabled. | |
1047 By default, <value>size</value> is limited by two buffers set by the | |
1048 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. | |
1049 The maximum size of a temporary file is set by the | |
1050 <link id="proxy_max_temp_file_size"/> directive. | |
1051 </para> | |
1052 | |
1053 </directive> | |
1054 | |
1055 | |
987 <directive name="proxy_temp_path"> | 1056 <directive name="proxy_temp_path"> |
988 <syntax> | 1057 <syntax> |
989 <value>path</value> | 1058 <value>path</value> |
990 [<value>level1</value> | 1059 [<value>level1</value> |
991 [<value>level2</value> | 1060 [<value>level2</value> |
995 <context>server</context> | 1064 <context>server</context> |
996 <context>location</context> | 1065 <context>location</context> |
997 | 1066 |
998 <para> | 1067 <para> |
999 Defines a directory for storing temporary files | 1068 Defines a directory for storing temporary files |
1000 received from another server. | 1069 with data received from proxied servers. |
1001 Up to three-level subdirectory hierarchy can be used underneath the specified | 1070 Up to three-level subdirectory hierarchy can be used underneath the specified |
1002 directory. | 1071 directory. |
1003 For example, in the following configuration | 1072 For example, in the following configuration |
1004 <example> | 1073 <example> |
1005 proxy_temp_path /spool/nginx/proxy_temp 1 2; | 1074 proxy_temp_path /spool/nginx/proxy_temp 1 2; |