Mercurial > prosody-wiki

annotate mod_register_redirect.wiki @ 247:012884e6ba5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
edited wiki to reflect changes.
author Marco Cirillo <maranda@lightwitch.org>
date Tue, 20 Dec 2011 20:29:32 +0000
parents 19a544b455b8
children 7a597092e71f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
215
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
1 #summary XEP-077 IBR Registration Redirect.
218
19a544b455b8 mod_register_redirect: corrected wrong stage.
Marco Cirillo <maranda@lightwitch.org>
parents: 217
diff changeset
2 #labels Stage-Beta
215
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
3
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
4 = Introduction =
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
5
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
6 Registration Redirect as explained in the [http://xmpp.org/extensions/xep-0077.html#redirect IBR XEP].
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
7
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
8 = Details =
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
9
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
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.
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
11
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
12 = Usage =
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
13
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
14 Copy the module file into your Prosody modules directory.
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
15
217
1203d8b8a8a2 mod_register_redirect: minor tweak.
Marco Cirillo <maranda@lightwitch.org>
parents: 215
diff changeset
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).
1203d8b8a8a2 mod_register_redirect: minor tweak.
Marco Cirillo <maranda@lightwitch.org>
parents: 215
diff changeset
17 These are the optional parameters you can specify into your global server/hostname configuration:
215
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
18 {{{
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
19 registration_whitelist = { "*your whitelisted web server ip address*" }
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
20 registrarion_url = "*your web registration page url*"
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
21 registration_text = "Your custom instructions banner here"
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
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)
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
23 }}}
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
24
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
25 To not employ any whitelisting (i.e. registration is handled externally).
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
26 {{{
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
27 no_registration_whitelist = true
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
28 }}}
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
29
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
30 = Compatibility =
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
31
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
32 * 0.8 works
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
33 * 0.7 might not work
062ee740d924 mod_register_redirect: created wiki page.
maranda3985@gmail.com
parents:
diff changeset
34 * 0.6 won't work
217
1203d8b8a8a2 mod_register_redirect: minor tweak.
Marco Cirillo <maranda@lightwitch.org>
parents: 215
diff changeset
35 * 0.5 won't work