43 documentation). |
43 documentation). |
44 |
44 |
45 Configuration |
45 Configuration |
46 ============= |
46 ============= |
47 |
47 |
48 | Name | Description | Default | |
48 | Name | Description | Default | |
49 |---------------------------|--------------------------------------------------------------------------------|------------------------------------------------------------| |
49 |---------------------------|--------------------------------------------------------------------------------|-----------------------------------------------------| |
50 | invites_page | The format of an invite page URL (must begin with `https://`) | `"https://{host}:5281/invites_page?{invite.token}"` | |
50 | invites_page | The format of an invite page URL (must begin with `https://`) | `"https://{host}:5281/invites_page?{invite.token}"` | |
51 | 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 | invites_registration_page | The format of an invite registration page URL (may be relative to invites_page)| `"register?t={invite.token}&c={app.id}"` | |
52 | site_name | The friendly name of the server | `"example.com"` | |
52 | site_name | The friendly name of the server | `"example.com"` | |
|
53 | invites_page_external | Set this to true if your invitation pages will be rendered by something else | `false` | |
53 |
54 |
54 The `invites_page` and `invites_registration_page` options are templates |
55 The `invites_page` and `invites_registration_page` options are templates |
55 that support a number of variables. The most useful being `{host}` and |
56 that support a number of variables. The most useful being `{host}` and |
56 `{invite.token}`. |
57 `{invite.token}`. |
57 |
58 |
58 All the usual [HTTP configuration options](https://prosody.im/doc/http) |
59 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 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 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 to set `http_external_url` so that Prosody knows what URLs should look |
62 like for users. |
63 like for users. |
|
64 |
|
65 If you want to disable this module's built-in pages and use an external |
|
66 invitation page generator (such as [ge0rg/easy-xmpp-invitation](https://github.com/ge0rg/easy-xmpp-invitation) |
|
67 then set `invites_page_external = true` and set `invites_page` to the |
|
68 appropriate URL for your installation. |