summaryrefslogtreecommitdiff
path: root/docs/configuration/advanced.md
diff options
context:
space:
mode:
authorLibravatar firescry <49809580+firescry@users.noreply.github.com>2023-07-12 10:28:41 +0200
committerLibravatar GitHub <noreply@github.com>2023-07-12 10:28:41 +0200
commit8d92b2479f810bc5d20245361fa59339763a1495 (patch)
tree05b95d76a0fb7cc683a2f8a81ea40fec8fb8873a /docs/configuration/advanced.md
parentBump semver from 6.3.0 to 6.3.1 in /web/source (#1981) (diff)
downloadgotosocial-8d92b2479f810bc5d20245361fa59339763a1495.tar.xz
[bugfix] Align default values in the configuration file with the code (#1971)
* Set default value of SMTPFrom to empty string This parameter should contain proper e-mail address (to be provided by user during configuration). * Update default values in example/config.yaml Default values and related comments in example/config.yaml are aligned with values defined in internal/config/defaults.go. Small improvements to foramting of config.yaml file. * Add default value for AdvancedThrottlingRetryAfter to internal/config/defaults.go AdvancedThrottlingRetryAfter was introduced in 70739d3 (superseriousbusiness/gotosocial#1466). * Update config.yaml snippets in documentation
Diffstat (limited to 'docs/configuration/advanced.md')
-rw-r--r--docs/configuration/advanced.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/configuration/advanced.md b/docs/configuration/advanced.md
index 6bf57f869..07e3376d5 100644
--- a/docs/configuration/advanced.md
+++ b/docs/configuration/advanced.md
@@ -53,7 +53,7 @@ advanced-cookies-samesite: "lax"
advanced-rate-limit-requests: 300
# Int. Amount of open requests to permit per CPU, per router grouping, before applying http
-# request throttling. Any requests beyond the calculated limit are held in a backlog queue for
+# request throttling. Any requests beyond the calculated limit are held in a backlog queue for
# up to 30 seconds before either being processed or timing out. Requests that don't fit in the backlog
# queue will have status 503 returned to them, and the header 'Retry-After' will be set to 30 seconds.
#
@@ -71,7 +71,7 @@ advanced-rate-limit-requests: 300
# 2 cpu = 08 open, 032 backlog
# 4 cpu = 16 open, 064 backlog
#
-# A multiplier of 8 is a sensible default, but you may wish to increase this for instances
+# A multiplier of 8 is a sensible default, but you may wish to increase this for instances
# running on very performant hardware, or decrease it for instances using v. slow CPUs.
#
# If you set this to 0 or less, http request throttling will be disabled entirely.
@@ -80,6 +80,13 @@ advanced-rate-limit-requests: 300
# Default: 8
advanced-throttling-multiplier: 8
+# Duration. Time period to use as the "retry-after" header value in response to throttled requests.
+# Minimum resolution is 1 second.
+#
+# Examples: [30s, 10s, 5s, 1m]
+# Default: "30s"
+advanced-throttling-retry-after: "30s"
+
# Int. CPU multiplier for the amount of goroutines to spawn in order to send messages via ActivityPub.
# Messages will be batched so that at most multiplier * CPU count messages will be sent out at once.
# This can be tuned to limit concurrent POSTing to remote inboxes, preventing your instance CPU