Mercurial > prosody-modules

annotate mod_muc_restrict_attention/README.md @ 6517:3d14a407307d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
author Menel <menel@snikket.de>
date Thu, 16 Apr 2026 12:02:18 +0200
parents 63ce1af4d099
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
1 ---
6517
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
2 summary: Strip XEP-0224 Attention from affiliations in rooms
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
3 labels:
6428
23e3edb6f9ea mod_muc_restrict_attention: Change logic:, always disallow unaffiliated, always allow admin and owner and make it configurable for members. Also it actually works O_o.
Menel <menel@snikket.de>
parents: 6423
diff changeset
4 - Stage-Beta
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
5 ...
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
6
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
7 # Introduction
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
8
6517
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
9 This module can strip [XEP-0224 Attention] for certain affiliations in rooms.
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
10 By default it will only allow *Attention* from admins or above.
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
11 This can prevent unwanted noise, made with big public channels in mind.
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
12
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
13 # Configuring
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
14
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
15 ## Enabling
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
16
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
17 ``` {.lua}
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
18 Component "rooms.example.net" "muc"
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
19 modules_enabled = {
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
20 "muc_restrict_attention";
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
21 }
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
22 ```
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
23
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
24 ## Settings
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
25
6517
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
26 A default setting for all rooms can be provided in the config file, ("members", "participants", false), defaults to *"members"*.
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
27 A loglevel can be set ("debug", "info", "warn", "error").
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
28 Defaults to *"debug"*:
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
29
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
30 ``` {.lua}
6517
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
31 muc_restrict_attention_by_default = "members"
6434
1932fd38d353 mod_muc_restrict_attention: logging configurable and to debug by default.
Menel <menel@snikket.de>
parents: 6429
diff changeset
32 muc_restrict_attention_loglevel = "debug"
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
33 ```
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
34
6517
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
35 The module adds a room configuration option to choose the behavior for members, overriding the defaults per room.
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
36
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
37 # Todo
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
38
6517
3d14a407307d mod_muc_restrict_attention: Add default option for participants. Breaking change config option name.
Menel <menel@snikket.de>
parents: 6446
diff changeset
39 - Restrict fine tuned, per every affiliation in the room config with nice dropdown config option.
6423
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
40
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
41 # Compatibility
d748985de48f mod_muc_restrict_attention: New Module based on mod_muc_restrict_media to strip Attention. Untested.
Menel <menel@snikket.de>
parents:
diff changeset
42
6428
23e3edb6f9ea mod_muc_restrict_attention: Change logic:, always disallow unaffiliated, always allow admin and owner and make it configurable for members. Also it actually works O_o.
Menel <menel@snikket.de>
parents: 6423
diff changeset
43 Work with Prosody >= 13.0