Mercurial > prosody-wiki

annotate mod_register_web.wiki @ 424:3ed760b4fa14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
I'll just go ahead and call mod_carbons Beta, but it's really actually pretty stable (Thanks Ben)
author Kim Alvefur <zash@zash.se>
date Wed, 12 Feb 2014 17:26:49 +0100
parents 720b8a84ecf9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
310
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary A web interface to register user accounts
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Alpha
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
6 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.
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
8 = Details =
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
10 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.).
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 = Configuration =
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
14 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://prosody.im/doc/http HTTP documentation].
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
15
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 To configure the CAPTCHA you need to supply a 'captcha_options' option:
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
18 {{{
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
19 captcha_options = {
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20 recaptcha_private_key = "12345";
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21 recaptcha_public_key = "78901";
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22 }
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23 }}}
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
24
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
25 The keys for reCaptcha are available in your reCaptcha account, visit [http://recaptcha.net/ recaptcha.net] for more info.
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26
415
720b8a84ecf9 add note about simple built-in captcha
Kim Alvefur <zash@zash.se>
parents: 311
diff changeset
27 If no reCaptcha options are set, a simple built in captcha is used.
720b8a84ecf9 add note about simple built-in captcha
Kim Alvefur <zash@zash.se>
parents: 311
diff changeset
28
310
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
29 = Compatibility =
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30 || 0.9 || Works ||
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
31 || 0.8 || Doesn't work ||
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
32
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
33 = Todo =
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
34
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
35 Lots. The module is very basic at the moment. In particular I would like to see:
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
36
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
37 * Customisation (CSS and/or HTML)
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
38 * Different CAPTCHA implementation support
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
39 * Collection of additional data, such as email address
466bdf312547 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
40 * The module kept simple!