prosody-modules: mod_welcome_page/README.markdown@e7584fd5b191 (annotated)

4188 9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	1	---
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	2	labels:
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	3	- 'Stage-Beta'
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	4	summary: 'Serve a welcome page to users'
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	5	rockspec:
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	6	dependencies:
4609 ffb709728210 mod_welcome_page: Add dependency on mod_http_libjs Kim Alvefur <zash@zash.se> parents: 4188 diff changeset	7	- mod_http_libjs
4188 9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	8	build:
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	9	copy_directories:
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	10	- html
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	11	...
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	12
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	13	Introduction
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	14	============
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	15
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	16	This module serves a welcome page to users, and allows them to create an
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	17	account invite via the web on invite-only servers.
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	18
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	19	The page template and policy of when to allow account creation are both
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	20	possible to override.
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	21
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	22	This module is part of the suite of modules that implement invite-based
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	23	account registration for Prosody. The other modules are:
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	24
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	25	- mod_invites
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	26	- mod_invites_adhoc
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	27	- mod_invites_page
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	28	- mod_invites_register
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	29	- mod_invites_register_web
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	30	- mod_register_apps
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	31
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	32	For details and a full overview, start with the mod_invites documentation.
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	33
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	34	Configuration
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	35	=======
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	36
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	37	`welcome_page_template_path`
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	38	: The path to a directory containing the page templates and assets. See
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	39	the module source for the example template.
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	40
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	41	`welcome_page_variables`
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	42	: Optional variables to pass to the template, available as `{var.name}`
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	43
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	44	`welcome_page_open_registration`
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	45	: Whether to allow account creation in the absence of any other plugin
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	46	overriding the policy. Defaults to `false` unless `registration_invite_only`
9127fa98ee1e mod_welcome_page: New module to provide a friendly entrypoint to invite-based setups Matthew Wild <mwild1@gmail.com> parents: diff changeset	47	is set to `false`.

author	Nicholas George <wirlaburla@worlio.com>
	Tue, 21 May 2024 01:09:12 -0500
changeset 5915	e7584fd5b191
parent 5485	03a647d2837e
permissions	-rw-r--r--