Mercurial > prosody-modules
comparison mod_register_web/README.wiki @ 1782:29f3d6b7ad16
Import wiki pages
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 24 Aug 2015 16:43:56 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 1781:12ac88940fe3 | 1782:29f3d6b7ad16 |
|---|---|
| 1 #summary A web interface to register user accounts | |
| 2 #labels Stage-Alpha | |
| 3 | |
| 4 = Introduction = | |
| 5 | |
| 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. | |
| 7 | |
| 8 = Details = | |
| 9 | |
| 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.). | |
| 11 | |
| 12 = Configuration = | |
| 13 | |
| 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]. | |
| 15 | |
| 16 To configure the CAPTCHA you need to supply a 'captcha_options' option: | |
| 17 | |
| 18 {{{ | |
| 19 captcha_options = { | |
| 20 recaptcha_private_key = "12345"; | |
| 21 recaptcha_public_key = "78901"; | |
| 22 } | |
| 23 }}} | |
| 24 | |
| 25 The keys for reCaptcha are available in your reCaptcha account, visit [http://recaptcha.net/ recaptcha.net] for more info. | |
| 26 | |
| 27 If no reCaptcha options are set, a simple built in captcha is used. | |
| 28 | |
| 29 = Compatibility = | |
| 30 || 0.9 || Works || | |
| 31 || 0.8 || Doesn't work || | |
| 32 | |
| 33 = Todo = | |
| 34 | |
| 35 Lots. The module is very basic at the moment. In particular I would like to see: | |
| 36 | |
| 37 * Customisation (CSS and/or HTML) | |
| 38 * Different CAPTCHA implementation support | |
| 39 * Collection of additional data, such as email address | |
| 40 * The module kept simple! |