Mercurial > prosody-modules
comparison mod_invites_register/README.markdown @ 4106:d34572047488
mod_invites_register: New module to allow IBR with invite tokens
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Fri, 11 Sep 2020 16:30:51 +0100 |
parents | |
children | 4ec755c13e9b |
comparison
equal
deleted
inserted
replaced
4105:233e170eb027 | 4106:d34572047488 |
---|---|
1 --- | |
2 labels: | |
3 - 'Stage-Beta' | |
4 summary: 'Allow account registration 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_web | |
17 - mod_register_apps | |
18 | |
19 For details and a full overview, start with the mod_invites documentation. | |
20 | |
21 Details | |
22 ======= | |
23 | |
24 This module allows clients to register an account using an invite ('preauth') | |
25 token generated by mod_invites. It implements the protocol described at | |
26 [docs.modernxmpp.org/client/invites](https://docs.modernxmpp.org/client/invites) | |
27 and [XEP-0401 version 0.3.0](https://xmpp.org/extensions/attic/xep-0401-0.3.0.html). | |
28 | |
29 **Note to developers:** the XEP-0401 protocol is expected to change in the future, | |
30 though Prosody will attempt to maintain backwards compatibility with the 0.3.0 protocol | |
31 for as long as necessary. | |
32 | |
33 This module is also responsible for implementing the optional server-side part | |
34 of [XEP-0379: Pre-Authenticated Roster Subscriptions](https://xmpp.org/extensions/xep-0379.html). | |
35 | |
36 **Note to admins:** Loading this module will disable registration for users | |
37 without an invite token by default. Control this behaviour | |
38 | |
39 # Configuration | |
40 | |
41 | Name | Description | Default | | |
42 |--------------------------|----------------------------------------------------------|---------| | |
43 | registration_invite_only | Require an invitation token for all account registration | `true` | | |
44 | |
45 ## Example: Invite-only registration | |
46 | |
47 This setup enables registration **only** for users that have a valid | |
48 invite token. | |
49 | |
50 ``` {.lua} | |
51 allow_registration = true | |
52 registration_invite_only = true | |
53 ``` | |
54 | |
55 ## Example: Open registration | |
56 | |
57 This setup allows completely **open registration**, even without | |
58 an invite token. | |
59 | |
60 ``` {.lua} | |
61 allow_registration = true | |
62 registration_invite_only = false | |
63 ``` |