Mercurial > prosody-modules

comparison mod_easy_invite/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
parents mod_easy_invite/README.markdown@d3d2e9e7e8b7
children
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - 'Stage-Deprecated'
4 summary: 'Invite management module for Prosody (deprecated)'
5 rockspec:
6 dependencies:
7 - mod_invites
8 ---
9
10 ::: {.alert .alert-warning}
11 **NOTE:** This module has been deprecated. Its functionality has been
12 moved to other modules, see the mod_invites documentation for details.
13 :::
14
15
16 This module allows admins and users to create invitations suitable for sharing
17 to potential new users/contacts.
18
19 User invitations can be created through the "New Invite" ad-hoc command. An overview
20 of the semantics and protocol can be found at [modernxmpp.org/client/invites](https://docs.modernxmpp.org/client/invites/).
21
22 This module depends on mod_invites to actually create and store the invitation tokens.
23
24 # Configuration
25
26 To allow users to join your server through invitations, you must
27 enable mod_register_ibr and set allow_registration = true, and then
28 also set `registration_invite_only = true` to restrict registration.
29
30 | Name | Description | Default |
31 |--------------------------|-----------------------------------------------------------------------------------|---------|
32 | registration_invite_only | Whether registration attempts without an invite token should be blocked | true |
33 | allow_user_invites | Whether existing users should be allowed to invite new users to register accounts | true |
34
35 ## Example: Invite-only registration
36 ``` {.lua}
37 -- To allow invitation through a token, mod_register
38 allow_registration = true
39 registration_invite_only = true
40 ```
41
42 ## Example: Open registration
43
44 This setup allows completely open registration, even without
45 an invite token.
46
47 ``` {.lua}
48 allow_registration = true
49 registration_invite_only = false
50 ```
51
52 ## Invite creation permissions
53
54 To allow existing users of your server to send invitation links that
55 allow new people to join your server, you can set `allow_user_invites = true`.
56
57 If you do not wish users to invite other users to create accounts on your
58 server, set `allow_user_invites = false`. They will still be able to send
59 contact invites, but new contacts will be required to register an account
60 on a different server.
61
62 # Usage
63
64 Users can use the "New Invite" ad-hoc command through their client.
65
66 Admins can create registration links using prosodyctl, e.g.
67
68 ```
69 prosodyctl mod_easy_invite example.com generate
70 ```
71
72 # Compatibility
73
74 0.11 and later.