commit 4b5f67d473c8986e0d1c6a97e8e2da53da91ad27 parent 784d32e327e6e6c49a47755035a543e37609f17f Author: William Casarin <jb55@jb55.com> Date: Tue, 9 Jul 2024 09:55:41 -0700 readme: add optional indicator to filter docs Signed-off-by: William Casarin <jb55@jb55.com> Diffstat:
| M | README.md | | | 6 | +++--- |
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md @@ -39,15 +39,15 @@ Settings: - `notes_per_minute`: the number of notes per minute which are allowed to be written per ip. -- `whitelist`: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit. +- `whitelist` *optional*: a list of IP4 or IP6 addresses that are allowed to bypass the ratelimit. ### Whitelist The whitelist filter only allows notes to pass if it matches a particular pubkey or source ip: -- `pubkeys`: a list of hex public keys to let through +- `pubkeys` *optional*: a list of hex public keys to let through -- `ips`: a list of ip addresses to let through +- `ips` *optional*: a list of ip addresses to let through Either criteria can match