Mercurial > prosody-modules
annotate mod_register_web/README.markdown @ 4409:44f6537f6427
mod_invites_adhoc: Fail contact invite if user is not on current host
Only the username was being used, and the host of the requester ignored.
Luckily this only affects admins of the host. If they want to create an
account they can use the other command. If they want to create a contact
they should request from their account on this host.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 28 Jan 2021 07:04:11 +0000 |
| parents | 8d1634b71066 |
| children | 6ae1c7b9c58b |
| rev | line source |
|---|---|
| 1803 | 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 | |
|
2783
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1803
diff
changeset
|
40 Customization |
|
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1803
diff
changeset
|
41 ------------- |
|
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1803
diff
changeset
|
42 |
|
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1803
diff
changeset
|
43 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:
1803
diff
changeset
|
44 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:
1803
diff
changeset
|
45 config file. |
|
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1803
diff
changeset
|
46 |
| 1803 | 47 Compatibility |
| 48 ------------- | |
| 49 | |
| 50 ----- -------------- | |
|
2783
8d1634b71066
mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents:
1803
diff
changeset
|
51 0.10 Works |
| 1803 | 52 0.9 Works |
| 53 0.8 Doesn't work | |
| 54 ----- -------------- | |
| 55 | |
| 56 Todo | |
| 57 ---- | |
| 58 | |
| 59 Different CAPTCHA implementation support | |
| 60 | |
| 61 Collection of additional data, such as email address | |
| 62 | |
| 63 The module kept simple! |