view mod_muc_hide_media/README.markdown @ 5734:cef8bce2d71b

luacheck: Add new module API methods from trunk See * trunk rev 4d4f9e42bcf8 * trunk rev 65fb0d7a2312 * trunk rev c9ef35fab0b1
author Kim Alvefur <zash@zash.se>
date Mon, 27 Nov 2023 07:10:06 +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
```