# HG changeset patch
# User Yaroslav Zhuravlev <yar@nginx.com>
# Date 1412592556 -14400
# Node ID 758fc0b0265189a24516d54c685afd2d090535a9
# Parent  a4b94d724879355b111db3fe74b8cc90fd89ac0b
Documented the "proxy_limit_rate" directive and friends.

diff --git a/xml/en/docs/http/ngx_http_fastcgi_module.xml b/xml/en/docs/http/ngx_http_fastcgi_module.xml
--- a/xml/en/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/en/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_fastcgi_module"
         link="/en/docs/http/ngx_http_fastcgi_module.html"
         lang="en"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -731,6 +731,29 @@ with the <link doc="ngx_http_core_module
 </directive>
 
 
+<directive name="fastcgi_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 FastCGI 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="fastcgi_buffering">buffering</link> of responses from the FastCGI
+server is enabled.
+</para>
+
+</directive>
+
+
 <directive name="fastcgi_keep_conn">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>off</default>
diff --git a/xml/en/docs/http/ngx_http_proxy_module.xml b/xml/en/docs/http/ngx_http_proxy_module.xml
--- a/xml/en/docs/http/ngx_http_proxy_module.xml
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml
@@ -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 @@ with the <link doc="ngx_http_core_module
 </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>
diff --git a/xml/en/docs/http/ngx_http_scgi_module.xml b/xml/en/docs/http/ngx_http_scgi_module.xml
--- a/xml/en/docs/http/ngx_http_scgi_module.xml
+++ b/xml/en/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_scgi_module"
         link="/en/docs/http/ngx_http_scgi_module.html"
         lang="en"
-        rev="7">
+        rev="8">
 
 <section id="summary">
 
@@ -671,6 +671,29 @@ with the <link doc="ngx_http_core_module
 </directive>
 
 
+<directive name="scgi_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 SCGI 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="scgi_buffering">buffering</link> of responses from the SCGI
+server is enabled.
+</para>
+
+</directive>
+
+
 <directive name="scgi_max_temp_file_size">
 <syntax><value>size</value></syntax>
 <default>1024m</default>
diff --git a/xml/en/docs/http/ngx_http_uwsgi_module.xml b/xml/en/docs/http/ngx_http_uwsgi_module.xml
--- a/xml/en/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/en/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_uwsgi_module"
         link="/en/docs/http/ngx_http_uwsgi_module.html"
         lang="en"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -671,6 +671,30 @@ with the <link doc="ngx_http_core_module
 </directive>
 
 
+<directive name="uwsgi_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 uwsgi 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="uwsgi_buffering">buffering</link> of responses from the uwsgi
+server is enabled.
+</para>
+
+</directive>
+
+
+
 <directive name="uwsgi_max_temp_file_size">
 <syntax><value>size</value></syntax>
 <default>1024m</default>
diff --git a/xml/ru/docs/http/ngx_http_fastcgi_module.xml b/xml/ru/docs/http/ngx_http_fastcgi_module.xml
--- a/xml/ru/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_fastcgi_module"
         link="/ru/docs/http/ngx_http_fastcgi_module.html"
         lang="ru"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -729,6 +729,29 @@ fastcgi_param SCRIPT_FILENAME /home/www/
 </directive>
 
 
+<directive name="fastcgi_limit_rate">
+<syntax><value>скорость</value></syntax>
+<default>0</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.7.7</appeared-in>
+
+<para>
+Ограничивает скорость чтения ответа от FastCGI-сервера.
+<value>Скорость</value> задаётся в байтах в секунду.
+Значение 0 отключает ограничение скорости.
+Ограничение устанавливается на запрос,
+поэтому, если nginx одновременно
+откроет два соединения, суммарная скорость будет вдвое выше
+заданного ограничения.
+Ограничение работает только в случае, если включена
+<link id="fastcgi_buffering">буферизация</link> ответов FastCGI-сервера.
+</para>
+
+</directive>
+
+
 <directive name="fastcgi_keep_conn">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>off</default>
