prosody-modules
ffd0184cd478
mod_register_web/README.md
Software / code / prosody-modules
File
mod_register_web/README.md @ 6111:ffd0184cd478
mod_compliance_latest: New module that depends on and therefore loads the latest compliance tester mod.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
new file mode 100644
--- /dev/null
+++ b/mod_compliance_latest/README.md
@@ -0,0 +1,25 @@
+---
+summary: XMPP Compliance Suites self-test
+labels:
+- Stage-Beta
+rockspec:
+ dependencies:
+ - mod_compliance_2023
+...
+
+# Introduction
+
+This module will always require and load to the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023].
+
+# Configuration
+
+Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
+See the linked module for further details.
+
+# Compatibility
+
+ Prosody-Version Status
+ --------------- ----------------------
+ trunk Works as of 2024-12-22
+ 0.12 Works
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
new file mode 100644
--- /dev/null
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -0,0 +1,1 @@
+module:depends("compliance_2023");
| author | Menel <menel@snikket.de> |
|---|---|
| date | Sun, 22 Dec 2024 18:12:42 +0100 |
| parent | 6003:fe081789f7b5 |
line wrap: on
line source
--- labels: - 'Stage-Alpha' summary: A web interface to register user accounts rockspec: build: copy_directories: - templates ... Introduction ------------ There are various reasons to prefer web registration instead of "in-band" account registration over XMPP. For example the lack of CAPTCHA support in clients and servers. Details ------- mod\_register\_web has Prosody serve a web page where users can sign up for an account. It implements reCAPTCHA to prevent automated sign-ups (from bots, etc.). Configuration ------------- The module is served on Prosody's default HTTP ports at the path `/register_web`. More details on configuring HTTP modules in Prosody can be found in our [HTTP documentation](http://prosody.im/doc/http). To configure the CAPTCHA you need to supply a 'captcha\_options' option: captcha_options = { recaptcha_private_key = "12345"; recaptcha_public_key = "78901"; } The keys for reCAPTCHA are available in your reCAPTCHA account, visit [reCAPTCHA](https://developers.google.com/recaptcha/) for more info. If no reCaptcha options are set, a simple built in captcha is used. Customization ------------- Copy the files in mod_register_web/templates/ to a new directory. Edit them, and set `register_web_template = "/path/to/your/custom-templates"` in your config file. Compatibility ------------- ----- -------------- 0.10 Works 0.9 Works 0.8 Doesn't work ----- -------------- Todo ---- Different CAPTCHA implementation support Collection of additional data, such as email address The module kept simple!
