mirror of
https://github.com/YunoHost-Apps/mautrix_signal_ynh.git
synced 2024-09-03 19:46:07 +02:00
9174a1999c
* Upgrade to v0.4.1 * Auto-update README * Update app.src (#66) change facebook to signal Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Thatoo <Thatoo@users.noreply.github.com>
110 lines
7.1 KiB
Markdown
110 lines
7.1 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Matrix Signal bridge pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/mautrix_signal)  
|
||
[](https://install-app.yunohost.org/?app=mautrix_signal)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Matrix Signal bridge rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) 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"](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!**
|
||
|
||
|
||
**Version incluse :** 0.4.1~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 <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](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
|
||
|
||
* Documentation officielle utilisateur : <https://docs.mau.fi/bridges/python/signal/index.html>
|
||
* Dépôt de code officiel de l'app : <https://github.com/mautrix/signal>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_mautrix_signal>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/mautrix_signal_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mautrix_signal_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
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
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|