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 "matridge.example.org"
    component_secret = "secret"

And start matridge with:

matridge \
  --jid matridge.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 Matrix, and setup matridge as a privileged component for better UX.

matridge-specific config

All generic slidge configuration options apply. matridge provides these additional component-wide options:

MAX_HISTORY_FETCH	Number of events to fetch to back-fill MUC history before slidge starts up.
MAX_PARTICIPANTS_FETCH	Number of participants to fetch when joining a group. Higher values will make joining slower, and participants will appear when they speak or if they spoke in the back-filled events. Participants with power levels > 50 (ie, admins) will be fetched.
NIO_VERBOSE	Set this to True to respect the global log level from the matrix lib. It's REALLY verbose, so the default is to use WARNING.
PARSE_MESSAGE_STYLING	Convert Message Styling (XEP-0393) message bodies to Matrix custom HTML. Supported markup: _underline_ *bold* ~strikethrough~ `code span` ```code block``` >quote ||spoiler \_escape style_
REACTION_CACHE_SIZE	Emoji reaction cache size, in number of messages