Software /
code /
prosody-modules
File
mod_easy_invite/README.markdown @ 5119:048e339706ba
mod_rest: Remove manual reference expansion in schema
This hack was originally added to reduce the number of definitions of
common attributes (type, to, from etc) and payloads (e.g. delay). This
predated pointers and references, and until now was needed because
parsing picked out the correct stanza kind from the schema, which broke
internal references.
Removing this hack paves the way for allowing the schema to be
configured or customized more easily.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Tue, 20 Dec 2022 21:48:28 +0100 (2022-12-20) |
parent | 4150:d3d2e9e7e8b7 |
line wrap: on
line source
--- labels: - 'Stage-Deprecated' summary: 'Invite management module for Prosody (deprecated)' rockspec: dependencies: - mod_invites --- ::: {.alert .alert-warning} **NOTE:** This module has been deprecated. Its functionality has been moved to other modules, see the mod_invites documentation for details. ::: This module allows admins and users to create invitations suitable for sharing to potential new users/contacts. User invitations can be created through the "New Invite" ad-hoc command. An overview of the semantics and protocol can be found at [modernxmpp.org/client/invites](https://docs.modernxmpp.org/client/invites/). This module depends on mod_invites to actually create and store the invitation tokens. # Configuration To allow users to join your server through invitations, you must enable mod_register_ibr and set allow_registration = true, and then also set `registration_invite_only = true` to restrict registration. | Name | Description | Default | |--------------------------|-----------------------------------------------------------------------------------|---------| | registration_invite_only | Whether registration attempts without an invite token should be blocked | true | | allow_user_invites | Whether existing users should be allowed to invite new users to register accounts | true | ## Example: Invite-only registration ``` {.lua} -- To allow invitation through a token, mod_register allow_registration = true registration_invite_only = true ``` ## Example: Open registration This setup allows completely open registration, even without an invite token. ``` {.lua} allow_registration = true registration_invite_only = false ``` ## Invite creation permissions To allow existing users of your server to send invitation links that allow new people to join your server, you can set `allow_user_invites = true`. If you do not wish users to invite other users to create accounts on your server, set `allow_user_invites = false`. They will still be able to send contact invites, but new contacts will be required to register an account on a different server. # Usage Users can use the "New Invite" ad-hoc command through their client. Admins can create registration links using prosodyctl, e.g. ``` prosodyctl mod_easy_invite example.com generate ``` # Compatibility 0.11 and later.