view mod_welcome_page/README.markdown @ 5472:b80b6947b079

mod_http_oauth2: Always show early errors to user Before having validated the client_id, communicating an error back to the client via redirect would make this an open redirect, so we may just as well skip past that logic, and especially the warning log message.
author Kim Alvefur <zash@zash.se>
date Thu, 18 May 2023 13:43:17 +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`.