YunoHost-Apps/mautrix_signal_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mautrix_signal_ynh.git synced 2024-09-03 19:46:07 +02:00
Code Issues Activity Actions
mautrix_signal_ynh/README_fr.md
Gredin67 898c8ffc11
Testing (#2) 
* remove signalctl dependency

* remove --no-install-recommends

* upgrade to 0.1.1 and signald 1.3

* add backup remove restore upgrade

* typo backup log

* same for restore

* set python venv in restore script

* Delete unnecessary files

* Update README.md

* prepare for add to app list

* ynh_add_config in install

* ynh_add_config in upgrade

* Update config.yaml

* Update check_process
2021-06-22 18:28:47 +02:00

7.9 KiB
Raw Blame History

Une passerelle entre Matrix et Signal pour YunoHost

Integration level
Install Mautrix-Signal with YunoHost

Read this readme in english.

Ce package vous permet d'installer Mautrix-Signal rapidement et simplement sur un serveur Yunohost.
Si vous n'avez pas YunoHost, regardez ici pour savoir comment l'installer et en profiter.

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. La passerelle "Mautrix-Signal" consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-données postgresql. C'est pourquoi Synapse for YunoHost doit être préalablemnet installé.

** Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix-synapse et mautrix_signal en même temps!**

Version incluse: 0.1.1

Captures d'écran

![](Lien vers une capture d'écran pour cette application)

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

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 <phone>, où <phone> 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 <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. 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 .
  • 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.

Architectures supportées

  • x86-64b - Build Status
  • ARMv8-A - Build Status

Limitations

  • Les appels Audio/Video ne sont pas relayés. Seule une notification apparait.

Informations additionnelles

Plus d'informations sur la page de documentation:

Liens

Informations pour les développeurs

Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale. Merci de faire vos pull request sur la branche testing.

Pour essayer la branche testing, procédez comme suit.

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

Pour tester la communication entre le Service d'Application et Matrix-Synapse sur une Machine Virtuelle (ex. avec un nom de domaine: synapse.vm), vous devez installer un certificat:

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