annotate mod_invites_register_web/README.md @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents 22b5b744fc78
children f4efb8606b92
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4093
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 labels:
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 - 'Stage-Beta'
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 summary: 'Register accounts via the web using invite tokens'
4104
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4093
diff changeset
5 rockspec:
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4093
diff changeset
6 dependencies:
4105
233e170eb027 various: Dependency metadata needs the mod_ prefix
Kim Alvefur <zash@zash.se>
parents: 4104
diff changeset
7 - mod_invites_page
4833
15cf32e666da mod_invites_register_web: Add mod_password_policy checks for web registration
Matthew Wild <mwild1@gmail.com>
parents: 4224
diff changeset
8 - mod_password_policy
4105
233e170eb027 various: Dependency metadata needs the mod_ prefix
Kim Alvefur <zash@zash.se>
parents: 4104
diff changeset
9 - mod_register_apps
4135
ed0c7044b00f mod_invites_register_web: Include html resources in rock
Kim Alvefur <zash@zash.se>
parents: 4109
diff changeset
10 build:
ed0c7044b00f mod_invites_register_web: Include html resources in rock
Kim Alvefur <zash@zash.se>
parents: 4109
diff changeset
11 copy_directories:
ed0c7044b00f mod_invites_register_web: Include html resources in rock
Kim Alvefur <zash@zash.se>
parents: 4109
diff changeset
12 - html
4093
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 ...
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 Introduction
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 ============
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 This module is part of the suite of modules that implement invite-based
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 account registration for Prosody. The other modules are:
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
4223
4ec755c13e9b mod_invites*: Link to each other
Kim Alvefur <zash@zash.se>
parents: 4167
diff changeset
21 - [mod_invites]
4ec755c13e9b mod_invites*: Link to each other
Kim Alvefur <zash@zash.se>
parents: 4167
diff changeset
22 - [mod_invites_adhoc]
4ec755c13e9b mod_invites*: Link to each other
Kim Alvefur <zash@zash.se>
parents: 4167
diff changeset
23 - [mod_invites_page]
4ec755c13e9b mod_invites*: Link to each other
Kim Alvefur <zash@zash.se>
parents: 4167
diff changeset
24 - [mod_invites_register]
4224
816c2fa1ca84 mod_invites*: Also link to mod_invites_api
Kim Alvefur <zash@zash.se>
parents: 4223
diff changeset
25 - [mod_invites_api]
4223
4ec755c13e9b mod_invites*: Link to each other
Kim Alvefur <zash@zash.se>
parents: 4167
diff changeset
26 - [mod_register_apps]
4093
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27
4223
4ec755c13e9b mod_invites*: Link to each other
Kim Alvefur <zash@zash.se>
parents: 4167
diff changeset
28 For details and a full overview, start with the [mod_invites] documentation.
4093
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30 Details
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 =======
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33 mod_invites_register_web implements a web-based registration form that
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34 validates invite tokens. It also supports guiding the user through client
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
35 download and configuration via mod_register_apps.
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
36
6227
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
37 The optional `site_name` setting can be used to override the displayed site name.
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
38
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
39 ```lua
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
40 site_name = "My Chat Service"
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
41 ```
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
42
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
43 HTML templates can be overridden by using `invites_register_template_path`, see the `html/` directory in the sources for the files needed.
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
44
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
45 ```lua
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
46 invites_register_template_path = "/path/to/templates/html"
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
47 ```
29a646bad096 mod_invites_register_web: Allow pointing other HTML templates
Kim Alvefur <zash@zash.se>
parents: 6062
diff changeset
48
4093
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
49
4167
3a03ae9a0882 mod_invites_register_web: Support linking to a web chat after successful registration
Matthew Wild <mwild1@gmail.com>
parents: 4135
diff changeset
50 You may also set `webchat_url` to the URL of a web chat that will be linked
6228
22b5b744fc78 mod_invites_register_web: Linkify some plugin references
Kim Alvefur <zash@zash.se>
parents: 6227
diff changeset
51 to after successful registration. If not specified but [mod_conversejs] is loaded
4167
3a03ae9a0882 mod_invites_register_web: Support linking to a web chat after successful registration
Matthew Wild <mwild1@gmail.com>
parents: 4135
diff changeset
52 on the current host, it will default to the URL of that module.
3a03ae9a0882 mod_invites_register_web: Support linking to a web chat after successful registration
Matthew Wild <mwild1@gmail.com>
parents: 4135
diff changeset
53
6228
22b5b744fc78 mod_invites_register_web: Linkify some plugin references
Kim Alvefur <zash@zash.se>
parents: 6227
diff changeset
54 This module depends on [mod_invites_page] solely for the case where an invalid
4093
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
55 invite token is received - it will redirect to mod_invites_page so that an
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
56 appropriate error can be served to the user.
4833
15cf32e666da mod_invites_register_web: Add mod_password_policy checks for web registration
Matthew Wild <mwild1@gmail.com>
parents: 4224
diff changeset
57
15cf32e666da mod_invites_register_web: Add mod_password_policy checks for web registration
Matthew Wild <mwild1@gmail.com>
parents: 4224
diff changeset
58 The module also depends on [mod_password_policy] (which will be automatically
15cf32e666da mod_invites_register_web: Add mod_password_policy checks for web registration
Matthew Wild <mwild1@gmail.com>
parents: 4224
diff changeset
59 loaded). As a consequence of this module being loaded, the default password
15cf32e666da mod_invites_register_web: Add mod_password_policy checks for web registration
Matthew Wild <mwild1@gmail.com>
parents: 4224
diff changeset
60 policies will be enforced for all registrations on the server if not
15cf32e666da mod_invites_register_web: Add mod_password_policy checks for web registration
Matthew Wild <mwild1@gmail.com>
parents: 4224
diff changeset
61 explicitly loaded or configured.
6062
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
62
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
63 Compatibility
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
64 =============
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
65
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
66 Prosody-Version Status
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
67 --------------- ---------------------
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
68 trunk Works as of 24-12-08
2e358c105f64 mod_invites_register_web: Add compability-section
Menel <menel@snikket.de>
parents: 5975
diff changeset
69 0.12 Works