From 61c1058d67ae5621687a95fbc1f6dcc71fbc42a7 Mon Sep 17 00:00:00 2001
From: Michael Manfre
Date: Sun, 4 Dec 2022 11:32:25 -0500
Subject: Add TAKAHE_DEFAULT_TIMEOUT with default of 5.0 (#99)

---
 docs/index.rst  |  1 +
 docs/tuning.rst | 16 ++++++++++++++++
 2 files changed, 17 insertions(+)
 create mode 100644 docs/tuning.rst

(limited to 'docs')

diff --git a/docs/index.rst b/docs/index.rst
index f8fbc13..2c1ff48 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,4 +19,5 @@ in alpha. For more information about Takahē, see
    contributing
    domains
    stator
+   tuning
    releases/index
diff --git a/docs/tuning.rst b/docs/tuning.rst
new file mode 100644
index 0000000..2b5e5d8
--- /dev/null
+++ b/docs/tuning.rst
@@ -0,0 +1,16 @@
+Tuning
+======
+
+This page contains a collection of tips and settings that can be used to
+tune your server based upon its users and the other servers it federates
+with.
+
+Federating
+----------
+
+Environment Variable:
+
+* ``TAKAHE_REMOTE_TIMEOUT`` is the number of seconds Takahē will allow when
+  making remote requests to other Fediverse instances. This may also be a
+  tuple of four floats to set the timeouts for connect, read, write, and
+  pool. Example ``TAKAHE_REMOTE_TIMEOUT='[0.5, 1.0, 1.0, 0.5]'``
-- 
cgit v1.2.3