4.1 KiB

Raw Permalink Blame History

Bridge setup with Docker

The Signal bridge requires a second docker container for signald. Instructions for setting up everything can be found on the Signal-specific Bridge setup with Docker page

Requirements

Docker
A Matrix homeserver that supports application services (e.g. Synapse)

Setup

Docker images are hosted on dock.mau.dev. Available docker tags are generally :latest, :git tag, :git commit-amd64 and :git commit-arm64. The latest and git tag specific docker tags are manifests that contain both amd64 and arm64 images.

Create a directory for the bridge and cd into it: mkdir mautrix-$bridge && cd mautrix-$bridge.
N.B. The docker image will chown its /data directory to UID 1337. The commands below mount the working directory as /data, so make sure you always run them in the correct directory.
Pull the docker image with docker pull dock.mau.dev/mautrix/$bridge:<version>. Replace <version> with the version you want to run (e.g. latest or v0.6.0).
Run the container for the first time, so it can create a config file for you:
```
docker run --rm -v `pwd`:/data:z dock.mau.dev/mautrix/$bridge:<version>
```
Update the config to your liking. You'll at least need to change the homeserver settings, appservice address, 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 by running the container again, same command as above.
Register the bridge on your homeserver (see Registering appservices).
Run the bridge:
```
docker run --restart unless-stopped -v `pwd`:/data:z dock.mau.dev/mautrix/$bridge:<version>
```
Additionally, you should either add the bridge to the same Docker network as Synapse with --network=synapsenet, or expose the correct port with -p <port>:<port>.

Upgrading

Pull the new version (setup step 1)
Start the new version (setup step 6)

Docker compose

Create a directory for the bridge like step #0 in the Docker CLI instructions above.

Create docker-compose.yml that contains something like this:

version: "3.7"

services:
  mautrix-$bridge:
    container_name: mautrix-$bridge
    image: dock.mau.dev/mautrix/$bridge:<version>
    restart: unless-stopped
    volumes:
    - .:/data

    # If synapse is running outside of docker, you'll need to expose the port.
    # Note that in most cases you should either run everything inside docker
    # or everything outside docker, rather than mixing docker things with
    # non-docker things.
    #ports:
    #- "$bridgeport:$bridgeport"
    # You'll also probably want this so the bridge can reach Synapse directly
    # using something like `http://host.docker.internal:8008` as the address:
    #extra_hosts:
    #- "host.docker.internal:host-gateway"

    # If synapse is in a different network, then add this container to that network.
    #networks:
    #- synapsenet
# This is also a part of the networks thing above
#networks:
#  synapsenet:
#    external:
#      name: synapsenet

Follow the rest of the Docker setup, but use compose commands instead of the raw docker commands: docker-compose up -d to start, docker-compose stop to stop and docker-compose pull to update.

If you want to set it up in an existing docker-compose file instead of a new dedicated one, simply adjust the volumes section to mount a subdirectory instead of the current directory as the data directory:

volumes:
- ./mautrix-$bridge:/data

When you put the bridge and Synapse in the same docker-compose file, networking should work out of the box, which means you don't need any of the commented ports or networks things in the example compose file.

4.1 KiB Raw Permalink Blame History