From: Egor Kislitsyn <egor@kislitsyn.com>
Date: Fri, 14 Jun 2019 08:02:10 +0000 (+0700)
Subject: Improve rate limiter documentation
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=b22b10d3aac391dabd17349158ce642c7e1cae93;p=akkoma

Improve rate limiter documentation

Documents how to disable rate limiting
---

diff --git a/lib/pleroma/plugs/rate_limiter.ex b/lib/pleroma/plugs/rate_limiter.ex
index e02ba4213..9ba5875fa 100644
--- a/lib/pleroma/plugs/rate_limiter.ex
+++ b/lib/pleroma/plugs/rate_limiter.ex
@@ -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.
 
+  To disable a limiter set its value to `nil`.
+
   ### Example
 
       config :pleroma, :rate_limit,
         one: {1000, 10},
-        two: [{10_000, 10}, {10_000, 50}]
+        two: [{10_000, 10}, {10_000, 50}],
+        foobar: nil
+
+  Here we have three limiters:
 
-  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.
+  * `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