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

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

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

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

matteridge --help

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

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

Unofficial debian package

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

Follow the instructions in the repository README; edit /etc/slidge/conf.d/common.conf and /etc/slidge/mattermost.conf; run sudo systemctl start slidge@mattermost; watch the logs with sudo journalctl -u slidge@mattermost -f.