view mod_invite/README.markdown @ 2960:b8834fec4b7e

Rename to README.markdown
author JC Brand <jc@opkode.com>
date Wed, 28 Mar 2018 00:02:37 +0200
parents e96a86561f3e
children 78b7879a04f7
line wrap: on
line source

---
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
  ----- -------