Installation

Containers

A container is built on every push to the git repository and uploaded to the codeberg package registry.

docker run codeberg.org/slidge/slidgram  # works with podman too

Use the :latest tag for the latest release, :vX.X.X for release X.X.X, and :main for the bleeding edge.

Python packages

PyPI package version

slidgram is available on the python package index (PyPI).

If you are not familiar with python packaging, we recommend using pipx to set up slidgram and its dependencies, isolated from the rest of your system.

# for the latest stable release published to PyPI, if any
pipx install slidgram

slidgram --help

Bleeding edge versions are also available on codeberg’s python index.

# for the bleeding edge
pipx install slidgram \
    --pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/ --pre'

NetBSD-specific instructions

It is possible to install slidgram on bare metal or in a sandbox.

First, install the necessary build dependencies:

pkgin install py313-pip py313-setuptools py313-setuptools-rust py313-wheel rust rust-bin gcc14

Then, optionally, install the dependencies available with pkgin:

pkgin install py313-uvloop py313-aiohttp py313-alembic py313-Pillow py313-configargparse py313-defusedxml py313-qrcode py313-sqlalchemy py313-aiohappyeyeballs py313-aiosignal py313-attrs py313-frozenlist py313-multidict py313-propcache py313-yarl py313-aiodns py313-brotli py313-mako py313-greenlet py313-idna py313-cffi

After this, install with pip:

PATH="$PATH:/usr/pkg/gcc14/bin" pip3.13 install slidgram

Unofficial debian package

If you are using debian you might be interested in installing the slidge (unofficial) debian package which bundles slidgram along with other slidge-based XMPP gateways.

Follow the instructions in the repository README. In short:

  • edit /etc/slidge/conf.d/common.conf;

  • edit /etc/slidge/telegram.conf;

  • run sudo systemctl start slidge@telegram;

  • watch the logs with sudo journalctl -u slidge@telegram -f.