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

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 provides the additional component-wide options displayed in the table below. They can be used:

in an INI config file by starting matridge with -c /path/to/file.ini;
as command line arguments, prepended with --, e.g., --some-option=value;
as environment variables, upper case, prepended with MATRIDGE_, and with dashes substituted with underscores, e.g., MATRIDGE_SOME_OPTION=value.

name	default	help
max-history-fetch	100	Number of events to fetch to back-fill MUC history before slidge starts up.
max-participants-fetch	10	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	False	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	True	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	10000	Emoji reaction cache size, in number of messages