From f66091d7eb4cc8ccbeea7656f564e56617f438d6 Mon Sep 17 00:00:00 2001
From: reivilibre <reivilibre@users.noreply.github.com>
Date: Wed, 5 Jun 2024 12:45:06 +0000
Subject: deploy: fcbc79bb87d08147e86dafa0fee5a9aec4d3fc23

---
 develop/usage/configuration/config_documentation.html | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'develop/usage/configuration/config_documentation.html')

diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index 7a7dc7f0a8..fea2a96526 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -1823,6 +1823,18 @@ See <a href="../../reverse_proxy.html">here</a> for more on using a reverse prox
 <pre><code class="language-yaml">max_image_pixels: 35M
 </code></pre>
 <hr />
+<h3 id="remote_media_download_burst_count"><a class="header" href="#remote_media_download_burst_count"><code>remote_media_download_burst_count</code></a></h3>
+<p>Remote media downloads are ratelimited using a <a href="https://en.wikipedia.org/wiki/Leaky_bucket">leaky bucket algorithm</a>, where a given &quot;bucket&quot; is keyed to the IP address of the requester when requesting remote media downloads. This configuration option sets the size of the bucket against which the size in bytes of downloads are penalized - if the bucket is full, ie a given number of bytes have already been downloaded, further downloads will be denied until the bucket drains.  Defaults to 500MiB. See also <code>remote_media_download_per_second</code> which determines the rate at which the &quot;bucket&quot; is emptied and thus has available space to authorize new requests.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">remote_media_download_burst_count: 200M
+</code></pre>
+<hr />
+<h3 id="remote_media_download_per_second"><a class="header" href="#remote_media_download_per_second"><code>remote_media_download_per_second</code></a></h3>
+<p>Works in conjunction with <code>remote_media_download_burst_count</code> to ratelimit remote media downloads - this configuration option determines the rate at which the &quot;bucket&quot; (see above) leaks in bytes per second. As requests are made to download remote media, the size of those requests in bytes is added to the bucket, and once the bucket has reached it's capacity, no more requests will be allowed until a number of bytes has &quot;drained&quot; from the bucket. This setting determines the rate at which bytes drain from the bucket, with the practical effect that the larger the number, the faster the bucket leaks, allowing for more bytes downloaded over a shorter period of time. Defaults to 87KiB per second. See also <code>remote_media_download_burst_count</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">remote_media_download_per_second: 40K
+</code></pre>
+<hr />
 <h3 id="prevent_media_downloads_from"><a class="header" href="#prevent_media_downloads_from"><code>prevent_media_downloads_from</code></a></h3>
 <p>A list of domains to never download media from. Media from these
 domains that is already downloaded will not be deleted, but will be
-- 
cgit 1.5.1