ejabberd-contrib/mod_default_contacts
Badlop b3c8d25104 Reword modules documentation to reflect the usage of local configuration files 2022-08-12 10:52:20 +02:00
..
conf Modules that require configuration, provide it commented (#303) 2021-07-07 21:53:44 +02:00
src Add simple mod_doc/0 to prevent warnings; they won't be used anyway 2021-07-06 21:02:29 +02:00
COPYING Import mod_default_contacts 2019-05-14 00:07:23 +02:00
README.md Reword modules documentation to reflect the usage of local configuration files 2022-08-12 10:52:20 +02:00
mod_default_contacts.spec mod_default_contacts: Fix spec file name 2019-05-14 19:25:39 +02:00

README.md

mod_default_contacts - Add roster contact(s) on registration

Description

This module allows for specifying one or more contacts that should be added to the user's roster automatically on successful registration (via mod_register, or, for example, ejabberdctl register). Note that no presence subscription is performed, and the rosters of the contacts aren't modified.

Configuration

In order to use this module, add a configuration snippet such as the following:

modules:
  mod_default_contacts:
    contacts:
      -
        name: "Bob Virding"
        jid: "bob@example.com"
      -
        name: "Alice Armstrong"
        jid: "alice@example.com"

The configurable mod_default_contacts options are:

  • contacts (default: [])

    The list of contact JIDs that should be auto-added to the user's roster on account registration. Each list item must specify the jid: and optionally the name: of the contact.