diff mod_rtbl/README.md @ 6301:77b5dd33a8f3

mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
author Matthew Wild <mwild1@gmail.com>
date Wed, 30 Jul 2025 14:13:44 +0100
parents
children e7926245c88d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_rtbl/README.md	Wed Jul 30 14:13:44 2025 +0100
@@ -0,0 +1,26 @@
+---
+summary: 
+rockspec:
+  dependencies:
+  - mod_pubsub_subscription
+labels:
+- Stage-Alpha
+...
+
+This module allows other modules to subscribe to real-time blocklists using
+pubsub (XEP-0060). As entries are added and removed from the blocklist, it
+notifies other modules so they can perform appropriate actions.
+
+# Configuring
+
+This module does not do anything on its own. It **should not** be
+added directly to your configuration file.
+
+Instead, you might want to look at modules which use mod\_rtbl, such as:
+
+- mod\_anti\_spam
+- mod\_muc\_rtbl
+
+# Compatibility
+
+Should work with Prosody >= 0.12.x