diff xml/en/docs/stream/ngx_stream_proxy_module.xml @ 2385:e58281e2a93f

Documented variables support in proxy_download_rate and proxy_upload_rate.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 21 May 2019 16:29:05 +0300
parents d5e576eb7677
children 375a3dfde23b
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_proxy_module.xml	Wed May 15 18:42:38 2019 +0300
+++ b/xml/en/docs/stream/ngx_stream_proxy_module.xml	Tue May 21 16:29:05 2019 +0300
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_proxy_module"
         link="/en/docs/stream/ngx_stream_proxy_module.html"
         lang="en"
-        rev="23">
+        rev="24">
 
 <section id="summary">
 
@@ -142,6 +142,20 @@
 the overall rate will be twice as much as the specified limit.
 </para>
 
+<para>
+The value can contain variables (1.17.0).
+It may be useful in cases where rate should be limited
+depending on a certain condition:
+<example>
+map $slow $rate {
+    1     4k;
+    2     8k;
+}
+
+proxy_download_rate $rate;
+</example>
+</para>
+
 </directive>
 
 
@@ -585,6 +599,20 @@
 the overall rate will be twice as much as the specified limit.
 </para>
 
+<para>
+The value can contain variables (1.17.0).
+It may be useful in cases where rate should be limited
+depending on a certain condition:
+<example>
+map $slow $rate {
+    1     4k;
+    2     8k;
+}
+
+proxy_upload_rate $rate;
+</example>
+</para>
+
 </directive>
 
 </section>