diff options
| author |  tobi <31960611+tsmethurst@users.noreply.github.com> | 2023-08-23 14:32:27 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2023-08-23 14:32:27 +0200 |
| commit | 8f38dc2e7f9dc7272c6882fff369be5e43dc711a (patch) | |
| tree | 4b414789c96c05573f89ae3f23b4bd1c5870005e /docs/api | |
| parent | [performance] Rework home timeline query to use cache more (#2148) (diff) | |
| download | gotosocial-8f38dc2e7f9dc7272c6882fff369be5e43dc711a.tar.xz | |
[feature] Add rate limit exceptions option, use ISO8601 for rate limit reset (#2151)
* start updating rate limiting, add exceptions
* tests, comments, tidying up
* add rate limiting exceptions to example config
* envparsing
* nolint
* apply kimbediff
* add examples
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/ratelimiting.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/api/ratelimiting.md b/docs/api/ratelimiting.md index 2bdcdf2ba..d99f4d379 100644 --- a/docs/api/ratelimiting.md +++ b/docs/api/ratelimiting.md @@ -16,7 +16,7 @@ Every response will include the current status of the rate limit with the follow - `X-Ratelimit-Limit`: maximum number of requests allowed per time period. - `X-Ratelimit-Remaining`: number of remaining requests that can still be performed within. -- `X-Ratelimit-Reset`: unix timestamp indicating when the rate limit will reset. +- `X-Ratelimit-Reset`: ISO8601 timestamp indicating when the rate limit will reset. In case the rate limit is exceeded, an [HTTP 429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) error is returned to the caller. @@ -35,3 +35,7 @@ If you don't have an HTTP proxy, then it's likely caused by NAT. In this case yo ### Can I configure the rate limit? Can I just turn it off? Yes! Set `advanced-rate-limit-requests: 0` in the config. + +### Can I exclude one or more IP addresses from rate limiting, but leave the rest in place? + +Yes! Set `advanced-rate-limit-exceptions` in the config. |