Configuration

Minimal setup

For a minimal prosody <https://prosody.im> based setup, add these lines at the bottom of /etc/prosody/prosody.cfg.lua:

Component "matteridge.example.org"
    component_secret = "secret"

And start matteridge with:

matteridge \
  --jid matteridge.example.org \
  --secret secret \
  --home-dir /somewhere/writable

Advanced usage

Refer to the slidge admin docs for more advanced setups and examples of configuration for other XMPP servers.

You will probably want to add support for attachments received from Mattermost, and setup matteridge as a privileged component for better UX.

matteridge-specific config

All generic slidge configuration options apply.

matteridge provides the additional component-wide options displayed in the table below. They can be used:

  • in an INI config file by starting matteridge with -c /path/to/file.ini;

  • as command line arguments, prepended with --, e.g., --some-option=value;

  • as environment variables, upper case, prepended with MATTERIDGE_, and with dashes substituted with underscores, e.g., MATTERIDGE_SOME_OPTION=value.

name default help
backfill-posts 30 Number of posts to fetch for channels (before slidge was launched)