view mod_invites_register_web/README.markdown @ 4135:ed0c7044b00f

mod_invites_register_web: Include html resources in rock
author Kim Alvefur <>
date Tue, 15 Sep 2020 19:18:31 +0200
parents 70af86f54704
children 3a03ae9a0882
line wrap: on
line source

- 'Stage-Beta'
summary: 'Register accounts via the web using invite tokens'
  - mod_invites
  - mod_invites_page
  - mod_register_apps
    - html


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.


mod_invites_register_web implements a web-based registration form that
validates invite tokens. It also supports guiding the user through client
download and configuration via mod_register_apps.

There is no specific configuration for this module (though it uses the
optional `site_name` to override the displayed site name.

This module depends on mod_invites_page solely for the case where an invalid
invite token is received - it will redirect to mod_invites_page so that an
appropriate error can be served to the user.