diff 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
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_proxy_module.xml	Tue Oct 28 18:18:52 2014 +0300
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml	Mon Oct 06 14:49:16 2014 +0400
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_proxy_module"
         link="/en/docs/http/ngx_http_proxy_module.html"
         lang="en"
-        rev="26">
+        rev="27">
 
 <section id="summary">
 
@@ -873,6 +873,29 @@
 </directive>
 
 
+<directive name="proxy_limit_rate">
+<syntax><value>rate</value></syntax>
+<default>0</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.7.7</appeared-in>
+
+<para>
+Limits the speed of reading the response from the proxied server.
+The <value>rate</value> is specified in bytes per second.
+The zero value disables rate limiting.
+The limit is set per a request, and so if nginx simultaneously opens
+two connections, the overall rate will be twice as much
+as the specified limit.
+The limitation works only if
+<link id="proxy_buffering">buffering</link> of responses from the proxied
+server is enabled.
+</para>
+
+</directive>
+
+
 <directive name="proxy_max_temp_file_size">
 <syntax><value>size</value></syntax>
 <default>1024m</default>