Comparison

mod_invites_page/README.markdown @ 4094:dd00a2b9927c

mod_invites_page: New module to generate landing page for invites
author Matthew Wild <mwild1@gmail.com>
date Fri, 11 Sep 2020 13:52:32 +0100
child 4104:476afcbfb3e9
comparison
equal deleted inserted replaced
4093:a2116f5a7c8f 4094:dd00a2b9927c
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: 'Generate friendly web page for invitations'
5 ...
6
7 Introduction
8 ============
9
10 This module is part of the suite of modules that implement invite-based
11 account registration for Prosody. The other modules are:
12
13 - mod_invites
14 - mod_invites_adhoc
15 - mod_invites_register
16 - mod_invites_register_web
17 - mod_register_apps
18
19 For details and a full overview, start with the mod_invites documentation.
20
21 Details
22 =======
23
24 mod_invites_page provides a unique web page for each generated invitation.
25 Without this module, Prosody will only be able to generate invite links as
26 `xmpp:` URIs (they look something like `xmpp:example.com?register;preauth=29Xbxr91`).
27 URIs will only work if the invited user already has an XMPP client installed.
28 This is usually not the case.
29
30 This module transforms the URI into a friendly web page that can be shared
31 via any method (email, SMS, etc.), and opened in any browser. The page explains
32 the invitation and guides the user to set up their account using one of a
33 configurable list of XMPP clients (to configure the list, see mod_register_apps
34 documentation).
35
36 Configuration
37 =============
38
39 | Name | Description | Default |
40 |---------------------------|--------------------------------------------------------------------------------|------------------------------------------------------------|
41 | invites_page | The format of an invite page URL (must begin with `https://`) | `"https://{host}:5281/invites_page?{invite.token}"` |
42 | invites_registration_page | The format of an invite registration page URL (may be relative to invites_page)| `"register?t={invite.token}&c={app.id}"` |
43 | | | site_name | The friendly name of the server| `"example.com"` |
44
45 The `invites_page` and `invites_registration_page` options are templates
46 that support a number of variables. The most useful being `{host}` and
47 `{invite.token}`.
48
49 All the usual [HTTP configuration options](https://prosody.im/doc/http)
50 can be used to configure this module. In particular, if you run Prosody
51 behind a reverse proxy such as nginx or Apache, you will probably want
52 to set `http_external_url` so that Prosody knows what URLs should look
53 like for users.