Mercurial > prosody-modules
view mod_welcome_page/README.markdown @ 4668:ede9682c2022
mod_external_services: Factor out public function for converting to XML
Along with the previous commit, allows building the XML thing yourself,
should you wish to send it yourself or use it in a different context than
an iq reply.
API change: The 'reply' is removed from the event.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 30 Aug 2021 20:19:15 +0200 |
| parents | ffb709728210 |
| children | 03a647d2837e |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'Serve a welcome page to users' rockspec: dependencies: - mod_invites - mod_http_libjs build: copy_directories: - html ... Introduction ============ This module serves a welcome page to users, and allows them to create an account invite via the web on invite-only servers. The page template and policy of when to allow account creation are both possible to override. This module is part of the suite of modules that implement invite-based account registration for Prosody. The other modules are: - mod_invites - mod_invites_adhoc - mod_invites_page - mod_invites_register - mod_invites_register_web - mod_register_apps For details and a full overview, start with the mod_invites documentation. Configuration ======= `welcome_page_template_path` : The path to a directory containing the page templates and assets. See the module source for the example template. `welcome_page_variables` : Optional variables to pass to the template, available as `{var.name}` `welcome_page_open_registration` : Whether to allow account creation in the absence of any other plugin overriding the policy. Defaults to `false` unless `registration_invite_only` is set to `false`.