mod_register_redirect

Introduction

Registration Redirect as explained in the IBR XEP.

Details

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.

Usage

Copy the module file into your Prosody modules directory.

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).These are the optional parameters you can specify into your global server/hostname configuration:

registration_whitelist = { "*your whitelisted web server ip address*" }
registration_url = "*your web registration page url*"
registration_text = "Your custom instructions banner here"
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)

To not employ any whitelisting (i.e. registration is handled externally).

no_registration_whitelist = true

Compatibility

0.10 Works
0.9 Works
0.8 Works
0.7 Might not work
0.6 Doesn’t work
0.5 Doesn’t work

Installation

With the plugin installer in Prosody 0.12 you can use:

sudo prosodyctl install --server=https://modules.prosody.im/rocks/ mod_register_redirect

For earlier versions see the documentation for installing 3rd party modules