Mercurial > prosody-modules

annotate mod_register_web/README.markdown @ 5119:048e339706ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Remove manual reference expansion in schema This hack was originally added to reduce the number of definitions of common attributes (type, to, from etc) and payloads (e.g. delay). This predated pointers and references, and until now was needed because parsing picked out the correct stanza kind from the schema, which broke internal references. Removing this hack paves the way for allowing the schema to be configured or customized more easily.
author Kim Alvefur <zash@zash.se>
date Tue, 20 Dec 2022 21:48:28 +0100
parents b45c23ce24ba
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 labels:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 - 'Stage-Alpha'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 summary: A web interface to register user accounts
4912
b45c23ce24ba mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents: 4439
diff changeset
5 rockspec:
b45c23ce24ba mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents: 4439
diff changeset
6 build:
b45c23ce24ba mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents: 4439
diff changeset
7 copy_directories:
b45c23ce24ba mod_register_web: Include HTML templates in rock (thanks unbunt)
Kim Alvefur <zash@zash.se>
parents: 4439
diff changeset
8 - templates
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 ...
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 ------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 There are various reasons to prefer web registration instead of
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 "in-band" account registration over XMPP. For example the lack of
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 CAPTCHA support in clients and servers.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 Details
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 -------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 mod\_register\_web has Prosody serve a web page where users can sign up
4439
6ae1c7b9c58b mod_register_web: Update reCAPTCHA URL
Michel Le Bihan <michel@lebihan.pl>
parents: 2783
diff changeset
22 for an account. It implements reCAPTCHA to prevent automated sign-ups
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 (from bots, etc.).
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 -------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 The module is served on Prosody's default HTTP ports at the path
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 `/register_web`. More details on configuring HTTP modules in Prosody can
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 be found in our [HTTP documentation](http://prosody.im/doc/http).
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 To configure the CAPTCHA you need to supply a 'captcha\_options' option:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 captcha_options = {
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 recaptcha_private_key = "12345";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 recaptcha_public_key = "78901";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 }
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38
4439
6ae1c7b9c58b mod_register_web: Update reCAPTCHA URL
Michel Le Bihan <michel@lebihan.pl>
parents: 2783
diff changeset
39 The keys for reCAPTCHA are available in your reCAPTCHA account, visit
6ae1c7b9c58b mod_register_web: Update reCAPTCHA URL
Michel Le Bihan <michel@lebihan.pl>
parents: 2783
diff changeset
40 [reCAPTCHA](https://developers.google.com/recaptcha/) for more info.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42 If no reCaptcha options are set, a simple built in captcha is used.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43
2783
8d1634b71066 mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents: 1803
diff changeset
44 Customization
8d1634b71066 mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents: 1803
diff changeset
45 -------------
8d1634b71066 mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents: 1803
diff changeset
46
8d1634b71066 mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents: 1803
diff changeset
47 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
48 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
49 config file.
8d1634b71066 mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents: 1803
diff changeset
50
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 -------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
53
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54 ----- --------------
2783
8d1634b71066 mod_register_web: Update README to explain customization
Matthew Wild <mwild1@gmail.com>
parents: 1803
diff changeset
55 0.10 Works
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56 0.9 Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57 0.8 Doesn't work
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
58 ----- --------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
59
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
60 Todo
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
61 ----
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
62
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
63 Different CAPTCHA implementation support
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
64
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
65 Collection of additional data, such as email address
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
66
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
67 The module kept simple!