1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>mod_ratelimit - Apache HTTP Server Version 2.5</title>
11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
19 <div id="page-header">
20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
21 <p class="apache">Apache HTTP Server Version 2.5</p>
22 <img alt="" src="../images/feather.png" /></div>
23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_ratelimit</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_ratelimit.html" title="English"> en </a> |
30 <a href="../fr/mod/mod_ratelimit.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Bandwidth Rate Limiting for Clients</td></tr>
33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ratelimit_module</td></tr>
35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_ratelimit.c</td></tr>
36 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>
37 <code>rate-initial-burst</code> available in httpd 2.4.24 and later.
38 Rate limiting proxied content does not work correctly up to httpd 2.4.33.
43 <p>Provides a filter named <code>RATE_LIMIT</code> to limit client bandwidth.
44 The throttling is applied to each HTTP response while it is transferred to the client,
45 and not aggregated at IP/client level.
46 The connection speed to be simulated is specified, in KiB/s, using the environment
47 variable <code>rate-limit</code>.</p>
49 <p>Optionally, an initial amount of burst data, in KiB, may be
50 configured to be passed at full speed before throttling to the
51 specified rate limit. This value is optional, and is set using
52 the environment variable <code>rate-initial-burst</code>.</p>
54 <div class="example"><h3>Example Configuration</h3><pre class="prettyprint lang-config"><Location "/downloads">
55 SetOutputFilter RATE_LIMIT
57 SetEnv rate-initial-burst 512
58 </Location></pre>
60 If the value specified for <code>rate-limit</code> causes integer overflow, the rate-limited will be disabled.
61 If the value specified for <code>rate-limit-burst</code> causes integer overflow, the burst will be disabled.
65 <div id="quickview"><h3 class="directives">Directives</h3>
66 <p>This module provides no
68 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_ratelimit">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_ratelimit">Report a bug</a></li></ul><h3>See also</h3>
70 <li><a href="#comments_section">Comments</a></li></ul></div>
73 <div class="bottomlang">
74 <p><span>Available Languages: </span><a href="../en/mod/mod_ratelimit.html" title="English"> en </a> |
75 <a href="../fr/mod/mod_ratelimit.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
76 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
77 <script type="text/javascript"><!--//--><![CDATA[//><!--
78 var comments_shortname = 'httpd';
79 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_ratelimit.html';
81 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
82 d.write('<div id="comments_thread"><\/div>');
83 var s = d.createElement('script');
84 s.type = 'text/javascript';
86 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
87 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
90 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
93 //--><!]]></script></div><div id="footer">
94 <p class="apache">Copyright 2019 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
95 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
96 if (typeof(prettyPrint) !== 'undefined') {