Mercurial > prosody-modules

diff mod_invites_register_web/README.md @ 6227:29a646bad096

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_invites_register_web: Allow pointing other HTML templates Follows how some other modules allow overriding templates.
author Kim Alvefur <zash@zash.se>
date Thu, 22 May 2025 23:40:23 +0200
parents 2e358c105f64
children 22b5b744fc78
line wrap: on
line diff
--- a/mod_invites_register_web/README.md	Fri May 16 13:45:22 2025 +0200
+++ b/mod_invites_register_web/README.md	Thu May 22 23:40:23 2025 +0200
@@ -34,8 +34,18 @@
 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.
+The optional `site_name` setting can be used to override the displayed site name.
+
+```lua
+site_name = "My Chat Service"
+```
+
+HTML templates can be overridden by using `invites_register_template_path`, see the `html/` directory in the sources for the files needed.
+
+```lua
+invites_register_template_path = "/path/to/templates/html"
+```
+
 
 You may also set `webchat_url` to the URL of a web chat that will be linked
 to after successful registration. If not specified but mod_conversejs is loaded