prosody-modules
c539334dd01a
mod_invites_adhoc/README.markdown
Software / code / prosody-modules
File
mod_invites_adhoc/README.markdown @ 4260:c539334dd01a
mod_http_oauth2: Rescope oauth client config into users' storage
This produces client_id of the form owner@host/random and prevents
clients from being deleted by registering an account with the same name
and then deleting the account, as well as having the client
automatically be deleted when the owner account is removed.
On one hand, this leaks the bare JID of the creator to users. On the
other hand, it makes it obvious who made the oauth application.
This module is experimental and only for developers, so this can be
changed if a better method comes up.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sat, 21 Nov 2020 23:55:10 +0100 |
| parent | 4224:816c2fa1ca84 |
| child | 4587:0105df2138ff |
line wrap: on
line source
--- labels: - 'Stage-Beta' rockspec: dependencies: - mod_invites 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_invites_api] - [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.
