Diff

mod_muc_moderation/README.markdown @ 3897:3a96070f4a14

mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
author Kim Alvefur <zash@zash.se>
date Sat, 22 Feb 2020 21:11:31 +0100
child 4752:67848bf6b425
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_moderation/README.markdown	Sat Feb 22 21:11:31 2020 +0100
@@ -0,0 +1,32 @@
+# 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}
+VirtualHost "channels.example.com" "muc"
+modules_enabled = {
+    "muc_mam",
+    "muc_moderation",
+}
+```
+
+# Compatibility
+
+-   Should work with Prosody 0.11.x and later.
+-   Tested with trunk rev `52c6dfa04dba`.
+-   Message tombstones requires a compatible storage module implementing
+    a new message replacement API.
+
+## Clients
+
+-   Tested with [Converse.js](https://conversejs.org/)
+    [v6.0.1](https://github.com/conversejs/converse.js/releases/tag/v6.0.1)