mod_muc_moderation/README.markdown
author Matthew Wild <mwild1@gmail.com>
Sat, 24 Sep 2022 09:25:46 +0100
changeset 5062 39c2824c2880
parent 4904 cc5ac0f0f32d
child 5131 be859bfdd44e
permissions -rw-r--r--
mod_cloud_notify: README overhaul
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3901
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
# Introduction
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
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
     4
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
# Usage
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
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
     8
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
     9
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
# Configuration
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
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
    13
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
``` {.lua}
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
VirtualHost "channels.example.com" "muc"
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
modules_enabled = {
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
    "muc_mam",
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
    "muc_moderation",
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
}
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
```
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
# Compatibility
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
-   Should work with Prosody 0.11.x and later.
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
-   Tested with trunk rev `52c6dfa04dba`.
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
-   Message tombstones requires a compatible storage module implementing
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    27
    a new message replacement API.
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    28
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    29
## Clients
3a96070f4a14 mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    30
4904
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    31
-   [Converse.js](https://conversejs.org/)
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    32
-   [Gajim](https://dev.gajim.org/gajim/gajim/-/issues/10107)
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    33
-   [clix](https://code.zash.se/clix/rev/6c1953fbe0fa)
4756
67848bf6b425 mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents: 3901
diff changeset
    34
67848bf6b425 mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents: 3901
diff changeset
    35
### Feature requests
67848bf6b425 mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents: 3901
diff changeset
    36
4904
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    37
-   [Conv](https://github.com/iNPUTmice/Conversations/issues/3722)[ersa](https://github.com/iNPUTmice/Conversations/issues/3920)[tions](https://github.com/iNPUTmice/Conversations/issues/4227)
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    38
-   [Dino](https://github.com/dino/dino/issues/1133)
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    39
-   [Poezio](https://lab.louiz.org/poezio/poezio/-/issues/3543)
cc5ac0f0f32d mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents: 4757
diff changeset
    40
-   [Profanity](https://github.com/profanity-im/profanity/issues/1336)