Mercurial > prosody-modules
view mod_welcome_page/README.markdown @ 4542:fb4a50bf60f1
mod_prometheus: Invoke stats collection if in 'manual' mode
Since 10d13e0554f9 a special value for statistics_interval "manual"
exists, where a module is expected to invoke processing in connection to
collection of stats. This makes internal collection and exporting to
Prometheus happens at the same time with no chance of timers getting out
of sync.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 13 Apr 2021 23:53:53 +0200 |
| parents | 9127fa98ee1e |
| children | ffb709728210 |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'Serve a welcome page to users' rockspec: dependencies: - mod_invites 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`.