Metadata-Version: 2.4
Name: slidgnal
Version: 0.3.0b11
Summary: A Signal/XMPP gateway
License-Expression: AGPL-3.0-or-later
License-File: LICENSE
Keywords: xmpp,gateway,bridge,instant messaging,chat,signal
Author: deuill
Author-email: alex@deuill.org
Requires-Python: >= 3.11
Classifier: Topic :: Internet :: XMPP
Requires-Dist: slidge (>=0.3.8.dev0,<0.4)
Project-URL: Chat room, https://slidge.im/xmpp-web/#/guest?join=support@rooms.slidge.im
Project-URL: Documentation, https://slidge.im/docs/slidgnal/main
Project-URL: Homepage, https://codeberg.org/slidge/slidgnal
Project-URL: Issues, https://codeberg.org/slidge/slidgnal/issues
Project-URL: Repository, https://codeberg.org/slidge/slidgnal
Project-URL: changelog, https://codeberg.org/slidge/slidgnal/releases
Description-Content-Type: text/markdown

# slidgnal

A
[feature-rich](https://slidge.im/docs/slidgnal/main/user/features.html)
[Signal](https://signal.org) to
[XMPP](https://xmpp.org/) puppeteering
[gateway](https://xmpp.org/extensions/xep-0100.html), based on
[slidge](https://slidge.im) and
[signalmeow](https://github.com/mautrix/signal/tree/main/pkg/signalmeow).

[![CI pipeline status](https://ci.codeberg.org/api/badges/14065/status.svg)](https://ci.codeberg.org/repos/14065)
[![Chat](https://rooms.slidge.im:5281/muc_badge/support@rooms.slidge.im)](https://slidge.im/xmpp-web/#/guest?join=support@rooms.slidge.im)
[![PyPI package version](https://badge.fury.io/py/slidgnal.svg)](https://pypi.org/project/slidgnal/)



slidgnal lets you chat with users of Signal 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/slidgnal:latest-amd64 \
    --jid signal.example.org \  # can be whatever you want it to be
    --secret some-secret  # must match your XMPP server config
```

Use the `:latest-amd64` tag for the latest release, `:vX.X.X-amd64` for release X.X.X, and `:main-amd64`
for the bleeding edge.`-arm64` images are also available.

If you do not like containers, other installation methods are detailed
[in the docs](https://slidge.im/docs/slidgnal/main/admin/install.html).

## Documentation

Hosted on [codeberg pages](https://slidge.im/docs/slidgnal/main/).

## Contributing

Contributions are **very** welcome, and we tried our best to make it easy
to start hacking on slidgnal. See [CONTRIBUTING.md](./CONTRIBUTING.md).

