view mod_register_web/README.markdown @ 5065:368bf9b06484

mod_block_registrations: Expand default list of blocked usernames (RFC 2142)
author Matthew Wild <mwild1@gmail.com>
date Thu, 13 Oct 2022 22:51:41 +0100
parents b45c23ce24ba
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: A web interface to register user accounts
rockspec:
  build:
    copy_directories:
    - templates
...

Introduction
------------

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.

Details
-------

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.).

Configuration
-------------

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 documentation](http://prosody.im/doc/http).

To configure the CAPTCHA you need to supply a 'captcha\_options' option:

        captcha_options = {
          recaptcha_private_key = "12345";
          recaptcha_public_key = "78901";
        }

The keys for reCAPTCHA are available in your reCAPTCHA account, visit
[reCAPTCHA](https://developers.google.com/recaptcha/) for more info.

If no reCaptcha options are set, a simple built in captcha is used.

Customization
-------------

Copy the files in mod_register_web/templates/ to a new directory. Edit them,
and set `register_web_template = "/path/to/your/custom-templates"` in your
config file.

Compatibility
-------------

  ----- --------------
  0.10  Works
  0.9   Works
  0.8   Doesn't work
  ----- --------------

Todo
----

Different CAPTCHA implementation support

Collection of additional data, such as email address

The module kept simple!