Commit 7ae53485 authored by Luca Toscano's avatar Luca Toscano
Browse files

Documentation rebuild 

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1774503 13f79535-47bb-0310-9956-ffa450edef68
parent 4d0194dd

docs/manual/mod/mod_ratelimit.html.en

+12 −2
Original line number Diff line number Diff line
@@ -32,7 +32,8 @@ 
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Bandwidth Rate Limiting for Clients</td></tr>

<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>

<tr><th><a href="module-dict.html#ModuleIdentifier">ModuleIdentifier:</a></th><td>ratelimit_module</td></tr>

<tr><th><a href="module-dict.html#SourceFile">SourceFile:</a></th><td>mod_ratelimit.c</td></tr></table>

<tr><th><a href="module-dict.html#SourceFile">SourceFile:</a></th><td>mod_ratelimit.c</td></tr>

<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td><code>rate-initial-burst</code> available in httpd 2.4.24 and later.</td></tr></table>

<h3>Summary</h3>
@@ -40,11 +41,20 @@ 
The connection speed to be simulated is specified, in KiB/s, using the environment

variable <code>rate-limit</code>.</p>



<p>Optionally, an initial amount of burst data, in KiB, may be

configured to be passed at full speed before throttling to the

specified rate limit.  This value is optional, and is set using

the environment variable <code>rate-initial-burst</code>.</p>



<div class="example"><h3>Example Configuration</h3><pre class="prettyprint lang-config">&lt;Location "/downloads"&gt;

    SetOutputFilter RATE_LIMIT

    SetEnv rate-limit 400 

    SetEnv rate-initial-burst 512

&lt;/Location&gt;</pre>

</div>

<div class="warning">

If the value specified for <code>rate-limit</code> causes integer overflow, the rate-limited will be disabled.

If the value specified for <code>rate-limit-burst</code> causes integer overflow, the burst will be disabled.

</div></div>



</div>

<div id="quickview"><h3 class="directives">Directives</h3>