Software / code / prosody-modules
Annotate
mod_muc_moderation/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 5873:84a784bc4096 |
| rev | line source |
|---|---|
|
5484
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
1 --- |
|
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
2 summary: Let moderators remove spam and abuse messages |
|
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
3 --- |
|
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
4 |
|
3897
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 # Introduction |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 This module implements [XEP-0425: Message Moderation]. |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 # Usage |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 Moderation is done via a supporting client and requires a `moderator` |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 role in the channel / group chat. |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 # Configuration |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 Example [MUC component][doc:chatrooms] configuration: |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 ``` {.lua} |
|
5872
593312fedfe1
mod_muc_moderation: Fix example
Kim Alvefur <zash@zash.se>
parents:
5670
diff
changeset
|
19 Component "channels.example.com" "muc" |
|
3897
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 modules_enabled = { |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 "muc_mam", |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 "muc_moderation", |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 } |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 ``` |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 # Compatibility |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 |
|
5127
be859bfdd44e
mod_muc_moderation/README: Simplify Compatibility section
Kim Alvefur <zash@zash.se>
parents:
4900
diff
changeset
|
28 - Basic functionality with Prosody 0.11.x and later |
|
be859bfdd44e
mod_muc_moderation/README: Simplify Compatibility section
Kim Alvefur <zash@zash.se>
parents:
4900
diff
changeset
|
29 - Full functionality with Prosody 0.12.x and `internal` or `sql` |
|
be859bfdd44e
mod_muc_moderation/README: Simplify Compatibility section
Kim Alvefur <zash@zash.se>
parents:
4900
diff
changeset
|
30 storage^[Replacing moderated messages with tombstones requires new storage API methods.] |
|
5670
d4b97eaeb235
mod_muc_moderation: Mention that it works with mod_storage_xmlarchive (thanks Menel)
Kim Alvefur <zash@zash.se>
parents:
5484
diff
changeset
|
31 - Works with [mod_storage_xmlarchive] |
|
3897
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
32 |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
33 ## Clients |
|
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 |
|
4900
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
35 - [Converse.js](https://conversejs.org/) |
|
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
36 - [Gajim](https://dev.gajim.org/gajim/gajim/-/issues/10107) |
|
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
37 - [clix](https://code.zash.se/clix/rev/6c1953fbe0fa) |
|
4752
67848bf6b425
mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents:
3897
diff
changeset
|
38 |
|
67848bf6b425
mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents:
3897
diff
changeset
|
39 ### Feature requests |
|
67848bf6b425
mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents:
3897
diff
changeset
|
40 |
|
5484
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
41 - [Conversations](https://codeberg.org/iNPUTmice/Conversations/issues/20) |
|
4900
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
42 - [Dino](https://github.com/dino/dino/issues/1133) |
|
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
43 - [Profanity](https://github.com/profanity-im/profanity/issues/1336) |
