diff --git a/README.md b/README.md index ebcb3b9..e418abe 100644 --- a/README.md +++ b/README.md @@ -16,87 +16,13 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## 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"](https://docs.mau.fi/bridges/python/signal/index.html) bridge consists in a Synapse App Service and relies on postgresql (mysql also possible). Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand. +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"](https://docs.mau.fi/bridges/python/signal/index.html) bridge consists in a Synapse App Service and relies on postgresql (mysql also possible). Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand. **Shipped version:** 0.4.3~ynh1 -## Disclaimers / important information - -## List of known public services - -* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #signal:maunium.net - -## Bridging usage -** Note that several Signal and Matrix users can be bridged, each Signal account has its own bot administration room. If they are in a same Signal group, only one matrix room will be created. ** - -### Bridge a Signal user and a Matrix user -* First your Matrix user or Synapse Server has to be authorized in the Configuration of the bridge (see below) -* Then, invite the bot (default @signalbot:yoursynapse.domain) in this new Mautrix-Signal bot administration room. - * If the Bot does bot accept, see the [troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html) -* Send ``!sg help`` to the bot in the created room to know how to control the bot. -See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html) - -#### Linking the Bridge as a secondary device -* Type ``!sg link`` -* Open Signal App of your primary device -* Open Settings => Linked Devices => + => Capture the QR code with the camera -* By defaults, only conversations with very recent messages will be bridged -* Accept invitations to the bridged chat rooms - -#### Registering the Bridge as a primary device -* Type ``!sg register ``, where ```` is your phone number in the international format with no space, e.g. ``!sg register +33612345678`` -* Answer in the bot room with the verification code that you reveived in SMS. -* Set a profile name with ``!sg set-profile-name `` - -### Double puppeting -* Log in with ``login-matrix `` -* After logging in, the default Matrix puppet of your Signal account should leave rooms and your account should join all rooms the puppet was in automatically. - - -### Relaybot: Bridge a group for several Matrix and several Signal users to chat together -* Create a room on the signal side -* Your bridged users will be invited on the Matrix side once they are invited on the Signal side -* You can invite more people over on the Matrix side -* Have one of the bridged users (who has the right permission) type `!sg set-relay` on the Matrix side. Their signal account will relay messages from other Matrix users -It is not yet possible to bridge to an existing signal room, or create a new signal room from the Matrix side. - -## Configuration of the bridge - -The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_signal_ynh/blob/master/conf/config.yaml), 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://docs.mau.fi/bridges/python/signal/index.html - * 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](https://gitlab.com/signald/signald) 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. - -## 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) - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 25b4a85..7c3fea1 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,79 +16,14 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Une passerelle entre Matrix et Signal empaquetĂ©e comme un service YunoHost. Les messages, mĂ©dias et notifications sont relayĂ©es entre un compte Signal et un compte Matrix. +Une passerelle entre Matrix et Signal empaquetĂ©e comme un service YunoHost. Les messages, mĂ©dias et notifications sont relayĂ©es entre un compte Signal et un compte Matrix. + La passerelle ["Mautrix-Signal"](https://docs.mau.fi/bridges/python/signal/index.html) consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-donnĂ©es postgresql. C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) doit ĂȘtre prĂ©alablemnet installĂ©. -** Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix-synapse et mautrix_signal en mĂȘme temps!** +**Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix-synapse et mautrix_signal en mĂȘme temps!** **Version incluse :** 0.4.3~ynh1 -## Avertissements / informations importantes - -## Liste de passerelles publiques - -* Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #signal:maunium.net - -## Usages de la passerelle -** Notez que plusieurs comptes Signal et Matrix peuvent ĂȘtre relayĂ©s, chaque compte Signal connectĂ© a son propre Salon d'Administration. Si plusieurs utilisateur.ice.s du Robot sont dans un mĂȘme groupe Signal, seul un Salon Matrix sera crĂ©Ă© par la passerelle. ** - -### Relayer TOUTES les conversations entre UN compte Signal et UN compte Matrix -* PrĂ©requis : votre compte Matrix ou le serveur sur lequel il est hĂ©bergĂ© doit ĂȘtre autorisĂ© dans la configuration de la passerelle (voir ci-dessous) -* Invitez le Robot (par dĂ©faut @signalbot:synapse.votredomaine) Ă  une nouvelle conversation. -* Ce nouveau salon d'administration du Robot Mautrix-Signal est appelĂ© "Administration Room". -* Envoyez ``help`` au Robot dans le "Administration Room" pour une liste des commandes d'administration de la passerelle. -Voir aussi [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html) - -#### Relier la passerelle comme un appareil secondaire -* Tapez ``!sg link`` -* Ouvrez l'application Signal de votre appareil principal -* Ouvrez ParamĂštres => Appareils reliĂ©s => + => filmer le QR -* Par dĂ©faut, seules les conversations avec des messages trĂšs rĂ©cents seront mises-en-miroir -* Acceptez les invitations aux salons - -#### Enregistrer la passerelle comme appareil principal -* Tapez ``!sg register ``, oĂč ```` est votre numĂ©ro de tĂ©lĂ©phone au format international sans espace, p.ex. ``!sg register +33612345678`` -* RĂ©pondez dans le salon d'administration avec le code de vĂ©rification reçu par SMS. -* DĂ©finissez une nom de profil ``!sg set-profile-name `` - -### Robot-Relai "Relaybot": Relayer les conversations de TOUS les comptes Matrix et TOUS les comptes Signal prĂ©sents dans UN groupe/salon -* Pas implĂ©mentĂ© pour l'instant - -## Configuration de la passerelle - -La passerelle est [configurĂ©e avec les paramĂštres standards adaptĂ©s pour votre YunoHost et l'instance Matrix-Synapse sĂ©lectionnĂ©e](https://github.com/YunoHost-Apps/mautrix_signal_ynh/blob/master/conf/config.yaml). Vous pouvez par exemple ajouter des administrateur.ice.s et utilisateur.ice.s du Robot autorisĂ©s en modifiant le fichier de configuration par liaison SSH: -``` sudo nano /opt/yunohost/mautrix_signal/config.yaml``` -puis en redĂ©marrant le service: -``` sudo yunohost service restart mautrix_signal``` - -## Documentation - - * Documentation officielle "Mautrix-Signal": https://docs.mau.fi/bridges/python/signal/index.html - * Salon Matrix sur les Passerelles dans Yunohost): #mautrix_yunohost:matrix.fdn.fr - * Salon Matrix (application principale): #signal:maunium.net -Si vous devez tĂ©lĂ©verser vos fichiers log quelque-part, soyez avertis qu'ils contiennent des informations sur vos contacts et vos numĂ©ros de tĂ©lĂ©phone. Effacez-les avec -``| sed -r 's/[0-9]{10,}/📞/g' `` - * La passerelle "Mautrix-Signal" repose sur l'implĂ©mentation du [daemon signald](https://gitlab.com/signald/signald) . - * Documentation YunoHost: Si une documentation spĂ©cifique est nĂ©cessaire, n'hĂ©sitez pas Ă  contribuer. - -## CaractĂ©ristiques spĂ©cifiques YunoHost - -#### Support multi-comptes -* Les utilisateur.ice.s du Robot ne sont pas liĂ©s aux comptes Yunohost. N'importe quel compte Matrix ou serveur Synapse autorisĂ©s dans la configuration de la passerelle peut inviter/utiliser le Robot. -* Le robot Signal est un utilisateur Matrix-Synapse local, mais accessible via la fĂ©dĂ©ration (Synapse public ou privĂ©). -* Plusieurs comptes Signal et Matrix peuvent ĂȘtre liĂ©s avec une seule passerelle, chaque compte a son propre salon d'administration. -* Si plusieurs utilisateur.ice.s du Robot sont dans un mĂȘme groupe Signal, seul un Salon Matrix sera crĂ©Ă© par la passerelle. Autrement dit, la passerelle construit un seul miroir du rĂ©seau de discussion existant sur Signal (utilisateurs et salons). -* Voir https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support - -#### Support multi-instance - -* L'installation multi-instance devrait fonctionner. Plusieurs instances de passerelles pourraient ĂȘtre installĂ©es pour une instance de Matrix-Synapse. Cela permet Ă  un compte matrix de se relier Ă  plusieurs comptes Signal. -* Plusieurs instances de passerelles pourraient ĂȘtre installĂ©es pour que chaque instance de Matrix-Synapse puisse en bĂ©nĂ©ficier. Mais une passerelle peut ĂȘtre utilisĂ©e par les comptes de plusieurs instances Matrix-Synapse. - -## Limitations - -* Les appels Audio/Video ne sont pas relayĂ©s. Seule une notification apparait. - ## Documentations et ressources * Site officiel de l’app :