This module is part of the suite of modules that implement invite-based account registration for Prosody. The other modules are:

For details and a full overview, start with the mod_invites documentation.


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.


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.