From db9ef05d85464f31317bd548b95809245dffebda Mon Sep 17 00:00:00 2001 From: William Casarin Date: Mon, 18 Nov 2024 11:07:15 -0800 Subject: [PATCH] readme: document new rate-limit message option --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 7df00b7..44e5bfa 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ pipeline = ["protected_events", "kinds", "whitelist", "ratelimit", "forwarder"] [filters.ratelimit] posts_per_minute = 8 whitelist = ["127.0.0.1"] +message = "rate-limit: you note too much" [filters.whitelist] pubkeys = ["16c21558762108afc34e4ff19e4ed51d9a48f79e0c34531efc423d21ab435e93"] @@ -92,6 +93,8 @@ Settings: - `whitelist` *optional*: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit. +- `message` *optional*: the error message to return when connection is rate-limited. default is: `rate-limited: you are noting too much` + ### Whitelist * name: `whitelist`