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:

For details and a full overview, start with the mod_invites documentation.


The path to a directory containing the page templates and assets. See the module source for the example template.
Optional variables to pass to the template, available as {}
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.


With the plugin installer in Prosody 0.12 you can use:

sudo prosodyctl install --server= mod_welcome_page

For earlier versions see the documentation for installing 3rd party modules