prosody-modules
fe081789f7b5
mod_register_web/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_register_web/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 4912:mod_register_web/README.markdown@b45c23ce24ba
comparison
equal deleted inserted replaced
6002:5a65a632d5b9 6003:fe081789f7b5
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: A web interface to register user accounts
5 rockspec:
6 build:
7 copy_directories:
8 - templates
9 ...
10
11 Introduction
12 ------------
13
14 There are various reasons to prefer web registration instead of
15 "in-band" account registration over XMPP. For example the lack of
16 CAPTCHA support in clients and servers.
17
18 Details
19 -------
20
21 mod\_register\_web has Prosody serve a web page where users can sign up
22 for an account. It implements reCAPTCHA to prevent automated sign-ups
23 (from bots, etc.).
24
25 Configuration
26 -------------
27
28 The module is served on Prosody's default HTTP ports at the path
29 `/register_web`. More details on configuring HTTP modules in Prosody can
30 be found in our [HTTP documentation](http://prosody.im/doc/http).
31
32 To configure the CAPTCHA you need to supply a 'captcha\_options' option:
33
34 captcha_options = {
35 recaptcha_private_key = "12345";
36 recaptcha_public_key = "78901";
37 }
38
39 The keys for reCAPTCHA are available in your reCAPTCHA account, visit
40 [reCAPTCHA](https://developers.google.com/recaptcha/) for more info.
41
42 If no reCaptcha options are set, a simple built in captcha is used.
43
44 Customization
45 -------------
46
47 Copy the files in mod_register_web/templates/ to a new directory. Edit them,
48 and set `register_web_template = "/path/to/your/custom-templates"` in your
49 config file.
50
51 Compatibility
52 -------------
53
54 ----- --------------
55 0.10 Works
56 0.9 Works
57 0.8 Doesn't work
58 ----- --------------
59
60 Todo
61 ----
62
63 Different CAPTCHA implementation support
64
65 Collection of additional data, such as email address
66
67 The module kept simple!