alyssa
/
pleroma
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve rate limiter documentation 

Documents how to disable rate limiting
This commit is contained in:
Egor Kislitsyn 2019-06-14 15:02:10 +07:00
parent 00cc4880ce
commit b22b10d3aa
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/pleroma/plugs/rate_limiter.ex
View File

@ -14,13 +14,20 @@ defmodule Pleroma.Plugs.RateLimiter do
It is also possible to have different limits for unauthenticated and authenticated users: the keyword value must be a list of two tuples where the first one is a config for unauthenticated users and the second one is for authenticated. It is also possible to have different limits for unauthenticated and authenticated users: the keyword value must be a list of two tuples where the first one is a config for unauthenticated users and the second one is for authenticated.
To disable a limiter set its value to `nil`.
### Example ### Example
config :pleroma, :rate_limit, config :pleroma, :rate_limit,
one: {1000, 10}, one: {1000, 10},
two: [{10_000, 10}, {10_000, 50}] two: [{10_000, 10}, {10_000, 50}],
foobar: nil
Here we have two limiters: `one` which is not over 10req/1s and `two` which has two limits 10req/10s for unauthenticated users and 50req/10s for authenticated users. Here we have three limiters:
* `one` which is not over 10req/1s
* `two` which has two limits: 10req/10s for unauthenticated users and 50req/10s for authenticated users
* `foobar` which is disabled
## Usage ## Usage