diff mod_muc_hide_media/README.markdown @ 3681:d267e381255f

mod_muc_hide_media: Module to allow hiding inline media in a MUC
author Matthew Wild <mwild1@gmail.com>
date Sun, 29 Sep 2019 11:48:27 +0100
parents
children df2246b15075
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_hide_media/README.markdown	Sun Sep 29 11:48:27 2019 +0100
@@ -0,0 +1,26 @@
+# Introduction
+
+This module adds a room configuration option to hide inline media from MUCs and
+display them as links instead.
+
+This can be useful in public channels where content posted by users should not
+be shown by default.
+
+# Configuring
+
+## Enabling
+
+``` {.lua}
+Component "rooms.example.net" "muc"
+modules_enabled = {
+    "muc_hide_media";
+}
+```
+
+## Settings
+
+A default setting can be provided in the config file:
+
+``` {.lua}
+muc_room_default_hide_media = true
+```