File

mod_muc_local_only/README.markdown @ 5681:7a4a6ded2bd6

mod_muc_adhoc_bots: Fix unbalanced quote in metadata section
author Kim Alvefur <zash@zash.se>
date Tue, 19 Sep 2023 15:03:01 +0200
parent 4019:221b6bee26e2
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.