Mercurial Mercurial > prosody > prosody-modules / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_invites_adhoc/README.markdown
author Matthew Wild <mwild1@gmail.com>
Fri, 23 Sep 2022 22:40:54 +0100
changeset 5057 00e8cc6860cb
parent 4591 0105df2138ff
child 5145 027fb71ad509
permissions -rw-r--r--
mod_cloud_notify: Fix default extended timeout from 72 days -> 72 hours
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4096
2b6918714792 mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     1
 
---
2b6918714792 mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     2
 
labels:
2b6918714792 mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     3
 
- 'Stage-Beta'
4108
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4096
diff changeset 
     4
 
rockspec:
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4096
diff changeset 
     5
 
  dependencies:
4109
233e170eb027 various: Dependency metadata needs the mod_ prefix
Kim Alvefur <zash@zash.se>
parents: 4108
diff changeset 
     6
 
  - mod_invites
4096
2b6918714792 mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     7
 
summary: 'Enable ad-hoc command for XMPP clients to create invitations'
2b6918714792 mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     8
 
...
2b6918714792 mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     9
 












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    10


Introduction












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    11


============












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    12














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    13


This module is part of the suite of modules that implement invite-based












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    14


account registration for Prosody. The other modules are:












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    15









4227






4ec755c13e9b
mod_invites*: Link to each other



Kim Alvefur <zash@zash.se>


parents: 
4109

diff
changeset




    16


- [mod_invites]












4ec755c13e9b
mod_invites*: Link to each other



Kim Alvefur <zash@zash.se>


parents: 
4109

diff
changeset




    17


- [mod_invites_page]












4ec755c13e9b
mod_invites*: Link to each other



Kim Alvefur <zash@zash.se>


parents: 
4109

diff
changeset




    18


- [mod_invites_register]












4ec755c13e9b
mod_invites*: Link to each other



Kim Alvefur <zash@zash.se>


parents: 
4109

diff
changeset




    19


- [mod_invites_register_web]







4228






816c2fa1ca84
mod_invites*: Also link to mod_invites_api



Kim Alvefur <zash@zash.se>


parents: 
4227

diff
changeset




    20


- [mod_invites_api]







4227






4ec755c13e9b
mod_invites*: Link to each other



Kim Alvefur <zash@zash.se>


parents: 
4109

diff
changeset




    21


- [mod_register_apps]







4096






2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    22









4227






4ec755c13e9b
mod_invites*: Link to each other



Kim Alvefur <zash@zash.se>


parents: 
4109

diff
changeset




    23


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







4096






2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    24














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    25


Details












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    26


=======












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    27














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    28


mod_invites_adhoc allows XMPP clients to create new invites on the server.












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    29


Clients must support either XEP-0401 (Easy Onboarding) or XEP-0050 (Ad-hoc












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    30


commands).












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    31














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    32


There are three types of invitation that can be created:












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    33









4591






0105df2138ff
mod_invites_adhoc/README: Fix table



Kim Alvefur <zash@zash.se>


parents: 
4228

diff
changeset




    34


| Invite type | Description |












0105df2138ff
mod_invites_adhoc/README: Fix table



Kim Alvefur <zash@zash.se>


parents: 
4228

diff
changeset




    35


|--|--|







4096






2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    36


| Account-only invites | These can be used to register a new account |












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    37


| Contact-only invites | These can be shared with a contact so they can easily add you to their contact list |












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    38


| 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 |












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    39














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    40


Only configured admins of the server are able to create account-only invites. By default












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    41


normal users may only create contact-only invites, but account-and-contact invites can












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    42


be enabled with the `allow_user_invites` option.












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    43














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    44


Configuration












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    45


=============












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    46














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    47


| Name                  | Description                                                           | Default                                   |












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    48


|-----------------------|-----------------------------------------------------------------------|-------------------------------------------|












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    49


| allow_user_invites    | Whether non-admin users can invite contacts to register on this server| `false`                                   |












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    50


| allow_contact_invites | Whether non-admin users can invite contacts to their roster           | `true`                                    |












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    51














2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    52


The `allow_user_invites` option should be set as desired. However it is












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    53


strongly recommended to leave the other option (`allow_contact_invites`)












2b6918714792
mod_invites_adhoc: New module to allow invite creation via ad-hoc commands (XEP-0401)



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    54


at its default to provide the best user experience.














prosody-modules