1 

     2 This module allows admins and users to create invitations suitable for sharing

     3 to potential new users/contacts.

     4 

     5 User invitations can be created through the "New Invite" ad-hoc command. An overview

     6 of the semantics and protocol can be found at [modernxmpp.org/client/invites](https://docs.modernxmpp.org/client/invites/).

     7 

     8 This module depends on mod_invites to actually create and store the invitation tokens.

     9 

    10 # Configuration

    11 

    12 To allow users to join your server through invitations, you must

    13 enable mod_register_ibr and set allow_registration = true, and then

    14 also set `registration_invite_only = true` to restrict registration.

    15 

    16 ``` {.lua}

    17 -- To allow invitation through a token, mod_register

    18 registration_invite_only = true

    19 ```

    20 

    21 To allow existing users of your server to send invitation links that

    22 allow new people to join your server, you can set `allow_user_invites = true`.

    23 

    24 If you do not wish users to invite other users to create accounts on your

    25 server, set `allow_user_invites = false`. They will still be able to send

    26 contact invites, but new contacts will be required to register an account

    27 on a different server.

    28 

    29 # Compatibility

    30 

    31 0.11 and later.