Mercurial > prosody-modules
diff mod_invite/README.markdown @ 2059:e96a86561f3e
mod_invite: Added README.
author | Thijs Alkemade <me@thijsalkema.de> |
---|---|
date | Wed, 02 Mar 2016 19:17:12 +0100 |
parents | |
children | 78b7879a04f7 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_invite/README.markdown Wed Mar 02 19:17:12 2016 +0100 @@ -0,0 +1,25 @@ +--- +labels: +- 'Stage-Alpha' +summary: 'Allows users to invite new users' +... + +Introduction +============ + +This module allows users with an account to generate single-use invite URLs +using an ad-hoc command. The invite URLs allow new users to create an account +even if public registration is disabled. + +After the account is created, the inviter and the invitee are automatically +added to the other's roster. The inviter of a user is stored, so can be used +later (for example, for detecting spammers). + +This module depends on Prosody's internal webserver. + +Compatibility +============= + + ----- ------- + 0.9 Works + ----- -------