Mercurial > prosody-modules

comparison mod_muc_local_only/README.markdown @ 4019:221b6bee26e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_local_only: New module to restrict a list of MUCs to local users
author Matthew Wild <mwild1@gmail.com>
date Wed, 13 May 2020 11:43:27 +0100
parents
children
comparison
equal deleted inserted replaced
4018:f27becd421bd 4019:221b6bee26e2
1 # Introduction
2
3 This module allows you to make one or more MUCs as accessible to local users only.
4
5 # Details
6
7 Local users (anyone on the same server as the MUC) are granted automatic
8 membership when they first join the room. Users from other servers are
9 denied access (even if the room is otherwise configured to be open).
10
11 # Configuring
12
13 ## Enabling
14
15 ``` {.lua}
16 Component "rooms.example.net" "muc"
17 modules_enabled = {
18 "muc_local_only";
19 }
20 ```
21
22 ## Settings
23
24 Specify a list of MUCs in your config like so:
25
26 ```
27 muc_local_only = { "my-local-chat@conference.example.com" }
28 ```
29
30 # Compatibility
31
32 Requires Prosody 0.11.0 or later.
33
34 # Future
35
36 It would be good to add a room configuration option.