diff --git a/xml/ru/docs/http/ngx_http_proxy_module.xml b/xml/ru/docs/http/ngx_http_proxy_module.xml
--- a/xml/ru/docs/http/ngx_http_proxy_module.xml
+++ b/xml/ru/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_proxy_module"
         link="/ru/docs/http/ngx_http_proxy_module.html"
         lang="ru"
-        rev="26">
+        rev="27">
 
 <section id="summary">
 
@@ -870,6 +870,29 @@ nginx не передаёт клиенту поля заголовка <header>Date</header>,
 </directive>
 
 
+<directive name="proxy_limit_rate">
+<syntax><value>скорость</value></syntax>
+<default>0</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.7.7</appeared-in>
+
+<para>
+Ограничивает скорость чтения ответа от проксируемого сервера.
+<value>Скорость</value> задаётся в байтах в секунду.
+Значение 0 отключает ограничение скорости.
+Ограничение устанавливается на запрос,
+поэтому, если nginx одновременно
+откроет два соединения, суммарная скорость будет вдвое выше
+заданного ограничения.
+Ограничение работает только в случае, если включена
+<link id="proxy_buffering">буферизация</link> ответов проксируемого сервера.
+</para>
+
+</directive>
+
+
 <directive name="proxy_max_temp_file_size">
 <syntax><value>размер</value></syntax>
 <default>1024m</default>
diff --git a/xml/ru/docs/http/ngx_http_scgi_module.xml b/xml/ru/docs/http/ngx_http_scgi_module.xml
--- a/xml/ru/docs/http/ngx_http_scgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_scgi_module"
         link="/ru/docs/http/ngx_http_scgi_module.html"
         lang="ru"
-        rev="7">
+        rev="8">
 
 <section id="summary">
 
@@ -668,6 +668,29 @@ nginx не передаёт клиенту поля заголовка <header>Status</header> и
 </directive>
 
 
+<directive name="scgi_limit_rate">
+<syntax><value>скорость</value></syntax>
+<default>0</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.7.7</appeared-in>
+
+<para>
+Ограничивает скорость чтения ответа от SCGI-сервера.
+<value>Скорость</value> задаётся в байтах в секунду.
+Значение 0 отключает ограничение скорости.
+Ограничение устанавливается на запрос,
+поэтому, если nginx одновременно
+откроет два соединения, суммарная скорость будет вдвое выше
+заданного ограничения.
+Ограничение работает только в случае, если включена
+<link id="scgi_buffering">буферизация</link> ответов SCGI-сервера.
+</para>
+
+</directive>
+
+
 <directive name="scgi_max_temp_file_size">
 <syntax><value>размер</value></syntax>
 <default>1024m</default>
diff --git a/xml/ru/docs/http/ngx_http_uwsgi_module.xml b/xml/ru/docs/http/ngx_http_uwsgi_module.xml
--- a/xml/ru/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_uwsgi_module"
         link="/ru/docs/http/ngx_http_uwsgi_module.html"
         lang="ru"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -668,6 +668,29 @@ nginx не передаёт клиенту поля заголовка <header>Status</header> и
 </directive>
 
 
+<directive name="uwsgi_limit_rate">
+<syntax><value>скорость</value></syntax>
+<default>0</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.7.7</appeared-in>
+
+<para>
+Ограничивает скорость чтения ответа от uwsgi-сервера.
+<value>Скорость</value> задаётся в байтах в секунду.
+Значение 0 отключает ограничение скорости.
+Ограничение устанавливается на запрос,
+поэтому, если nginx одновременно
+откроет два соединения, суммарная скорость будет вдвое выше
+заданного ограничения.
+Ограничение работает только в случае, если включена
+<link id="uwsgi_buffering">буферизация</link> ответов uwsgi-сервера.
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_max_temp_file_size">
 <syntax><value>размер</value></syntax>
 <default>1024m</default>