Diff

mod_muc_moderation/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 5873:84a784bc4096
child 6013:31ea29adb894
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_moderation/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,43 @@
+---
+summary: Let moderators remove spam and abuse messages
+---
+
+# Introduction
+
+This module implements [XEP-0425: Message Moderation].
+
+# Usage
+
+Moderation is done via a supporting client and requires a `moderator`
+role in the channel / group chat.
+
+# Configuration
+
+Example [MUC component][doc:chatrooms] configuration:
+
+``` {.lua}
+Component "channels.example.com" "muc"
+modules_enabled = {
+    "muc_mam",
+    "muc_moderation",
+}
+```
+
+# Compatibility
+
+-   Basic functionality with Prosody 0.11.x and later
+-   Full functionality with Prosody 0.12.x and `internal` or `sql`
+    storage^[Replacing moderated messages with tombstones requires new storage API methods.]
+-   Works with [mod_storage_xmlarchive]
+
+## Clients
+
+-   [Converse.js](https://conversejs.org/)
+-   [Gajim](https://dev.gajim.org/gajim/gajim/-/issues/10107)
+-   [clix](https://code.zash.se/clix/rev/6c1953fbe0fa)
+
+### Feature requests
+
+-   [Conversations](https://codeberg.org/iNPUTmice/Conversations/issues/20)
+-   [Dino](https://github.com/dino/dino/issues/1133)
+-   [Profanity](https://github.com/profanity-im/profanity/issues/1336)