Mercurial > prosody-modules

comparison mod_easy_invite/README.markdown @ 3787:28deb30a5272

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_easy_invite: Improve docs surrounding configuration options and defaults
author Matthew Wild <mwild1@gmail.com>
date Mon, 30 Dec 2019 12:04:17 +0000
parents 7209f481bcfe
children 14028430638b
comparison
equal deleted inserted replaced
3786:58e484426d13 3787:28deb30a5272
11 11
12 To allow users to join your server through invitations, you must 12 To allow users to join your server through invitations, you must
13 enable mod_register_ibr and set allow_registration = true, and then 13 enable mod_register_ibr and set allow_registration = true, and then
14 also set `registration_invite_only = true` to restrict registration. 14 also set `registration_invite_only = true` to restrict registration.
15 15
16 | Name | Description | Default |
17 |--------------------------|-----------------------------------------------------------------------------------|---------|
18 | registration_invite_only | Whether registration attempts without an invite token should be blocked | true |
19 | allow_user_invites | Whether existing users should be allowed to invite new users to register accounts | true |
20
21 ## Example: Invite-only registration
16 ``` {.lua} 22 ``` {.lua}
17 -- To allow invitation through a token, mod_register 23 -- To allow invitation through a token, mod_register
24 allow_registration = true
18 registration_invite_only = true 25 registration_invite_only = true
19 ``` 26 ```
27
28 ## Example: Open registration
29
30 This setup allows completely open registration, even without
31 an invite token.
32
33 ``` {.lua}
34 allow_registration = true
35 registration_invite_only = false
36 ```
37
38 ## Invite creation permissions
20 39
21 To allow existing users of your server to send invitation links that 40 To allow existing users of your server to send invitation links that
22 allow new people to join your server, you can set `allow_user_invites = true`. 41 allow new people to join your server, you can set `allow_user_invites = true`.
23 42
24 If you do not wish users to invite other users to create accounts on your 43 If you do not wish users to invite other users to create accounts on your