Mercurial > prosody-modules
diff mod_limits_exception/README.markdown @ 4562:28c16c93d79a
mod_limits_exception: New module to except some JIDs from rate limiting
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Mon, 24 May 2021 15:46:11 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_limits_exception/README.markdown Mon May 24 15:46:11 2021 +0100 @@ -0,0 +1,26 @@ +--- +summary: Allow specified JIDs to bypass rate limits +... + +This module allows you to configure a list of JIDs that should be allowed to +bypass rate limit restrictions. + +It is designed for Prosody 0.11.x. Prosody 0.12.x supports this feature +natively. + +## Configuration + +First, enable this module by adding `"limits_exception"` to your +`modules_enabled` list. + +Next, configure a list of JIDs to exclude from rate limiting: + +``` +unlimited_jids = { "user1@example.com", "user2@example.net" } +``` + +## Compatibility + +Made for Prosody 0.11.x only. + +Using this module with Prosody trunk/0.12 may cause unexpected behaviour.