YunoHost-Apps/mautrix_whatsapp_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh.git synced 2024-09-03 19:46:01 +02:00
Code Issues Activity Actions
mautrix_whatsapp_ynh/doc/POST_INSTALL.md
Dante 55061ffff3 Add Spanish docs
2023-12-12 16:51:14 +00:00

2.8 KiB
Raw Permalink Blame History

List of known public services

  • Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net

Bridging usage

** Note that several WhatsApp and Matrix users can be bridged, each WhatsApp account has its own bot administration room. If they are in a same WhatsApp group, only one matrix room will be created. **

Bridge a WhatsApp user and a Matrix user

  • 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
  • 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. See also upstream wiki Authentication page

Bridge an existing 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 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 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. See also upstream wiki Relaybot page