prosody-modules
fe081789f7b5
mod_invites_register/README.md

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

Software / code / prosody-modules

Comparison

mod_invites_register/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 5482:mod_invites_register/README.markdown@2f7fff6c8c73
comparison
equal deleted inserted replaced
6002:5a65a632d5b9 6003:fe081789f7b5
1 ---
2 labels:
3 - 'Stage-Merged'
4 summary: 'Allow account registration using invite tokens'
5 ...
6
7 Introduction
8 ============
9
10 ::: {.alert .alert-info}
11 This module has been merged into Prosody as
12 [mod_invites_register][doc:modules:mod_invites_register]. Users of
13 Prosody **0.12** and later should not install this version.
14 :::
15
16 This module is part of the suite of modules that implement invite-based
17 account registration for Prosody. The other modules are:
18
19 - [mod_invites][doc:modules:mod_invites]
20 - [mod_invites_adhoc][doc:modules:mod_invites_adhoc]
21 - [mod_invites_page]
22 - [mod_invites_register_web]
23 - [mod_invites_api]
24 - [mod_register_apps]
25
26 For details and a full overview, start with the [mod_invites] documentation.
27
28 Details
29 =======
30
31 This module allows clients to register an account using an invite ('preauth')
32 token generated by mod_invites. It implements the protocol described at
33 [docs.modernxmpp.org/client/invites](https://docs.modernxmpp.org/client/invites)
34 and [XEP-0401 version 0.3.0](https://xmpp.org/extensions/attic/xep-0401-0.3.0.html).
35
36 **Note to developers:** the XEP-0401 protocol is expected to change in the future,
37 though Prosody will attempt to maintain backwards compatibility with the 0.3.0 protocol
38 for as long as necessary.
39
40 This module is also responsible for implementing the optional server-side part
41 of [XEP-0379: Pre-Authenticated Roster Subscriptions](https://xmpp.org/extensions/xep-0379.html).
42
43 **Note to admins:** Loading this module will disable registration for users
44 without an invite token by default. Control this behaviour
45
46 # Configuration
47
48 | Name | Description | Default |
49 |--------------------------|----------------------------------------------------------|---------|
50 | registration_invite_only | Require an invitation token for all account registration | `true` |
51
52 ## Example: Invite-only registration
53
54 This setup enables registration **only** for users that have a valid
55 invite token.
56
57 ``` {.lua}
58 allow_registration = true
59 registration_invite_only = true
60 ```
61
62 ## Example: Open registration
63
64 This setup allows completely **open registration**, even without
65 an invite token.
66
67 ``` {.lua}
68 allow_registration = true
69 registration_invite_only = false
70 ```