Mercurial > prosody-modules
view mod_welcome_page/README.markdown @ 5298:12f7d8b901e0
mod_audit: Support for adding location (GeoIP) to audit events
This can be more privacy-friendly than logging full IP addresses, and also
more informative to a user - IP addresses don't mean much to the average
person, however if they see activity from outside their expected country, they
can immediately identify suspicious activity.
As with IPs, this field is configurable for deployments that would like to
disable it. Location is also not logged when the geoip library is not
available.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Sat, 01 Apr 2023 13:11:53 +0100 |
| 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`.