A Matrix-Signal puppeting bridge for YunoHost

This package allows you to install Mautrix-Signal quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

A puppeting bridge between Matrix and Signal packaged as a YunoHost service. Messages, notifications (and sometimes media) are bridged between a Signal user and a Matrix user. Currently the Matrix user can NOT invite other Matrix user in a bridged Signal room, so only someone with a Signal account can participate to Signal group conversations. The "Mautrix-Signal" bridge consists in a Synapse App Service and relies on postgresql (mysql also possible). Therefore, Synapse for YunoHost should be installed beforehand.

Shipped version: 0.1.0

Screenshots

![](Link to a screenshot of this app.)

List of known public services

Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #signal:maunium.net

Configuration of the bridge

The bridge is roughly configured at installation, e.g. allowed admin and user of the bot. Finer configuration can be done by modifying the following configuration file with SSH: /opt/yunohost/mautrix_signal/config.yaml and then restarting the mautrix_signal service.

Documentation

Official "Mautrix-Signal" documentation: https://github.com/tulir/mautrix-signal/wiki
Matrix room (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr
Matrix room (upstream app): #signal:maunium.net In case you need to upload your logs somewhere, be aware that they contain your contacts' and your phone numbers. Strip them out with | sed -r 's/[0-9]{10,}/📞/g'
"Mautrix-Signal" bridge is based on the signal daemon project.
YunoHost documentation: If more specific documentation is needed, feel free to contribute.

YunoHost specific features

Multi-user support

Bot users are not related to Yunohost users. Any Matrix account or Synapse server autorized in the configuration of the bridge can invite/use the bot.
The Signal bot is a local Matrix-Synapse user, but accessible through federation (synapse public or private).
Several Signal and Matrix users can be bridged with one bridge, each user has its own bot administration room.
If several bot users are in a same Signal group, only one Matrix room will be created by the bridge.
See https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support

Multi-instance support

Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Signal accounts.
Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances.

Supported architectures

x86-64 -
ARMv8-A -

Limitations

It looks like media are not bridged.
Signal chats are not grouped in a Matrix community (as opposed to the Mautrix-WhatsApp or Mautrix-Facebook bridges)

Additional information

Other info you would like to add about this app.

More info on the documentation page:
https://github.com/tulir/mautrix-signal/wiki/

Developer info

Only if you want to use a testing branch for coding, instead of merging directly into master. Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_signal_ynh/tree/testing --debug
or
sudo yunohost app upgrade mautrix_signal -u https://github.com/YunoHost-Apps/mautrix_signal_ynh/tree/testing --debug

To test communication between the App Service and Matrix-Synapse on a VM (e.g. with domain name: synapse.vm), you must install a certificate:

echo | openssl s_client -showcerts -servername synapse.vm -connect synapse.vm:443 2>/dev/null | awk '/-----BEGIN CERTIFICATE-----/, /-----END CERTIFICATE-----/' >> /usr/local/share/ca-certificates/synapse.vm.crt
update-ca-certificates

5.4 KiB Raw Blame History