Software /
code /
prosody-modules
Comparison
mod_invites_adhoc/README.markdown @ 4092:2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Fri, 11 Sep 2020 13:50:47 +0100 |
child | 4104:476afcbfb3e9 |
comparison
equal
deleted
inserted
replaced
4091:354dc1e7977a | 4092:2b6918714792 |
---|---|
1 --- | |
2 labels: | |
3 - 'Stage-Beta' | |
4 summary: 'Enable ad-hoc command for XMPP clients to create invitations' | |
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_page | |
15 - mod_invites_register | |
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 mod_invites_adhoc allows XMPP clients to create new invites on the server. | |
25 Clients must support either XEP-0401 (Easy Onboarding) or XEP-0050 (Ad-hoc | |
26 commands). | |
27 | |
28 There are three types of invitation that can be created: | |
29 | |
30 | Account-only invites | These can be used to register a new account | | |
31 | Contact-only invites | These can be shared with a contact so they can easily add you to their contact list | | |
32 | Account-and-contact invites | Like a contact-only invite, but also allows the contact to register on the current server if they don't already have an XMPP account | | |
33 | |
34 Only configured admins of the server are able to create account-only invites. By default | |
35 normal users may only create contact-only invites, but account-and-contact invites can | |
36 be enabled with the `allow_user_invites` option. | |
37 | |
38 Configuration | |
39 ============= | |
40 | |
41 | Name | Description | Default | | |
42 |-----------------------|-----------------------------------------------------------------------|-------------------------------------------| | |
43 | allow_user_invites | Whether non-admin users can invite contacts to register on this server| `false` | | |
44 | allow_contact_invites | Whether non-admin users can invite contacts to their roster | `true` | | |
45 | |
46 The `allow_user_invites` option should be set as desired. However it is | |
47 strongly recommended to leave the other option (`allow_contact_invites`) | |
48 at its default to provide the best user experience. |