mirror of
https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh.git
synced 2024-09-03 19:46:01 +02:00
Merge pull request #126 from YunoHost-Apps/testing
Testing to master [Spanish docs]
This commit is contained in:
Dante
GitHub
commit
d4d65751b2
16 changed files with 180 additions and 44 deletions
49
README_es.md
Normal file
49
README_es.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
<!--
|
||||
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-WhatsApp bridge for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/mautrix_whatsapp)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=mautrix_whatsapp)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Matrix-WhatsApp bridge quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
||||
A puppeting bridge between Matrix and WhatsApp packaged as a YunoHost service.
|
||||
Messages, media and notifications are bridged between a WhatsApp user and a matrix user.
|
||||
With the RelayBot login option, the matrix user can invite other matrix user in a bridged WhatsApp room, such that even people without a WhatsApp account can participate to WhatsApp group conversations.
|
||||
The ["Mautrix-WhatsApp"](https://docs.mau.fi/bridges/go/whatsapp/index.html) bridge consists in a synapse app service and relies on postgresql (mysql also available).
|
||||
Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand.
|
||||
|
||||
** Attention: always backup and restore the Yunohost matrix_synapse et mautrix_whatsapp apps together!**
|
||||
|
||||
|
||||
**Shipped version:** 0.10.4~ynh1
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: <https://maunium.net/go/mautrix-whatsapp/>
|
||||
* Official admin documentation: <https://docs.mau.fi/bridges/go/whatsapp/index.html>
|
||||
* Upstream app code repository: <https://github.com/mautrix/whatsapp>
|
||||
* YunoHost Store: <https://apps.yunohost.org/app/mautrix_whatsapp>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/issues>
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade mautrix_whatsapp -u https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
@ -18,7 +18,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
|
|||
|
||||
Une passerelle entre Matrix et WhatsApp empaquetée comme un service YunoHost.
|
||||
Les messages, médias et notifications sont relayées entre un compte WhatsApp et un compte Matrix.
|
||||
Avec l'option de connexion Robot-Relai, 1 compte Matrix peut inviter d'autres comptes Matrix dans un salon Matrix relayé avec un groupe WhatsApp, ainsi même des personnes sans compte WhatsApp peuvent communiquer avec des utilisateur.ice.s de WhatsApp.
|
||||
Avec l'option de connexion Relaybot, un compte Matrix peut inviter d'autres comptes Matrix dans un salon Matrix relayé avec un groupe WhatsApp, ainsi même des personnes sans compte WhatsApp peuvent communiquer avec des utilisateur.ice.s de WhatsApp.
|
||||
La passerelle ["Mautrix-WhatsApp"](https://docs.mau.fi/bridges/go/whatsapp/index.html) consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-données postgresql (mysql également possible).
|
||||
C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) doit être préalablemnet installé.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
## Configuration of the bridge
|
||||
|
||||
The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/blob/master/conf/config.yaml), e.g. allowed admin and user of the bot.
|
||||
Finer configuration can be done by using the existing config panel in the Yunohost admin panel or by modifying the
|
||||
following configuration file with SSH:
|
||||
|
|
|
|||
14
doc/ADMIN_es.md
Normal file
14
doc/ADMIN_es.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
## Configuración del puente
|
||||
El puente está [configurado a grandes rasgos en la instalación](https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/blob/master/conf/config.yaml), por ejemplo, se permite admin y usuarix del bot.
|
||||
Se puede hacer una configuración más fina usando el panel de configuración existente en el panel de administración de Yunohost o modificando el
|
||||
siguiente archivo de configuración con SSH:
|
||||
```/opt/yunohost/mautrix_whatsapp/config.yaml```
|
||||
y reiniciando el servicio mautrix_whatsapp.
|
||||
|
||||
#### Cifrado de extremo a puente
|
||||
El puente puede cifrar opcionalmente los mensajes entre lxs usuarixs de Matrix y él mismo para ocultar los mensajes del servidor doméstico. Se recomienda encarecidamente el uso de Postgres cuando se utilice el cifrado de extremo a puente.
|
||||
|
||||
Si se desea habilitar, se debe ir a la sección del panel de configuración `Privacidad -> Salas y configuración de cifrado`. Si se activa `¿Permitir la encriptación entre el cliente Matrix y el puente?`, el puente no activará la encriptación por sí mismo, pero funcionará en salas encriptadas.
|
||||
Alternativamente, aparecerán dos opciones más, `Forzar la encriptación en todas las salas que cree el puente`, que habilitará automáticamente la encriptación en las nuevas salas, y `Requerir encriptación`, que forzará la encriptación en cualquiera de los mensajes que envíe (esto hará que el puente elimine cualquier futuro mensaje no encriptado).
|
||||
|
||||
También existe la posibilidad de configurarlo en el fichero YAML de configuración del puente en la sección `bridge: encryption`.
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
### 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_whatsapp_ynh/blob/master/conf/config.yaml).
|
||||
Une configuration plus fine peut être effectuée en utilisant le panneau de configuration existant dans le panneau d'administration de Yunohost ou en modifiant le fichier de configuration suivant avec SSH:
|
||||
``` /opt/yunohost/mautrix_whatsapp/config.yaml```
|
||||
|
|
|
|||
7
doc/DESCRIPTION_es.md
Normal file
7
doc/DESCRIPTION_es.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
Un puente de marionetas entre Matrix y WhatsApp empaquetado como un servicio YunoHost.
|
||||
Mensajes, medios de comunicación y las notificaciones son puenteados entre una cuenta de WhatsApp y una cuenta de Matrix.
|
||||
Con la opción de inicio de sesión RelayBot, una persona de Matrix puede invitar a otra persona de Matrix a una sala de WhatsApp puenteada, de modo que incluso personas sin cuenta de WhatsApp pueden participar en conversaciones de grupo de WhatsApp.
|
||||
El puente ["Mautrix-WhatsApp"](https://docs.mau.fi/bridges/go/whatsapp/index.html) consiste en un servicio de la aplicación Synapse y se basa en Postgresql (Mysql también disponible).
|
||||
Por lo tanto, debe instalarse previamente [Synapse para YunoHost](https://github.com/YunoHost-Apps/synapse_ynh).
|
||||
|
||||
** Atención: haz siempre copias de seguridad y restaura las aplicaciones Yunohost matrix_synapse y mautrix_whatsapp juntas.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
Une passerelle entre Matrix et WhatsApp empaquetée comme un service YunoHost.
|
||||
Les messages, médias et notifications sont relayées entre un compte WhatsApp et un compte Matrix.
|
||||
Avec l'option de connexion Robot-Relai, 1 compte Matrix peut inviter d'autres comptes Matrix dans un salon Matrix relayé avec un groupe WhatsApp, ainsi même des personnes sans compte WhatsApp peuvent communiquer avec des utilisateur.ice.s de WhatsApp.
|
||||
Avec l'option de connexion Relaybot, un compte Matrix peut inviter d'autres comptes Matrix dans un salon Matrix relayé avec un groupe WhatsApp, ainsi même des personnes sans compte WhatsApp peuvent communiquer avec des utilisateur.ice.s de WhatsApp.
|
||||
La passerelle ["Mautrix-WhatsApp"](https://docs.mau.fi/bridges/go/whatsapp/index.html) consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-données postgresql (mysql également possible).
|
||||
C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) doit être préalablemnet installé.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
## Development code quality
|
||||
|
||||
The `.github/workflows/updater.sh` script needs to be synced with changes in `conf/config.yaml` therefore a `pre-commit`
|
||||
hook is used to display a reminder to update `.github/workflows/updater.sh` (if needed) when `conf/config.yaml` has been modified.
|
||||
|
||||
|
|
|
|||
8
doc/DEVELOPMENT_es.md
Normal file
8
doc/DEVELOPMENT_es.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
## Buenas prácticas de desarrollo
|
||||
El script `.github/workflows/updater.sh` necesita estar acorde con los cambios en `conf/config.yaml` por lo que se utiliza un hook `pre-commit`
|
||||
que se utiliza para mostrar un recordatorio para actualizar `.github/workflows/updater.sh` (si es necesario) cuando `conf/config.yaml` ha sido modificado.
|
||||
|
||||
Por favor, es importante activar los hooks Git usando el siguiente comando para asegurar la calidad y estabilidad del código.
|
||||
``` bash
|
||||
git config --local core.hooksPath .githooks
|
||||
```
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
## Development code quality
|
||||
|
||||
Le script `.github/workflows/updater.sh` doit être synchronisé avec les changements dans `conf/config.yaml`,
|
||||
donc un hook `pre-commit` est utilisé pour afficher un rappel pour mettre à jour
|
||||
`.github/workflows/updater.sh` (si nécessaire) lorsque `conf/config.yaml` a été modifié.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
## List of known public services
|
||||
|
||||
* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net
|
||||
|
||||
## Bridging usage
|
||||
|
|
@ -9,29 +8,27 @@
|
|||
* First your matrix user or server has to be authorized in the bridge configuration (see below)
|
||||
* Then, invite the bot (default @whatsappbot:yoursynapse.domain)
|
||||
* The room with the Mautrix-WhatsApp bot is called "administration room".
|
||||
* Type ``login``
|
||||
* Type `login`
|
||||
* Capture the QR code with the camera in the WhatsApp of your VM or smartphone (WhatsApp Web)
|
||||
* Send ``help`` to the bot in the created room to know how to control the bot.
|
||||
* Send `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/go/whatsapp/authentication.html)
|
||||
|
||||
### Bridge an existing room
|
||||
By default, the bridge creates a portal room for each WhatsApp group that the WhatsApp user actively uses.
|
||||
Your can also create a portal for an existing Matrix room. **Note that this can be a room created by another bridge, e.g. a Signal portal room**
|
||||
By default, the bridge creates a room for each WhatsApp group that the WhatsApp user actively uses.
|
||||
Your can also create a portal for an existing Matrix room. **Note that this can be a room created by another bridge, e.g. a Signal room**
|
||||
1. Invite the bridge bot to the room (with an authorized user)
|
||||
2. Type `!wa create`
|
||||
3. Your logged in WA user creates a new corresponding group.
|
||||
4. Get the WA invite link `!wa invite-link` and share it with friends. Or invite WhatsApp puppets to room.
|
||||
3. Your logged-in user creates a new corresponding group.
|
||||
4. Get the invite link `!wa invite-link` and share it with friends. Or invite WhatsApp puppets to room.
|
||||
5. Optional: Activate relaybot, see next section.
|
||||
|
||||
### Relaybot: Bridge a group for several Matrix and several WhatsApp users to chat together
|
||||
|
||||
To be able to bridge not only your logged in Matrix account but also Matrix friends you invite to a portal room, you need to:
|
||||
To be able to bridge not only your logged in Matrix account but also Matrix friends you invite to a room, you need to:
|
||||
1. Enable relaybot setting in the config panel section `Main Settings -> Puppetting Bridge Settings` or in the bridge configuration YAML file `relay: enabled: true`. Also make sure that the users you want to invite have at least the `relay` level in the `permissions` section (this can be configured in the config panel section `Main Settings -> Permissions for using the bridge`).
|
||||
2. Login to your WhatsApp account in the (main) administration room
|
||||
3. Depending on what has been selected during installation this could be done only by admins, but can also be changed in the config panel section `Main Settings -> Puppetting Bridge Settings` or in the bridge configuration YAML file `relay: admin_only`.
|
||||
4. Write `!wa set-relay` in each of the rooms you want to relay to (re-)activate the relaybot function.
|
||||
|
||||
|
||||
* In WhatsApp: all messages will be seen as received from the account who is logged in with a prefix for the source matrix user.
|
||||
* On the matrix side: the bridge will create matrix puppets corresponding to the WhatsApp users when they send a message.
|
||||
* In WhatsApp: all messages will be seen as received from the account who is logged in with a prefix for the source Matrix user.
|
||||
* On the Matrix side: the bridge will create matrix puppets corresponding to the WhatsApp users when they send a message.
|
||||
See also [upstream wiki Relaybot page](https://docs.mau.fi/bridges/general/relay-mode.html)
|
||||
34
doc/POST_INSTALL_es.md
Normal file
34
doc/POST_INSTALL_es.md
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
## Lista de servicios públicos conocidos
|
||||
* Pregunta en una de las siguientes salas #mautrix_yunohost:matrix.fdn.fr o #whatsapp:maunium.net
|
||||
|
||||
## Uso del puente
|
||||
** Ten en cuenta que se pueden puentear varixs usuarixs de WhatsApp y Matrix, cada cuenta de WhatsApp tiene su propia sala de administración de bots. Si están en un mismo grupo de WhatsApp, sólo se creará una sala de Matrix. **
|
||||
|
||||
### Puentear una cuenta de WhatsApp y con otra de Matrix
|
||||
* En primer lugar, el/la usuarix o servidor de Matrix debe estar autorizado en la configuración del puente (véase más abajo).
|
||||
* A continuación, invite al bot (por defecto @whatsappbot:yoursynapse.domain)
|
||||
* La sala con el bot de Mautrix-WhatsApp se llama "Administration Room".
|
||||
* Escribe `login`
|
||||
* Captura el código QR con la cámara del WhatsApp de tu VM o smartphone (WhatsApp Web)
|
||||
* Envía `help` al bot en la sala creada para saber cómo controlarlo.
|
||||
Ver también [upstream wiki Authentication page](https://docs.mau.fi/bridges/go/whatsapp/authentication.html)
|
||||
|
||||
### Puentear una sala existente
|
||||
Por defecto, el puente crea una sala para cada grupo de WhatsApp que el/la usuarix de WhatsApp utiliza activamente.
|
||||
También puede crear una sala de Matrix existente. **Tenga en cuenta que puede tratarse de una sala creada por otro puente, por ejemplo, una sala de Signal**.
|
||||
1. Invita al bot del puente a la sala (con una cuenta autorizada).
|
||||
2. Escriba `!wa create`.
|
||||
3. Tu usuarix conectadx crea un nuevo grupo correspondiente.
|
||||
4. Obtén el enlace de invitación `!wa invite-link` y compártelo con tus amigxs o invita a las marionetas de WhatsApp a la sala.
|
||||
5. Opcional: Activar relaybot, ver siguiente sección.
|
||||
|
||||
### Relaybot: Puentea un grupo para que varixs usuarixs de Matrix y varixs usuarixs de WhatsApp chateen juntxs.
|
||||
Para poder hacer puente no sólo con tu cuenta de Matrix conectada sino también con los amigxs de Matrix que invites a una sala, necesitas:
|
||||
1. Habilitar la configuración de Relaybot en la sección del panel de configuración `Configuración principal -> Configuración del puente de marionetas` o en el archivo YAML de configuración del puente `relay: enabled: true`. También asegúrate de que lxs usuarixs que quieres invitar tienen al menos el nivel `relay` en la sección `permissions` (esto también se puede configurar en la sección del panel de configuración `Main Settings -> Permissions for using the bridge`).
|
||||
2. Accede a tu cuenta de WhatsApp en la sala de administración.
|
||||
3. Dependiendo de lo que se haya seleccionado durante la instalación, esto podrían hacerlo solo lxs administradorxs, pero también se puede cambiar en la sección del panel de configuración `Main Settings -> Puppetting Bridge Settings` o en el archivo YAML de configuración del puente `relay: admin_only`.
|
||||
4. Escribe `!wa set-relay` en cada una de las salas que quieras retransmitir para (re)activar la función Relaybot.
|
||||
|
||||
* En WhatsApp: todos los mensajes se verán como recibidos de la cuenta que ha iniciado sesión con un prefijo para el/la usuarix de Matrix de origen.
|
||||
* En el lado de Matrix: el puente creará marionetas de Matrix correspondientes a lxs usuarixs de WhatsApp cuando envíen un mensaje.
|
||||
Véase también [upstream wiki Relaybot page](https://docs.mau.fi/bridges/general/relay-mode.html)
|
||||
|
|
@ -1,24 +1,32 @@
|
|||
## Liste de passerelles publiques
|
||||
|
||||
* Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net
|
||||
|
||||
## Usages de la passerelle
|
||||
** Notez que plusieurs comptes WhatsApp et Matrix peuvent être relayés, chaque compte WhatsApp connecté a son propre Salon d'Administration. Si plusieurs utilisateur.ice.s du Robot sont dans un même groupe WhatsApp, seul un Salon Matrix sera créé par la passerelle. **
|
||||
** Notez que plusieurs comptes WhatsApp et Matrix peuvent être relayés, chaque compte WhatsApp connecté a son propre salle d'Administration. Si plusieurs utilisateur.ice.s du Robot sont dans un même groupe WhatsApp, seul une salle Matrix sera créé par la passerelle. **
|
||||
|
||||
### Relayer TOUTES les conversations entre UN compte WhatsApp 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 @whatsappbot:synapse.votredomaine) à une nouvelle conversation.
|
||||
* Ce nouveau salon d'administration du Robot Mautrix-WhatsApp est appelé "Administration Room".
|
||||
* Tapez ``login``
|
||||
* Cette nouveau salle d'administration du Robot Mautrix-WhatsApp est appelé "Administration Room".
|
||||
* Tapez `login`
|
||||
* Scannez le QR-code avec la caméra Whatsapp de votre Machine Virtuelle ou ordiphone (option WhatsApp Web dans l'appli)
|
||||
* Envoyez ``help`` au Robot dans le "Administration Room" pour une liste des commandes d'administration de la passerelle.
|
||||
* 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/go/whatsapp/authentication.html)
|
||||
|
||||
### Robot-Relai "Relaybot": Relayer les conversations de TOUS les comptes Matrix et TOUS les comptes WhatsApp présents dans UN groupe/salon
|
||||
### Passerelle vers une conversation existante
|
||||
Par défaut, la passerelle crée une salle pour chaque groupe WhatsApp que l'utilisateur WhatsApp utilise activement.
|
||||
Vous pouvez également créer un portail pour une salle Matrix existante. **Notez qu'il peut s'agir d'une salle créée par une autre passerelle, par exemple une salle de portail Signal.
|
||||
1. Invitez le bot de la passerelle dans la salle (avec un utilisateur autorisé).
|
||||
2. Tapez `!wa create`
|
||||
3. Votre utilisateur connecté crée un nouveau groupe correspondant.
|
||||
4. Obtenez le lien d'invitation `!wa invite-link` et partagez-le avec vos amis. Ou invitez les marionnettes WhatsApp dans la pièce.
|
||||
5. Facultatif : Activez le relaybot, voir la section suivante.
|
||||
|
||||
### Relaybot: Relayer les conversations de TOUS les comptes Matrix et TOUS les comptes WhatsApp présents dans UN groupe/salle
|
||||
1. Activer l'option `Should Relay Mode be allowed?` dans le panneau de configuration (section `Main Settings -> Puppetting Bridge Settings`) ou dans le fichier YAML de configuration du robot `relay: enabled: true`. Assurez-vous également que les utilisateurs que vous voulez inviter ont au moins le niveau `relay` dans la section `permissions` (ceci peut être configuré dans la section `Main Settings -> Permissions for using the bridge` du panneau de configuration).
|
||||
2. Connectez-vous à votre compte WhatsApp dans la salle d'administration.
|
||||
2. En fonction de ce qui a été sélectionné lors de l'installation, cela peut être fait uniquement par les administrateurs, mais peut également être modifié dans la section `Main Settings -> Puppetting Bridge Settings` du panneau de configuration ou dans le fichier YAML de configuration du robot `relay: admin_only`
|
||||
3. Ecrivez `!wa set-relay` dans chacune des pièces que vous voulez relayer pour (ré)activer la fonction de relaybot.
|
||||
|
||||
* Vous pouvez maintenant relayer un groupe WhatsApp en y invitant le numéro de téléphone du compte WhatsApp connecté au RobotRelai. Côté WhatsApp, tous les messages venant de Matrix seront vus comme envoyés depuis le compte WhatsApp connecté, avec un préfix indiquant le compte Matrix correspondant. Côté Matrix, la passerelle va créer des comptes Matrix pour chaque compte WhatsApp présent dans le groupe relayé. Les messages sont indiqués comme provenant soit du numéro de téléphone, soit du pseudo WhatsApp.
|
||||
Voir aussi [la page wiki principale sur le Robot-Relai](https://docs.mau.fi/bridges/go/whatsapp/relaybot.html)
|
||||
* Vous pouvez maintenant relayer un groupe WhatsApp en y invitant le numéro de téléphone du compte WhatsApp connecté au Relaybot. Côté WhatsApp, tous les messages venant de Matrix seront vus comme envoyés depuis le compte WhatsApp connecté, avec un préfix indiquant le compte Matrix correspondant. Côté Matrix, la passerelle va créer des comptes Matrix pour chaque compte WhatsApp présent dans le groupe relayé. Les messages sont indiqués comme provenant soit du numéro de téléphone, soit du pseudo WhatsApp.
|
||||
Voir aussi [la page wiki principale sur le Relaybot](https://docs.mau.fi/bridges/go/whatsapp/relaybot.html)
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
## 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 WhatsApp bot is a local Matrix-Synapse user, but accessible through federation (synapse public or private).
|
||||
* Several WhatsApp and Matrix users can be bridged with one bridge, each user has its own bot administration room.
|
||||
|
|
@ -7,27 +6,24 @@
|
|||
* See https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
|
||||
|
||||
## Limitations
|
||||
|
||||
* Audio/Video calls are not bridged yet.
|
||||
* If WhatsApp loses connection, e.g. the phone is set in flight mode or push notifications are deactivated, the bot has sometimes to be restarted manually by sending a reconnnect message in the matrix administration room.
|
||||
* If WhatsApp loses connection, e.g. the phone is set in flight mode or push notifications are deactivated, the bot has sometimes to be restarted manually by sending `!wa reconnnect` in the Matrix administration room.
|
||||
* WhatsApp needs to get presence from the official app every two weeks at least, so bridge will send a reminder in the administration room.
|
||||
|
||||
## Additional information
|
||||
|
||||
* It is recommended to install WhatsApp on a virtual android running on a server, see [upstream wiki Android-VM-Setup page](https://docs.mau.fi/bridges/go/whatsapp/android-vm-setup.html)
|
||||
**More information on the documentation page:**
|
||||
https://docs.mau.fi/bridges/go/whatsapp/index.html
|
||||
|
||||
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:
|
||||
* 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
|
||||
```
|
||||
|
||||
## Miscellaneous information
|
||||
|
||||
* Matrix room (matrix bridges in YunoHost): #mautrix_yunohost:matrix.fdn.fr
|
||||
* Matrix room (upstream app): #whatsapp: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' ``
|
||||
* "Mautrix-WhatsApp" bridge is based on the [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) implementation of the [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) project.
|
||||
29
doc/PRE_INSTALL_es.md
Normal file
29
doc/PRE_INSTALL_es.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
## Soporte multiusuarix
|
||||
* Lxs usuarixs del bot no están relacionadxs con lxs usuarixs de Yunohost. Cualquier cuenta Matrix o servidor Synapse autorizado en la configuración del puente puede invitar/usar el bot.
|
||||
* El bot de WhatsApp es un usuarix local Matrix-Synapse, pero accesible a través de federación (synapse público o privado).
|
||||
* Varios usuarixs de WhatsApp y Matrix pueden ser puenteadxs con un puente, cada usuarix tiene su propia sala de administración bot.
|
||||
* Si varixs usuarixs bot están en un mismo grupo de WhatsApp, el puente sólo creará una sala de Matrix.
|
||||
* Véase https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
|
||||
|
||||
## Limitaciones
|
||||
* Las llamadas de audio/vídeo aún no están conectadas. Solo aparece una notificación.
|
||||
* Si WhatsApp pierde la conexión, por ejemplo, si el teléfono se pone en modo de vuelo o se desactivan las notificaciones push, a veces hay que reiniciar el bot manualmente enviando `!wa reconnnect` en la sala de administración de Matrix.
|
||||
* WhatsApp necesita obtener presencia de la app oficial cada dos semanas como mínimo, por lo que el puente enviará un recordatorio en la sala de administración.
|
||||
|
||||
## Información adicional
|
||||
* Se recomienda instalar WhatsApp en Android dentro de una máquina virtual que se ejecute en un servidor, consulte [wiki Android-VM-Setup page](https://docs.mau.fi/bridges/go/whatsapp/android-vm-setup.html)
|
||||
**Más información en la página de documentación:**
|
||||
https://docs.mau.fi/bridges/go/whatsapp/index.html
|
||||
|
||||
* Para probar la comunicación entre el App Service y Matrix-Synapse en una máquina virtual (por ejemplo, con nombre de dominio: synapse.vm), se debe instalar un certificado:
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
## Informaciones diversas
|
||||
* Sala de Matrix (puentes de Matrix en YunoHost): #mautrix_yunohost:matrix.fdn.fr
|
||||
* Sala de Matrix (aplicación original): #mautrix_yunohost:matrix.fdn.fr
|
||||
En caso de que necesites subir tus logs a algún sitio, ten en cuenta que contienen tus contactos y sus números de teléfono. Elimínalos con:
|
||||
``| sed -r 's/[0-9]{10,}/📞/g' ``
|
||||
* El puente "Mautrix-WhatsApp" está basado en la implementación [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) del proyecto [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng).
|
||||
|
|
@ -1,31 +1,29 @@
|
|||
## 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 WhatsApp est un utilisateur Matrix-Synapse local, mais accessible via la fédération (Synapse public ou privé).
|
||||
* Le robot WhatsApp est un utilisateur.ice.s Matrix-Synapse local, mais accessible via la fédération (Synapse public ou privé).
|
||||
* Plusieurs comptes WhatsApp 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 WhatsApp, seul un Salon Matrix sera créé par la passerelle. Autrement dit, la passerelle construit un seul miroir du réseau de discussion existant sur WhatsApp (utilisateurs et salons).
|
||||
* Si plusieurs utilisateur.ice.s du Robot sont dans un même groupe WhatsApp, seul une salle de Matrix sera créé par la passerelle. Autrement dit, la passerelle construit un seul miroir du réseau de discussion existant sur WhatsApp (utilisateur.ice.s et salles).
|
||||
* Voir https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
|
||||
|
||||
## Limitations
|
||||
|
||||
* Les appels Audio/Video ne sont pas relayés. Seule une notification apparait.
|
||||
* Si WhatsApp perd la connexion, par ex. l'ordiphone est mis en mode avion ou les notifications poussées sont désactivées, le robot doit parfois être redémarré à la main en envoyant un message ``wa !reconnnect`` dans le salon d'administration.
|
||||
* Si WhatsApp perd la connexion, par ex. l'ordiphone est mis en mode avion ou les notifications poussées sont désactivées, le robot doit parfois être redémarré à la main en envoyant un message `!wa reconnnect` dans le salon d'administration.
|
||||
* WhatsApp doit obtenir la présence de l'application officielle toutes les deux semaines au moins, c'est pourquoi le robot enverra un rappel dans la salle d'administration.
|
||||
|
||||
## Informations additionnelles
|
||||
|
||||
* Il est recommandé d'installer WhatsApp sur une machine Android virtuelle tournant sur un serveur, cf. le [page Android-VM-Setup du wiki](https://docs.mau.fi/bridges/go/whatsapp/android-vm-setup.html)
|
||||
**Plus d'informations sur la page de documentation:**
|
||||
https://docs.mau.fi/bridges/go/whatsapp/index.html
|
||||
|
||||
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:
|
||||
* 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
|
||||
```
|
||||
|
||||
## Informations diverses
|
||||
|
||||
* Salon Matrix sur les Passerelles dans Yunohost): #mautrix_yunohost:matrix.fdn.fr
|
||||
* Salon Matrix (application principale): #whatsapp: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
|
||||
* Salle Matrix sur les Passerelles dans Yunohost: #mautrix_yunohost:matrix.fdn.fr
|
||||
* Salle Matrix (application principale): #whatsapp: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-WhatsApp" repose sur l'implémentation [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) du projet [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng).
|
||||
Loading…
Add table
Reference in a new issue