summaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2022-11-06 10:47:48 +0100
committerLibravatar GitHub <noreply@github.com>2022-11-06 09:47:48 +0000
commit4d66fb9603ada9b04f642576bbc541189876a3f3 (patch)
tree7f9b4f3a5ab95b20eb1ad4ceaf2e6779c1e02630 /example
parent[bugfix] Check `media-description-min-chars` on submission of new status (#960) (diff)
downloadgotosocial-4d66fb9603ada9b04f642576bbc541189876a3f3.tar.xz
[feature] Make rate limit requests amount configurable (#966)
* update rate limit documentation * regenerate landingpage config helpers * make rate limit rate configurable
Diffstat (limited to 'example')
-rw-r--r--example/config.yaml17
1 files changed, 17 insertions, 0 deletions
diff --git a/example/config.yaml b/example/config.yaml
index a741aef47..59c199899 100644
--- a/example/config.yaml
+++ b/example/config.yaml
@@ -557,3 +557,20 @@ syslog-address: "localhost:514"
# Options: ["lax", "strict"]
# Default: "lax"
advanced-cookies-samesite: "lax"
+
+# Int. Amount of requests to permit from a single IP address within a span of 5 minutes.
+# If this amount is exceeded, a 429 HTTP error code will be returned.
+# See https://docs.gotosocial.org/en/latest/api/swagger/#rate-limit.
+#
+# If you find yourself adjusting this limit because it's regularly being exceeded,
+# you should first verify that your settings for `trusted-proxies` (above) are correct.
+# In many cases, when the rate limit is exceeded it is because your instance sees all
+# incoming requests as coming from the *same IP address* (you can verify this by looking
+# at the client IPs in your instance logs). If this is the case, try adding that IP
+# address to your `trusted-proxies` *BEFORE* you go adjusting this rate limit setting!
+#
+# If you set this to 0 or less, rate limiting will be disabled entirely.
+#
+# Examples: [1000, 500, 0]
+# Default: 1000
+advanced-rate-limit-requests: 1000