view mod_muc_local_only/README.markdown @ 4678:0bcbff950f14

mod_smacks: Update README `smacks_enabled_s2s` defaults now to `true`. See https://hg.prosody.im/prosody-modules/file/242251ce1036/mod_smacks/mod_smacks.lua#l39
author Martin Dosch <martin@mdosch.de>
date Sun, 12 Sep 2021 13:34:46 +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.