Mercurial > prosody-modules

comparison mod_register_redirect/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents
children 2023cba9ead0
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Stable'
4 summary: 'XEP-077 IBR Registration Redirect.'
5 ...
6
7 Introduction
8 ------------
9
10 Registration Redirect as explained in the [IBR
11 XEP](http://xmpp.org/extensions/xep-0077.html#redirect).
12
13 Details
14 -------
15
16 This module shows instructions on how to register to the server, should
17 it be necessary to perform it through other means Out-Of-Band or not,
18 and also let's registrations origining from ip addresses in the
19 whitelist to go through normally.
20
21 Usage
22 -----
23
24 Copy the module file into your Prosody modules directory.
25
26 The module will work "out of the box" as long as at least an admin entry
27 is specified (see admins = {} option into prosody's documentation).These
28 are the optional parameters you can specify into your global
29 server/hostname configuration:
30
31 registration_whitelist = { "*your whitelisted web server ip address*" }
32 registrarion_url = "*your web registration page url*"
33 registration_text = "Your custom instructions banner here"
34 registration_oob = true (default) or false, in the case there's no applicable OOB method (e.g. the server admins needs to be contacted by phone)
35
36 To not employ any whitelisting (i.e. registration is handled
37 externally).
38
39 no_registration_whitelist = true
40
41 Compatibility
42 -------------
43
44 0.9 works
45
46 0.8 works
47
48 0.7 might not work
49
50 0.6 won't work
51
52 0.5 won't work