comparison xml/en/docs/http/ngx_http_proxy_module.xml @ 1342:758fc0b02651

Documented the "proxy_limit_rate" directive and friends.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 06 Oct 2014 14:49:16 +0400
parents 91a064bdb4f9
children 1bdde28e359b
comparison
equal deleted inserted replaced
1341:a4b94d724879 1342:758fc0b02651
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_proxy_module" 10 <module name="Module ngx_http_proxy_module"
11 link="/en/docs/http/ngx_http_proxy_module.html" 11 link="/en/docs/http/ngx_http_proxy_module.html"
12 lang="en" 12 lang="en"
13 rev="26"> 13 rev="27">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_proxy_module</literal> module allows passing 18 The <literal>ngx_http_proxy_module</literal> module allows passing
871 </para> 871 </para>
872 872
873 </directive> 873 </directive>
874 874
875 875
876 <directive name="proxy_limit_rate">
877 <syntax><value>rate</value></syntax>
878 <default>0</default>
879 <context>http</context>
880 <context>server</context>
881 <context>location</context>
882 <appeared-in>1.7.7</appeared-in>
883
884 <para>
885 Limits the speed of reading the response from the proxied server.
886 The <value>rate</value> is specified in bytes per second.
887 The zero value disables rate limiting.
888 The limit is set per a request, and so if nginx simultaneously opens
889 two connections, the overall rate will be twice as much
890 as the specified limit.
891 The limitation works only if
892 <link id="proxy_buffering">buffering</link> of responses from the proxied
893 server is enabled.
894 </para>
895
896 </directive>
897
898
876 <directive name="proxy_max_temp_file_size"> 899 <directive name="proxy_max_temp_file_size">
877 <syntax><value>size</value></syntax> 900 <syntax><value>size</value></syntax>
878 <default>1024m</default> 901 <default>1024m</default>
879 <context>http</context> 902 <context>http</context>
880 <context>server</context> 903 <context>server</context>