File

mod_muc_local_only/README.md @ 6145:f267133c206f

luacheckrc: Add module.ready() (new in trunk)
author Kim Alvefur <zash@zash.se>
date Fri, 10 Jan 2025 12:35:48 +0100 (2 months ago)
parent 6003:fe081789f7b5
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.