annotate mod_invite/README.markdown @ 3881:5d7df207dc2b

mod_rest: Add final pieces of XEP-0050 (actions, note, form) Forgot to add in a previous commit.
author Kim Alvefur <zash@zash.se>
date Tue, 04 Feb 2020 23:05:43 +0100
parents e96a86561f3e
children 78b7879a04f7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2059
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:
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
3 - 'Stage-Alpha'
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
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
7 Introduction
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
8 ============
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
9
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
10 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
11 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
12 even if public registration is disabled.
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
13
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
14 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
15 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
16 later (for example, for detecting spammers).
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
17
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
18 This module depends on Prosody's internal webserver.
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
19
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
20 Compatibility
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
21 =============
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 ----- -------
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
24 0.9 Works
e96a86561f3e mod_invite: Added README.
Thijs Alkemade <me@thijsalkema.de>
parents:
diff changeset
25 ----- -------