From 92edd8c85d73f2d620cbdc16ec0493733eaeeb8f Mon Sep 17 00:00:00 2001
From: MatMaul <MatMaul@users.noreply.github.com>
Date: Fri, 9 Jun 2023 07:01:58 +0000
Subject: deploy: d84e66144dc12dacf71c987a2ba802dd59c0b68e

---
 .../usage/configuration/config_documentation.html  | 23 ++++++++++++++++++++++
 1 file changed, 23 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 a92798d0b1..c20e1662f5 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -1161,6 +1161,29 @@ on this homeserver.</p>
 <pre><code class="language-yaml">allow_device_name_lookup_over_federation: true
 </code></pre>
 <hr />
+<h3 id="federation-1"><a class="header" href="#federation-1"><code>federation</code></a></h3>
+<p>The federation section defines some sub-options related to federation.</p>
+<p>The following options are related to configuring timeout and retry logic for one request,
+independently of the others.
+Short retry algorithm is used when something or someone will wait for the request to have an
+answer, while long retry is used for requests that happen in the background,
+like sending a federation transaction.</p>
+<ul>
+<li><code>client_timeout</code>: timeout for the federation requests in seconds. Default to 60s.</li>
+<li><code>max_short_retry_delay</code>: maximum delay to be used for the short retry algo in seconds. Default to 2s.</li>
+<li><code>max_long_retry_delay</code>: maximum delay to be used for the short retry algo in seconds. Default to 60s.</li>
+<li><code>max_short_retries</code>: maximum number of retries for the short retry algo. Default to 3 attempts.</li>
+<li><code>max_long_retries</code>: maximum number of retries for the long retry algo. Default to 10 attempts.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation:
+  client_timeout: 180
+  max_short_retry_delay: 7
+  max_long_retry_delay: 100
+  max_short_retries: 5
+  max_long_retries: 20
+</code></pre>
+<hr />
 <h2 id="caching"><a class="header" href="#caching">Caching</a></h2>
 <p>Options related to caching.</p>
 <hr />
-- 
cgit 1.5.1