prosody-modules
fe081789f7b5
mod_invites_page/README.md
Software / code / prosody-modules
Comparison
mod_invites_page/README.md @ 6003:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
| author | Menel <menel@snikket.de> |
|---|---|
| date | Tue, 22 Oct 2024 10:26:01 +0200 |
| parent | 5141:mod_invites_page/README.markdown@027fb71ad509 |
| child | 6089:9708b2ae6884 |
comparison
equal
deleted
inserted
replaced
| 6002:5a65a632d5b9 | 6003:fe081789f7b5 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Beta' | |
| 4 summary: 'Generate friendly web page for invitations' | |
| 5 rockspec: | |
| 6 dependencies: | |
| 7 - mod_register_apps | |
| 8 build: | |
| 9 copy_directories: | |
| 10 - html | |
| 11 - static | |
| 12 ... | |
| 13 | |
| 14 Introduction | |
| 15 ============ | |
| 16 | |
| 17 This module is part of the suite of modules that implement invite-based | |
| 18 account registration for Prosody. The other modules are: | |
| 19 | |
| 20 - [mod_invites] | |
| 21 - [mod_invites_adhoc] | |
| 22 - [mod_invites_register] | |
| 23 - [mod_invites_register_web] | |
| 24 - [mod_invites_api] | |
| 25 - [mod_register_apps] | |
| 26 | |
| 27 For details and a full overview, start with the [mod_invites] documentation. | |
| 28 | |
| 29 Details | |
| 30 ======= | |
| 31 | |
| 32 mod_invites_page provides a unique web page for each generated invitation. | |
| 33 Without this module, Prosody will only be able to generate invite links as | |
| 34 `xmpp:` URIs (they look something like `xmpp:example.com?register;preauth=29Xbxr91`). | |
| 35 URIs will only work if the invited user already has an XMPP client installed. | |
| 36 This is usually not the case. | |
| 37 | |
| 38 This module transforms the URI into a friendly web page that can be shared | |
| 39 via any method (email, SMS, etc.), and opened in any browser. The page explains | |
| 40 the invitation and guides the user to set up their account using one of a | |
| 41 configurable list of XMPP clients (to configure the list, see mod_register_apps | |
| 42 documentation). | |
| 43 | |
| 44 Configuration | |
| 45 ============= | |
| 46 | |
| 47 | Name | Description | Default | | |
| 48 |---------------------------|--------------------------------------------------------------------------------|-----------------------------------------------------| | |
| 49 | invites_page | The format of an invite page URL (must begin with `https://`) | `"https://{host}:5281/invites_page?{invite.token}"` | | |
| 50 | invites_registration_page | The format of an invite registration page URL (may be relative to invites_page)| `"register?t={invite.token}&c={app.id}"` | | |
| 51 | site_name | The friendly name of the server | `"example.com"` | | |
| 52 | invites_page_external | Set this to true if your invitation pages will be rendered by something else | `false` | | |
| 53 | |
| 54 The `invites_page` and `invites_registration_page` options are templates | |
| 55 that support a number of variables. The most useful being `{host}` and | |
| 56 `{invite.token}`. | |
| 57 | |
| 58 All the usual [HTTP configuration options](https://prosody.im/doc/http) | |
| 59 can be used to configure this module. In particular, if you run Prosody | |
| 60 behind a reverse proxy such as nginx or Apache, you will probably want | |
| 61 to set `http_external_url` so that Prosody knows what URLs should look | |
| 62 like for users. | |
| 63 | |
| 64 If you want to disable this module's built-in pages and use an external | |
| 65 invitation page generator (such as [ge0rg/easy-xmpp-invitation](https://github.com/ge0rg/easy-xmpp-invitation) | |
| 66 then set `invites_page_external = true` and set `invites_page` to the | |
| 67 appropriate URL for your installation. |
