Mercurial > prosody-modules

diff mod_register_oob_url/README.markdown @ 2860:a7c2df6b2662

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_registration_oob_url: inital commit. simple/straight forward module to advertise oob registration url
author Daniel Gultsch <daniel@gultsch.de>
date Wed, 03 Jan 2018 15:19:55 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_register_oob_url/README.markdown	Wed Jan 03 15:19:55 2018 +0100
@@ -0,0 +1,29 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'XEP-077 IBR registration URL redirect'
+---
+
+Introduction
+============
+
+Registration redirect to out of band URL as described in  [XEP-0077: In-Band Registration](http://xmpp.org/extensions/xep-0077.html#redirect).
+
+Details
+=======
+
+The already existing module `mod_register_redirect` doesn’t add a stream feature advertising its capabilities  and thus doesn’t work with clients like Conversations.
+
+This module tries to take a simpler and more straight forward approach for admins who just want to redirect to an URL and do not need the features provided by `mod_register_redirect`.
+
+Usage
+=====
+
+Set `allow_registration` to `false` and point `register_oob_url` to the URL that handles your registration.
+
+Compatibility
+=============
+
+  ----- -----------------------------------------------------------------------------
+  0.10  Works
+  ----- -----------------------------------------------------------------------------