Mercurial > prosody-modules

comparison mod_register_web/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents
children 8d1634b71066
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: A web interface to register user accounts
5 ...
6
7 Introduction
8 ------------
9
10 There are various reasons to prefer web registration instead of
11 "in-band" account registration over XMPP. For example the lack of
12 CAPTCHA support in clients and servers.
13
14 Details
15 -------
16
17 mod\_register\_web has Prosody serve a web page where users can sign up
18 for an account. It implements reCaptcha to prevent automated sign-ups
19 (from bots, etc.).
20
21 Configuration
22 -------------
23
24 The module is served on Prosody's default HTTP ports at the path
25 `/register_web`. More details on configuring HTTP modules in Prosody can
26 be found in our [HTTP documentation](http://prosody.im/doc/http).
27
28 To configure the CAPTCHA you need to supply a 'captcha\_options' option:
29
30 captcha_options = {
31 recaptcha_private_key = "12345";
32 recaptcha_public_key = "78901";
33 }
34
35 The keys for reCaptcha are available in your reCaptcha account, visit
36 [recaptcha.net](http://recaptcha.net/) for more info.
37
38 If no reCaptcha options are set, a simple built in captcha is used.
39
40 Compatibility
41 -------------
42
43 ----- --------------
44 0.9 Works
45 0.8 Doesn't work
46 ----- --------------
47
48 Todo
49 ----
50
51 Lots. The module is very basic at the moment. In particular I would like
52 to see:
53
54 Customisation (CSS and/or HTML)
55
56 Different CAPTCHA implementation support
57
58 Collection of additional data, such as email address
59
60 The module kept simple!