prosody-modules
9127fa98ee1e
mod_welcome_page/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_welcome_page/README.markdown @ 4184:9127fa98ee1e

mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups
author Matthew Wild <mwild1@gmail.com>
date Fri, 09 Oct 2020 12:19:46 +0100
child 4605:ffb709728210
comparison
equal deleted inserted replaced
4183:ad9ce6750880 4184:9127fa98ee1e
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: 'Serve a welcome page to users'
5 rockspec:
6 dependencies:
7 - mod_invites
8 build:
9 copy_directories:
10 - html
11 ...
12
13 Introduction
14 ============
15
16 This module serves a welcome page to users, and allows them to create an
17 account invite via the web on invite-only servers.
18
19 The page template and policy of when to allow account creation are both
20 possible to override.
21
22 This module is part of the suite of modules that implement invite-based
23 account registration for Prosody. The other modules are:
24
25 - mod_invites
26 - mod_invites_adhoc
27 - mod_invites_page
28 - mod_invites_register
29 - mod_invites_register_web
30 - mod_register_apps
31
32 For details and a full overview, start with the mod_invites documentation.
33
34 Configuration
35 =======
36
37 `welcome_page_template_path`
38 : The path to a directory containing the page templates and assets. See
39 the module source for the example template.
40
41 `welcome_page_variables`
42 : Optional variables to pass to the template, available as `{var.name}`
43
44 `welcome_page_open_registration`
45 : Whether to allow account creation in the absence of any other plugin
46 overriding the policy. Defaults to `false` unless `registration_invite_only`
47 is set to `false`.