Mercurial > prosody-modules
annotate mod_muc_auto_member/README.markdown @ 5245:e22cae58141d
mod_http_oauth2: Organize HTTP routes with comments
Starting to get hard to follow. Usually one would start tracing the
steps at the HTTP authorize route. Vaguely sorted alphabetically by
path and point in the flow. (/register comes before /authorize tho)
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 12 Mar 2023 11:27:29 +0100 |
parents | 243c156074d3 |
children |
rev | line source |
---|---|
5162
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 labels: |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 - 'Stage-Beta' |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 summary: "Automatically register new MUC participants as members" |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 ... |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 # Introduction |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 This module automatically makes anybody who joins a MUC become a registered |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 member. This can be useful for certain use cases. |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 Note: there is no automatic cleanup of members. If you enable this on a server |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 with busy public channels, your member list will perpetually increase in size. |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 Also, there is currently no per-room option for this behaviour. That may be |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 added in the future, along with membership expiry. |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 # Configuration |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 There is currently no configuration for this module. The module should be |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 enabled on your MUC component, i.e. in the modules_enabled option under your |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 Component: |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 ``` {.lua} |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 Component "conference.example.com" "muc" |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 modules_enabled = { |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 "muc_auto_member"; |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 } |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 ``` |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 # Compatibility |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 |
243c156074d3
mod_muc_auto_member: New module to automatically make MUC participants members
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 0.12 and later. |