Annotate

mod_invites_tracking/README.md @ 6206:ac7e2992fe6e

mod_rest: Strip down error payloads to avoid stack overflow When the util.error feature of including a traceback in the error, util.json can't serialize it as it is often self-referential.
author Kim Alvefur <zash@zash.se>
date Sun, 16 Mar 2025 17:04:51 +0100
parent 6091:a1f6fe0025d2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4394
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
1 ---
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
2 labels:
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
3 - 'Stage-Alpha'
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
4 summary: 'Store who created the invite to create a user account'
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
5 ...
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
6
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
7 Introduction
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
8 ============
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
9
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
10 Invites are an intermediate way between opening registrations completely and
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
11 closing registrations completely.
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
12
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
13 By letting users invite other users to the server, an administrator exposes
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
14 themselves again to the risk of abuse.
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
15
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
16 To combat that abuse more effectively, this module allows to store (outside
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
17 of the user’s information) who created an invite which was used to create the
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
18 user’s account.
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
19
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
20 Details
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
21 =======
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
22
6091
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
23 Add it to `modules_enabled`.
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
24
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
25 Assuming file based storage the information will be stored at your storage location under `./invites_tracking/`
4394
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
26
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
27 Caveats
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
28 =======
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
29
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
30 - The information is not deleted even when the associated user accounts are
32f1f18f4874 mod_invites_tracking: simple module to store who created an invite
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
31 deleted.
6091
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
32 - Currently, there is no integrated way to make use of that information.
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
33
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
34 Compatibility
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
35 =============
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
36
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
37 Prosody-Version Status
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
38 --------------- ---------------------
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
39 trunk Works as of 24-12-08
a1f6fe0025d2 mod_invites_tracking: Add Compability
Menel <menel@snikket.de>
parents: 4394
diff changeset
40 0.12 unknown