comparison mod_register_redirect/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 XEP-077 IBR Registration Redirect.
2 #labels Stage-Stable
3
4 = Introduction =
5
6 Registration Redirect as explained in the [http://xmpp.org/extensions/xep-0077.html#redirect IBR XEP].
7
8 = Details =
9
10 This module shows instructions on how to register to the server, should it be necessary to perform it through other means Out-Of-Band or not, and also let's registrations origining from ip addresses in the whitelist to go through normally.
11
12 = Usage =
13
14 Copy the module file into your Prosody modules directory.
15
16 The module will work "out of the box" as long as at least an admin entry is specified (see admins = {} option into prosody's documentation).
17 These are the optional parameters you can specify into your global server/hostname configuration:
18 {{{
19 registration_whitelist = { "*your whitelisted web server ip address*" }
20 registrarion_url = "*your web registration page url*"
21 registration_text = "Your custom instructions banner here"
22 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)
23 }}}
24
25 To not employ any whitelisting (i.e. registration is handled externally).
26 {{{
27 no_registration_whitelist = true
28 }}}
29
30 = Compatibility =
31
32 * 0.9 works
33 * 0.8 works
34 * 0.7 might not work
35 * 0.6 won't work
36 * 0.5 won't work