Merge pull request #994 from return42/add-limiter-redis-doc

[doc] add some documentation about the limiter plugin (and redis)
This commit is contained in:
Markus Heiser 2022-03-25 17:08:32 +01:00 committed by GitHub
commit ef8af285a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 36 additions and 11 deletions

View file

@ -3,6 +3,10 @@
# pyright: basic
"""Some bot protection / rate limitation
To monitore rate limits and protect privacy the IP addresses are getting stored
with a hash so the limiter plugin knows who to block. A redis database is
needed to store the hash values.
Enable the plugin in ``settings.yml``:
- ``server.limiter: true``