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

And start slidgnal with:

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

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

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

name	default	help
db-params	?_txlock=immediate&_foreign_keys=true&_journal_mode=WAL	Additional parameters to pass to database connection string.
db-path	None	The path to the database used for the Signal plugin. Default to ${SLIDGE_HOME_DIR}/slidgnal/signal.db