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
|
# matridge
A
[feature-rich](https://slidge.im/docs/matridge/main/user/features.html)
[Matrix](https://matrix.org) to
[XMPP](https://xmpp.org/) puppeteering
[gateway](https://xmpp.org/extensions/xep-0100.html), based on
[slidge](https://slidge.im) and
[nio](https://matrix-nio.readthedocs.io/).
[](https://ci.codeberg.org/repos/14069)
[](https://slidge.im/xmpp-web/#/guest?join=support@rooms.slidge.im)
[](https://pypi.org/project/matridge/)
[](https://repology.org/project/slidge-matridge/versions)
matridge lets you chat with users of Matrix without leaving your favorite XMPP client.
## Quickstart
```sh
docker run -v /somewhere/writeable:/var/lib/slidge \ # for data persistence
--network=host \ # easiest setup to reach your XMPP server
codeberg.org/slidge/matridge:latest \
--jid matrix.example.org \ # can be whatever you want it to be
--secret some-secret # must match your XMPP server config
```
Use the `:latest` tag for the latest release, `:vX.X.X` for release X.X.X, and `:main`
for the bleeding edge.
If you do not like containers, other installation methods are detailed
[in the docs](https://slidge.im/docs/matridge/main/admin/install.html).
## Documentation
Hosted on [codeberg pages](https://slidge.im/docs/matridge/main/).
## Contributing
Contributions are **very** welcome, and we tried our best to make it easy
to start hacking on matridge. See [CONTRIBUTING.md](./CONTRIBUTING.md).
|