diff mod_limits_exception/README.md @ 5975:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_limits_exception/README.markdown@28c16c93d79a
children 12a2989c7cc1
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_limits_exception/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -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.