Mercurial > prosody-modules
annotate mod_register_redirect/README.markdown @ 5920:254a21a104aa
mod_server_contact_info: Backport from prosody trunk
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Fri, 07 Jun 2024 16:14:58 +0100 |
| parents | 372b6c4bf409 |
| children |
| rev | line source |
|---|---|
| 1803 | 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*" } | |
|
5727
372b6c4bf409
mod_register_redirect: docs: Fix typo in example (thanks melvo)
Matthew Wild <mwild1@gmail.com>
parents:
2785
diff
changeset
|
32 registration_url = "*your web registration page url*" |
| 1803 | 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 | |
| 2785 | 44 ------ -------------- |
| 45 0.10 Works | |
| 46 0.9 Works | |
| 47 0.8 Works | |
| 48 0.7 Might not work | |
| 49 0.6 Doesn't work | |
| 50 0.5 Doesn't work | |
| 51 ------ -------------- | |
| 1803 | 52 |