view mod_muc_hide_media/README.markdown @ 5755:4a353ccce220

luacheckrc: Replace deprecated module:once with :on_ready So that :once is warned about properly. module:once was only added in trunk so it shouldn't have gotten very far yet.
author Kim Alvefur <zash@zash.se>
date Sat, 02 Dec 2023 11:10:43 +0100
parents df2246b15075
children
line wrap: on
line source

# 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.

**Note:** You could consider the more useful [mod_muc_restrict_media] instead,
which allows affiliated users (e.g. members, admins, owners) to still send
inline media.

# 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
```