prosody-modules
62a65c52c3f5
mod_muc_rtbl/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_muc_rtbl/README.md @ 4807:62a65c52c3f5

mod_muc_rtbl: Real-time blocklist checks for MUC services
author Matthew Wild <mwild1@gmail.com>
date Sun, 05 Dec 2021 18:22:47 +0000
comparison
equal deleted inserted replaced
4806:80f871bedcdf 4807:62a65c52c3f5
1 ---
2 summary:
3 rockspec:
4 dependencies:
5 - mod_pubsub_subscription
6 labels:
7 - Stage-Alpha
8 ...
9
10 This module subscribes to a real-time blocklist using pubsub (XEP-0060). As
11 entries are added and removed from the blocklist, it immediately updates a
12 local service-wide ban list.
13
14 # Configuring
15
16 Load this module on your existing MUC component like so:
17
18 ```lua
19 Component "channels.example.com" "muc"
20 modules_enabled = {
21 -- other modules etc
22 "muc_rtbl";
23 }
24 ```
25
26 Then there are two options, which must be set under the component or in the
27 global section of your config:
28
29 ```
30 muc_rtbl_jid = "rtbl.example"
31 muc_rtbl_node = "muc_bans_sha256"
32 ```
33
34 # Compatibility
35
36 Should work with Prosody >= 0.11.x
37
38 # Developers
39
40 ## Protocol
41
42 This version of mod_muc_rtbl assumes that the pubsub node contains one item
43 per blocked JID. The item id should be the SHA256 hash of the JID to block.
44 The payload is not currently used, but it is recommend to use a XEP-0377
45 report element as the payload.