synapse-element

About

               

Matrix is an open standard for decentralised communication, which securely distributes persistent chatrooms over an open federation of servers preventing any single points of control or failure.

Synapse is a Matrix "homeserver" implementation developed by the matrix.org core team.

Element is a Matrix web client built using the Matrix React SDK.

• Synapse

  • Github
  • Documentation
  • Docker Image

• Element

  • Github
  • Docker Image

Table of Contents

• About
• Table of Contents
• Files structure
• Information
  • docker-compose
• Usage
  • Requirements
  • Configuration
• Update
• Security
• Backup

Files structure

.
|-- docker-compose.yml
|-- matrix-data/
|-- element-web/config.json

• docker-compose.yml - a docker-compose file, use to configure your application’s services
• matrix-data/ - a directory used to store the matrix data
• element-web/config.json - a file used to store element's data

Please make sure that all the files and directories are present.

Information

docker-compose

Links to the following docker-compose.yml.

• docker-compose.yml

  version: '3'
  
  services:
  
    synapse:
      image: matrixdotorg/synapse:latest
      restart: unless-stopped
      container_name: synapse
      environment:
        - SYNAPSE_LOG_LEVEL=INFO
      volumes:
        - ./matrix-data:/data
      labels:
        - "traefik.enable=true"
        - "traefik.http.routers.synapse.rule=Host(`${TRAEFIK_MATRIX}`)"
        - "traefik.http.routers.synapse.entrypoints=https"
        - "traefik.http.routers.synapse.tls=true"
        - "traefik.http.routers.synapse.tls.certresolver=mydnschallenge"
  
        # Watchtower Update
        - "com.centurylinklabs.watchtower.enable=true"
      networks:
        - proxy
  
    element:
      image: vectorim/element-web:latest
      restart: unless-stopped
      container_name: element
      depends_on:
        - synapse
      volumes:
        - ./element-web/config.json:/app/config.json:ro
      labels:
        - "traefik.enable=true"
        - "traefik.http.routers.element.rule=Host(`${TRAEFIK_ELEMENT}`)"
        - "traefik.http.routers.element.entrypoints=https"
        - "traefik.http.routers.element.tls=true"
        - "traefik.http.routers.element.tls.certresolver=mydnschallenge"
  
        # Watchtower Update
        - "com.centurylinklabs.watchtower.enable=true"
      networks:
        - proxy
  
  
  networks:
    proxy:
      external: true

• .env

  TRAEFIK_MATRIX=matrix.example.com
  TRAEFIK_ELEMENT=element.example.com

Usage

Requirements

• Traefik up and running.
• Subdomains of your choice, this example uses element and matrix.
  • You should be able to create a subdomain with your DNS provider, use a A record with the same IP address as your root domain.

Configuration

Check that the URL is correct in element-web/config.json and replace the environment variables in .env with your own.

The first step is to generate a valid config file. To do this, you can run the image with the generate command line option. Please replace the SYNAPSE_SERVER_NAME with your own.

sudo docker run -it --rm \
    -v "$(pwd)/matrix-data:/data" \
    -e SYNAPSE_SERVER_NAME=matrix.example.com \
    -e SYNAPSE_REPORT_STATS=no \
    matrixdotorg/synapse:latest generate

You can now start the service with :

sudo docker-compose up -d

You can check that the matrix server is working by accessing the URL. You should then be able to access the element web-ui and create a new account. By default, the registration is disabled, change the enable_registration value to true in matrix-data/homeserver.yaml, then restart the container.

Update

The image is automatically updated with watchtower thanks to the following label :

  # Watchtower Update
  - "com.centurylinklabs.watchtower.enable=true"

Security

You can modify the matrix config file to increase security : matrix-data/homeserver.yaml. After you have created your account, you can disable registration with enable_registration: false.

Backup

Docker volumes are globally backed up using borg-backup.