Mercurial > prosody-modules
changeset 3787:28deb30a5272
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 | 58e484426d13 |
| children | 14028430638b |
| files | mod_easy_invite/README.markdown |
| diffstat | 1 files changed, 19 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_easy_invite/README.markdown Sun Dec 29 23:41:32 2019 +0100 +++ b/mod_easy_invite/README.markdown Mon Dec 30 12:04:17 2019 +0000 @@ -13,11 +13,30 @@ enable mod_register_ibr and set allow_registration = true, and then also set `registration_invite_only = true` to restrict registration. +| Name | Description | Default | +|--------------------------|-----------------------------------------------------------------------------------|---------| +| registration_invite_only | Whether registration attempts without an invite token should be blocked | true | +| allow_user_invites | Whether existing users should be allowed to invite new users to register accounts | true | + +## Example: Invite-only registration ``` {.lua} -- To allow invitation through a token, mod_register +allow_registration = true registration_invite_only = true ``` +## Example: Open registration + +This setup allows completely open registration, even without +an invite token. + +``` {.lua} +allow_registration = true +registration_invite_only = false +``` + +## Invite creation permissions + To allow existing users of your server to send invitation links that allow new people to join your server, you can set `allow_user_invites = true`.