diff mod_muc_rtbl/README.md @ 6304:6e2458b69e33

mod_muc_rtbl: Use mod_rtbl, adds support for multiple list subscriptions
author Matthew Wild <mwild1@gmail.com>
date Wed, 30 Jul 2025 14:16:55 +0100
parents 62a65c52c3f5
children 093c47ee2041
line wrap: on
line diff
--- a/mod_muc_rtbl/README.md	Thu Jul 31 15:07:30 2025 +0100
+++ b/mod_muc_rtbl/README.md	Wed Jul 30 14:16:55 2025 +0100
@@ -2,7 +2,7 @@
 summary: 
 rockspec:
   dependencies:
-  - mod_pubsub_subscription
+  - mod_rtbl
 labels:
 - Stage-Alpha
 ...
@@ -23,17 +23,24 @@
 }
 ```
 
-Then there are two options, which must be set under the component or in the
-global section of your config:
+Then you should configure one or more lists you want to subscribe to:
 
+```lua
+muc_rtbls = {
+	"xmpp:rtbl.example?;node=muc_bans_sha256";
+}
 ```
-muc_rtbl_jid = "rtbl.example"
-muc_rtbl_node = "muc_bans_sha256"
-```
+
+If an unaffiliated JID matches an entry found in any of the configured lists,
+this module will block:
+
+- Joins
+- Group chat messages
+- Private messages
 
 # Compatibility
 
-Should work with Prosody >= 0.11.x
+Should work with Prosody >= 0.12.x
 
 # Developers