mirror of
https://github.com/YunoHost-Apps/mautrix_signal_ynh.git
synced 2024-09-03 19:46:07 +02:00
Fix doc
This commit is contained in:
parent
82dc091dbd
commit
f62934acef
4 changed files with 56 additions and 41 deletions
|
|
@ -1,11 +1,13 @@
|
||||||
## List of known public services
|
## List of known public services
|
||||||
|
|
||||||
* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #signal:maunium.net
|
* Ask on one of the following rooms: `#mautrix_yunohost:matrix.fdn.fr` or `#signal:maunium.net`
|
||||||
|
|
||||||
## Bridging usage
|
## 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. **
|
|
||||||
|
**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
|
### 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)
|
* 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.
|
* 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)
|
* If the Bot does bot accept, see the [troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html)
|
||||||
|
|
@ -13,6 +15,7 @@
|
||||||
See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html)
|
See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html)
|
||||||
|
|
||||||
#### Linking the Bridge as a secondary device
|
#### Linking the Bridge as a secondary device
|
||||||
|
|
||||||
* Type ``!sg link``
|
* Type ``!sg link``
|
||||||
* Open Signal App of your primary device
|
* Open Signal App of your primary device
|
||||||
* Open Settings => Linked Devices => + => Capture the QR code with the camera
|
* Open Settings => Linked Devices => + => Capture the QR code with the camera
|
||||||
|
|
@ -20,16 +23,18 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/
|
||||||
* Accept invitations to the bridged chat rooms
|
* Accept invitations to the bridged chat rooms
|
||||||
|
|
||||||
#### Registering the Bridge as a primary device
|
#### Registering the Bridge as a primary device
|
||||||
|
|
||||||
* Type ``!sg register <phone>``, where ``<phone>`` is your phone number in the international format with no space, e.g. ``!sg register +33612345678``
|
* Type ``!sg register <phone>``, where ``<phone>`` 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.
|
* Answer in the bot room with the verification code that you reveived in SMS.
|
||||||
* Set a profile name with ``!sg set-profile-name <name>``
|
* Set a profile name with ``!sg set-profile-name <name>``
|
||||||
|
|
||||||
### Double puppeting
|
### Double puppeting
|
||||||
|
|
||||||
* Log in with ``login-matrix <access token>``
|
* Log in with ``login-matrix <access token>``
|
||||||
* 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.
|
* 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
|
### Relaybot: Bridge a group for several Matrix and several Signal users to chat together
|
||||||
|
|
||||||
* Create a room on the signal side
|
* 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
|
* 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
|
* You can invite more people over on the Matrix side
|
||||||
|
|
@ -39,36 +44,36 @@ It is not yet possible to bridge to an existing signal room, or create a new sig
|
||||||
## Configuration of the bridge
|
## 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
|
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:
|
following configuration file with SSH:
|
||||||
```/opt/yunohost/mautrix_signal/config.yaml```
|
```/opt/yunohost/mautrix_signal/config.yaml```
|
||||||
and then restarting the mautrix_signal service.
|
and then restarting the mautrix_signal service.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* Official "Mautrix-Signal" documentation: https://docs.mau.fi/bridges/python/signal/index.html
|
* 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 (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr
|
||||||
* Matrix room (upstream app): #signal:maunium.net
|
* 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
|
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' ``
|
```| sed -r 's/[0-9]{10,}/📞/g'```
|
||||||
* "Mautrix-Signal" bridge is based on the [signal daemon](https://gitlab.com/signald/signald) project.
|
* "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 documentation: If more specific documentation is needed, feel free to contribute.
|
||||||
|
|
||||||
## YunoHost specific features
|
## YunoHost specific features
|
||||||
|
|
||||||
#### Multi-user support
|
### 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.
|
* 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).
|
* 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.
|
* 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.
|
* 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
|
* See <https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support>
|
||||||
|
|
||||||
#### Multi-instance 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.
|
* 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.
|
* 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
|
## Limitations
|
||||||
|
|
||||||
* It looks like media are not bridged.
|
* 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)
|
* Signal chats are not grouped in a Matrix community (as opposed to the Mautrix-WhatsApp or Mautrix-Facebook bridges)
|
||||||
|
|
@ -1,11 +1,13 @@
|
||||||
## Liste de passerelles publiques
|
## Liste de passerelles publiques
|
||||||
|
|
||||||
* Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #signal:maunium.net
|
* Demandez sur un des salons suivants: `#mautrix_yunohost:matrix.fdn.fr` or `#signal:maunium.net`
|
||||||
|
|
||||||
## Usages de la passerelle
|
## 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. **
|
|
||||||
|
**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
|
### 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)
|
* 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.
|
* 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".
|
* Ce nouveau salon d'administration du Robot Mautrix-Signal est appelé "Administration Room".
|
||||||
|
|
@ -13,6 +15,7 @@
|
||||||
Voir aussi [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html)
|
Voir aussi [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html)
|
||||||
|
|
||||||
#### Relier la passerelle comme un appareil secondaire
|
#### Relier la passerelle comme un appareil secondaire
|
||||||
|
|
||||||
* Tapez ``!sg link``
|
* Tapez ``!sg link``
|
||||||
* Ouvrez l'application Signal de votre appareil principal
|
* Ouvrez l'application Signal de votre appareil principal
|
||||||
* Ouvrez Paramètres => Appareils reliés => + => filmer le QR
|
* Ouvrez Paramètres => Appareils reliés => + => filmer le QR
|
||||||
|
|
@ -20,44 +23,47 @@ Voir aussi [upstream wiki Authentication page](https://docs.mau.fi/bridges/pytho
|
||||||
* Acceptez les invitations aux salons
|
* Acceptez les invitations aux salons
|
||||||
|
|
||||||
#### Enregistrer la passerelle comme appareil principal
|
#### 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``
|
* 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.
|
* 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>``
|
* 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
|
### 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
|
* Pas implémenté pour l'instant
|
||||||
|
|
||||||
## Configuration de la passerelle
|
## 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:
|
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```
|
```sudo nano /opt/yunohost/mautrix_signal/config.yaml```
|
||||||
puis en redémarrant le service:
|
puis en redémarrant le service:
|
||||||
``` sudo yunohost service restart mautrix_signal```
|
```sudo yunohost service restart mautrix_signal```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* Documentation officielle "Mautrix-Signal": https://docs.mau.fi/bridges/python/signal/index.html
|
* 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 sur les Passerelles dans Yunohost): #mautrix_yunohost:matrix.fdn.fr
|
||||||
* Salon Matrix (application principale): #signal:maunium.net
|
* 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
|
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' ``
|
```| sed -r 's/[0-9]{10,}/📞/g'```
|
||||||
* La passerelle "Mautrix-Signal" repose sur l'implémentation du [daemon signald](https://gitlab.com/signald/signald) .
|
* 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.
|
* Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
||||||
|
|
||||||
## Caractéristiques spécifiques YunoHost
|
## Caractéristiques spécifiques YunoHost
|
||||||
|
|
||||||
#### Support multi-comptes
|
### 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.
|
|
||||||
|
* 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é).
|
* 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.
|
* 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).
|
* 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
|
* Voir <https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support>
|
||||||
|
|
||||||
#### Support multi-instance
|
### 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.
|
* 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.
|
* 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
|
## Limitations
|
||||||
|
|
||||||
* Les appels Audio/Video ne sont pas relayés. Seule une notification apparait.
|
* Les appels Audio/Video ne sont pas relayés. Seule une notification apparait.
|
||||||
|
|
@ -1 +1,4 @@
|
||||||
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.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
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é.
|
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!**
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue