summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMichael Manfre2022-12-04 11:32:25 -0500
committerGitHub2022-12-04 09:32:25 -0700
commit61c1058d67ae5621687a95fbc1f6dcc71fbc42a7 (patch)
treee7a8f23198fcca7edaa21c34197d580f2bcc7e67 /docs
parent0efa4456051e97040c750d5927304ad4db49bf24 (diff)
downloadtakahe-61c1058d67ae5621687a95fbc1f6dcc71fbc42a7.tar.gz
takahe-61c1058d67ae5621687a95fbc1f6dcc71fbc42a7.tar.bz2
takahe-61c1058d67ae5621687a95fbc1f6dcc71fbc42a7.zip
Add TAKAHE_DEFAULT_TIMEOUT with default of 5.0 (#99)
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst1
-rw-r--r--docs/tuning.rst16
2 files changed, 17 insertions, 0 deletions
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]'``