Skip to content
Back to top
View this page
Edit this page

# 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/matridge  # 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

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

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

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

    matridge --help

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

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

## Distribution packages

matridge is available in the official repositories of a few linux distributions.

## Unofficial debian package

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

Follow the instructions in the repository README. In short:

- Configure your XMPP ;

- edit `/etc/slidge/conf.d/common.conf`;

- edit `/etc/slidge/matrix.conf`;

- run `sudo systemctl start slidge@matrix`;

- watch the logs with `sudo journalctl -u slidge@matrix -f`.