comparison mod_invites_register_web/README.markdown @ 4093:a2116f5a7c8f

mod_invites_register_web: New module to allow web registration with an invite token
author Matthew Wild <mwild1@gmail.com>
date Fri, 11 Sep 2020 13:51:54 +0100
parents
children 476afcbfb3e9
comparison
equal deleted inserted replaced
4092:2b6918714792 4093:a2116f5a7c8f
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: 'Register accounts via the web using invite tokens'
5 ...
6
7 Introduction
8 ============
9
10 This module is part of the suite of modules that implement invite-based
11 account registration for Prosody. The other modules are:
12
13 - mod_invites
14 - mod_invites_adhoc
15 - mod_invites_page
16 - mod_invites_register
17 - mod_invites_register_web
18 - mod_register_apps
19
20 For details and a full overview, start with the mod_invites documentation.
21
22 Details
23 =======
24
25 mod_invites_register_web implements a web-based registration form that
26 validates invite tokens. It also supports guiding the user through client
27 download and configuration via mod_register_apps.
28
29 There is no specific configuration for this module (though it uses the
30 optional `site_name` to override the displayed site name.
31
32 This module depends on mod_invites_page solely for the case where an invalid
33 invite token is received - it will redirect to mod_invites_page so that an
34 appropriate error can be served to the user.