Go bridge setup
Please select a bridge above. If you don't select a bridge, you'll have to
manually replace occurrences of
$bridge with the correct name before running
The Slack bridge should be mostly functional, but it is still in early development and therefore will have bugs and may get breaking changes.
This page contains instructions for setting up the bridge by running the executable yourself. You may also want to look at the other ways to run the bridge:
- YunoHost: mautrix_whatsapp_ynh
- systemd service (at the bottom of this page)
Please note that everything in these docs are meant for server admins who want to self-host the bridge. If you're just looking to use the bridges, check out Beeper, which provides fully managed instances of all of these bridges.
If you need help with setting up the bridge, you can ask in the Matrix room: #$bridge:maunium.net. For help with setting up other parts like the homeserver that aren't the bridge, refer to their documentation to find support rooms.
- A Matrix homeserver that supports application services (e.g. Synapse). You need access to register an appservice, which usually involves editing the homeserver config file.
- A PostgreSQL server, v10 or higher (which you should already have for Synapse).
- Make sure you don't share databases between unrelated programs. Shared postgres instance is fine, but shared database is not.
- mautrix-whatsapp: A WhatsApp client running on a phone (both physical and virtual phones work).
- mautrix-whatsapp: ffmpeg (if you want to send gifs from Matrix).
If you want to compile the bridge manually (which is not required), you'll also need:
- Go 1.19+ (download & installation instructions at https://go.dev/doc/install).
- libolm3 with dev headers and a C/C++ compiler (if you want end-to-bridge encryption).
You may either compile the bridge manually or download a prebuilt executable from the mau.dev CI or GitHub releases. Prebuilt executables are the simplest option, as they don't require having Go nor libolm installed.
Downloading a prebuilt executable from CI
- Go to https://mau.dev/mautrix/$bridge/pipelines?scope=branches&page=1
- Find the entry for the
masterbranch, click the download button on the right-hand side in the list and choose the architecture you want.
- Extract the downloaded zip file into a new directory.
Downloading a release
- Go to https://github.com/mautrix/$bridge/releases
- Download the binary for the architecture you want and save it in a new directory.
- Clone the repo with
git clone https://github.com/mautrix/$bridge.git mautrix-$bridge
- Enter the directory (
./build.shto fetch Go dependencies and compile (
build.shwill simply call
go buildwith some additional flags).
- If you want end-to-bridge encryption, make sure you have a C/C++ compiler
and the Olm dev headers (
libolm-devon debian-based distros) installed. Note that libolm3 is required, which means you have to use backports on Debian stable.
- If not, use
./build.sh -tags nocryptoto disable encryption.
- If you want end-to-bridge encryption, make sure you have a C/C++ compiler and the Olm dev headers (
Configuring and running
- Update the config to your liking. You'll at least need to change the homeserver settings, database address, and bridge permissions. If you miss something that's required, the bridge will refuse to start and tell you what's missing.
- Generate the appservice registration file by running
- You can use the
-rflags to change the location of the config and registration files. They default to
- You can use the
- Register the bridge on your homeserver (see Registering appservices).
- Run the bridge with
If you compiled manually, pull changes with
git pull and recompile with
If you downloaded a prebuilt executable, simply download a new one and replace the old one.
Finally, start the bridge again.
- Create a user for the bridge:
$ sudo adduser --system mautrix-$bridge --home /opt/mautrix-$bridge
- Follow the normal setup instructions above. Make sure you use that user and home directory for the bridge.
- Create a systemd service file at
[Unit] Description=mautrix-$bridge bridge [Service] Type=exec User=mautrix-$bridge WorkingDirectory=/opt/mautrix-$bridge ExecStart=/opt/mautrix-$bridge/mautrix-$bridge Restart=on-failure RestartSec=30s # Optional hardening to improve security ReadWritePaths=/opt/mautrix-$bridge NoNewPrivileges=yes MemoryDenyWriteExecute=true PrivateDevices=yes PrivateTmp=yes ProtectHome=yes ProtectSystem=strict ProtectControlGroups=true RestrictSUIDSGID=true RestrictRealtime=true LockPersonality=true ProtectKernelLogs=true ProtectKernelTunables=true ProtectHostname=true ProtectKernelModules=true PrivateUsers=true ProtectClock=true SystemCallArchitectures=native SystemCallErrorNumber=EPERM SystemCallFilter=@system-service [Install] WantedBy=multi-user.target