annotate mod_rtbl/README.md @ 6398:9c9889ad4302

mod_unsubscriber: Add MUC support This catches XEP-0045 Join stanzas and replies with an error telling the prospective participant that the supposed MUC is gone. The user or their client can then take action to remove any bookmark or at least disable autojoin.
author Kim Alvefur <zash@zash.se>
date Sat, 07 Feb 2026 12:25:52 +0100
parents 77b5dd33a8f3
children e7926245c88d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6301
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 summary:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 rockspec:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 dependencies:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 - mod_pubsub_subscription
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6 labels:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 - Stage-Alpha
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ...
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 This module allows other modules to subscribe to real-time blocklists using
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 pubsub (XEP-0060). As entries are added and removed from the blocklist, it
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 notifies other modules so they can perform appropriate actions.
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 # Configuring
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 This module does not do anything on its own. It **should not** be
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 added directly to your configuration file.
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 Instead, you might want to look at modules which use mod\_rtbl, such as:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 - mod\_anti\_spam
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 - mod\_muc\_rtbl
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 # Compatibility
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 Should work with Prosody >= 0.12.x