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

And start slidgram with:

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

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

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

name	default	help
api-hash	None	Telegram app api_hash, obtained at https://my.telegram.org/apps If you dont set it, users will have to enter their own on registration.
api-id	None	Telegram app api_id, obtained at https://my.telegram.org/apps If you dont set it, users will have to enter their own on registration.
attachment-max-size	10485760	Maximum file size (in bytes) to download from telegram automatically/
big-avatars	False	Fetch contact avatars in high-resolution (640x640) instead of the default 160x160. NB: slidge core main config AVATAR_SIZE still applies.
convert-stickers	True	Convert incoming animated stickers to webm videos. Requires lottie_to_webm.sh in $PATH, cf <https://github.com/ed-asriyan/lottie-converter>, along with FFMPEG.
convert-stickers-executable	lottie_to_webm.sh	Path to the TGS/webm converter executable.
convert-stickers-fps	60	Framerate of the video stickers
convert-stickers-size	128	Width and height video stickers.
group-history-maximum-messages	50	The number of messages to fetch from a group history. These messages and their attachments will be fetched on slidge startup.
registration-auth-code-timeout	60	On registration, users will be prompted for a 2FA code they receive on other telegram clients.