author | Matthew Wild <mwild1@gmail.com> |
Fri, 23 Sep 2022 22:40:54 +0100 | |
changeset 5057 | 00e8cc6860cb |
parent 4916 | b45c23ce24ba |
permissions | -rw-r--r-- |
1807 | 1 |
--- |
2 |
labels: |
|
3 |
- 'Stage-Alpha' |
|
4 |
summary: A web interface to register user accounts |
|
4916
b45c23ce24ba
mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents:
4443
diff
changeset
|
5 |
rockspec: |
b45c23ce24ba
mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents:
4443
diff
changeset
|
6 |
build: |
b45c23ce24ba
mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents:
4443
diff
changeset
|
7 |
copy_directories: |
b45c23ce24ba
mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents:
4443
diff
changeset
|
8 |
- templates |
1807 | 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 |
|
4443
6ae1c7b9c58b
mod_register_web: Update reCAPTCHA URL
Michel Le Bihan <michel@lebihan.pl>
parents:
2787
diff
changeset
|
22 |
for an account. It implements reCAPTCHA to prevent automated sign-ups |
1807 | 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 |
||
4443
6ae1c7b9c58b
mod_register_web: Update reCAPTCHA URL
Michel Le Bihan <michel@lebihan.pl>
parents:
2787
diff
changeset
|
39 |
The keys for reCAPTCHA are available in your reCAPTCHA account, visit |
6ae1c7b9c58b
mod_register_web: Update reCAPTCHA URL
Michel Le Bihan <michel@lebihan.pl>
parents:
2787
diff
changeset
|
40 |
[reCAPTCHA](https://developers.google.com/recaptcha/) for more info. |
1807 | 41 |
|
42 |
If no reCaptcha options are set, a simple built in captcha is used. |
|
43 |
||
2787
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
44 |
Customization |
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
45 |
------------- |
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
46 |
|
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
47 |
Copy the files in mod_register_web/templates/ to a new directory. Edit them, |
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
48 |
and set `register_web_template = "/path/to/your/custom-templates"` in your |
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
49 |
config file. |
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
50 |
|
1807 | 51 |
Compatibility |
52 |
------------- |
|
53 |
||
54 |
----- -------------- |
|
2787
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1807
diff
changeset
|
55 |
0.10 Works |
1807 | 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! |