Diff

mod_invites_adhoc/README.markdown @ 4092:2b6918714792

mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
author Matthew Wild <mwild1@gmail.com>
date Fri, 11 Sep 2020 13:50:47 +0100
child 4104:476afcbfb3e9
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_invites_adhoc/README.markdown	Fri Sep 11 13:50:47 2020 +0100
@@ -0,0 +1,48 @@
+---
+labels:
+- 'Stage-Beta'
+summary: 'Enable ad-hoc command for XMPP clients to create invitations'
+...
+
+Introduction
+============
+
+This module is part of the suite of modules that implement invite-based
+account registration for Prosody. The other modules are:
+
+- mod_invites
+- mod_invites_page
+- mod_invites_register
+- mod_invites_register_web
+- mod_register_apps
+
+For details and a full overview, start with the mod_invites documentation.
+
+Details
+=======
+
+mod_invites_adhoc allows XMPP clients to create new invites on the server.
+Clients must support either XEP-0401 (Easy Onboarding) or XEP-0050 (Ad-hoc
+commands).
+
+There are three types of invitation that can be created:
+
+| Account-only invites | These can be used to register a new account |
+| Contact-only invites | These can be shared with a contact so they can easily add you to their contact list |
+| Account-and-contact invites | Like a contact-only invite, but also allows the contact to register on the current server if they don't already have an XMPP account |
+
+Only configured admins of the server are able to create account-only invites. By default
+normal users may only create contact-only invites, but account-and-contact invites can
+be enabled with the `allow_user_invites` option.
+
+Configuration
+=============
+
+| Name                  | Description                                                           | Default                                   |
+|-----------------------|-----------------------------------------------------------------------|-------------------------------------------|
+| allow_user_invites    | Whether non-admin users can invite contacts to register on this server| `false`                                   |
+| allow_contact_invites | Whether non-admin users can invite contacts to their roster           | `true`                                    |
+
+The `allow_user_invites` option should be set as desired. However it is
+strongly recommended to leave the other option (`allow_contact_invites`)
+at its default to provide the best user experience.
\ No newline at end of file