1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
.. GENERATED FILE, DO NOT EDIT DIRECTLY
This file is automatically generated using https://codeberg.org/slidge/legacy-module-template/
Its source is at:
https://codeberg.org/slidge/legacy-module-template/src/branch/main/docs/source/admin/install.rst.jinja
Open a pull request for this repository instead, to benefit the documentation of all slidge-based gateways.
Installation
------------
Containers
~~~~~~~~~~
A container is built on every push to the git repository and uploaded to `the codeberg package
registry <https://codeberg.org/slidge/-/packages/container/matridge/latest>`__.
.. code:: sh
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
~~~~~~~~~~~~~~~
.. image:: https://badge.fury.io/py/matridge.svg
:alt: PyPI package version
:target: https://pypi.org/project/matridge/
matridge is available on the `python package index (PyPI) <https://pypi.org/project/matridge/>`__.
If you are not familiar with python packaging, we recommend using `pipx <https://pypa.github.io/pipx/>`__ to
set up matridge and its dependencies, isolated from the rest of your system.
.. code:: sh
# 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 <https://codeberg/slidge/-/packages/pypi/matridge>`_.
.. code:: sh
# 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.
.. image:: https://repology.org/badge/vertical-allrepos/slidge-matridge.svg
:alt: Packaging status
:target: https://repology.org/project/slidge-matridge/versions
Unofficial debian package
~~~~~~~~~~~~~~~~~~~~~~~~~
If you are using debian you might be interested in installing the
`slidge (unofficial) debian
package <https://codeberg.org/slidge/debian>`__ which bundles matridge
along with other slidge-based XMPP gateways.
Follow the instructions in the repository `README <https://codeberg.org/slidge/debian/src/branch/main/README.md>`_. In short:
- :ref:`Configure <setup-component>` 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``.
|
