Mercurial > prosody-wiki

annotate mod_register_url.wiki @ 213:7c960f1b4cf8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added summary.
author maranda3985@gmail.com
date Sun, 11 Sep 2011 00:30:49 +0000
parents b3095d15dd90
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
104
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
1 #summary XEP-077 IBR Registration Redirect.
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
2 #labels Stage-Beta
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
3
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
4 = Introduction =
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
5
204
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
6 Registration Redirect as explained in the [http://xmpp.org/extensions/xep-0077.html#redirect IBR XEP].
104
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
7
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
8 = Details =
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
9
204
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
10 This simple module lets you redirect users who come from IPs not in the registration_whitelist config options to a URL of your choice.
104
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
11
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
12 = Usage =
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
13
204
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
14 Copy the module file into your Prosody modules directory.
104
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
15
204
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
16 Then set the following options into your config file:
104
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
17 {{{
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
18 registration_whitelist = { "*your whitelisted web server ip address*" }
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
19 registrarion_url = "*your web registration page url*"
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
20 }}}
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
21
189
f95cbe1ac9d8 Modified to include changes.
maranda3985@gmail.com
parents: 169
diff changeset
22 To not employ any whitelisting (i.e. registration is handled externally).
f95cbe1ac9d8 Modified to include changes.
maranda3985@gmail.com
parents: 169
diff changeset
23 {{{
f95cbe1ac9d8 Modified to include changes.
maranda3985@gmail.com
parents: 169
diff changeset
24 no_registration_whitelist = true
f95cbe1ac9d8 Modified to include changes.
maranda3985@gmail.com
parents: 169
diff changeset
25 }}}
f95cbe1ac9d8 Modified to include changes.
maranda3985@gmail.com
parents: 169
diff changeset
26
104
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
27 = Compatibility =
8efa9cb52f6c mod_regredirect: Created wiki page through web user interface.
maranda3985
parents:
diff changeset
28
204
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
29 * 0.8 works
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
30 * 0.7 might not work
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
31 * 0.6 won't work
b3095d15dd90 mod_register_url: A little cleanup for the docs.
waqas20
parents: 203
diff changeset
32 * 0.5 won't work