File

mod_invite/README.markdown @ 2604:08f2d2a61af8

luacheckrc: Whitelist methods that can be set on the module API instance
author Kim Alvefur <zash@zash.se>
date Mon, 06 Mar 2017 01:05:38 +0100
parent 2059:e96a86561f3e
child 4099: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
  ----- -------