view mod_muc_local_only/README.markdown @ 5012:b97a2ffef87f

mod_auth_imap: Fix packaging Since this module consists of multiple files and the additional directory level, we need to tell luarocks which files correspond to what Lua modules names.
author Kim Alvefur <zash@zash.se>
date Wed, 24 Aug 2022 16:02:00 +0200
parents 221b6bee26e2
children
line wrap: on
line source

# Introduction

This module allows you to make one or more MUCs as accessible to local users only.

# Details

Local users (anyone on the same server as the MUC) are granted automatic
membership when they first join the room. Users from other servers are
denied access (even if the room is otherwise configured to be open).

# Configuring

## Enabling

``` {.lua}
Component "rooms.example.net" "muc"
modules_enabled = {
    "muc_local_only";
}
```

## Settings

Specify a list of MUCs in your config like so:

```
muc_local_only = { "my-local-chat@conference.example.com" }
```

# Compatibility

Requires Prosody 0.11.0 or later.

# Future

It would be good to add a room configuration option.