mod_invite/README.markdown
author Kim Alvefur <zash@zash.se>
Sun, 03 Mar 2024 11:23:40 +0100
changeset 5857 97c9b76867ca
parent 4103 78b7879a04f7
permissions -rw-r--r--
mod_log_ringbuffer: Detach event handlers on logging reload (thanks Menel) Otherwise the global event handlers accumulate, one added each time logging is reoladed, and each invocation of the signal or event triggers one dump of each created ringbuffer.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2063
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
     1
---
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
     2
labels:
4103
78b7879a04f7 mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents: 2063
diff changeset
     3
- 'Stage-Deprecated'
2063
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
     4
summary: 'Allows users to invite new users'
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
     5
...
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
     6
4103
78b7879a04f7 mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents: 2063
diff changeset
     7
**NOTE:** This module has been deprecated. Its functionality has been
78b7879a04f7 mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents: 2063
diff changeset
     8
moved to other modules, see the mod_invites documentation for details.
78b7879a04f7 mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents: 2063
diff changeset
     9
2063
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    10
Introduction
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    11
============
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    12
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    13
This module allows users with an account to generate single-use invite URLs
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    14
using an ad-hoc command. The invite URLs allow new users to create an account
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    15
even if public registration is disabled.
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    16
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    17
After the account is created, the inviter and the invitee are automatically
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    18
added to the other's roster. The inviter of a user is stored, so can be used
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    19
later (for example, for detecting spammers).
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    20
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    21
This module depends on Prosody's internal webserver.
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    22
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    23
Compatibility
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    24
=============
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    25
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    26
  ----- -------
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    27
  0.9   Works
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
    28
  ----- -------