eeacms/matrix-synapse repository overview

⁠Docker image for Synapse Matrix.org server

Docker image for https://github.com/matrix-org/synapse⁠, including configuration changes used in EEA and adding HTTP JSON REST Authenticator module for synapse (https://github.com/kamax-io/matrix-synapse-rest-auth⁠)

⁠Supported tags and respective Dockerfile links

• Tags⁠

⁠Base docker image

• eeacms/matrix-synapse⁠

⁠Source code

• eea/eea.docker.matrix.synapse⁠

⁠Usage

docker run -d -p 8008:8008 -p 8448:8448 -p 3478:3478  -v /tmp/data:/data eeacms/matrix-synapse

Docker compose example

  matrix:
    image: eeacms/matrix-synapse
    restart: always
    command: start
    ports:
      - "8208:8008"
      - "8248:8448"
      - "3578:3478"
    volumes:
      - ./data/synapse/:/data
    environment:
      SERVER_NAME: riot.devecs.eea.europa.eu
      REPORT_STATS: 'yes'
      DATABASE: postgresql
      POSTGRES_HOST: db
      DB_NAME: synapse
      DB_USER: matrix
      DB_PASSWORD: matrix
      EMAIL_FROM: 'Riot EEA <[email protected]>'
      RIOT_BASE_URL: https://riot_URL/
      PUBLIC_BASE_URL: matrix_base
      REGISTRATION_ENABLED: 'no'

⁠Supported environment variables

• SERVER_NAME - The public url of matrix, used in federation and under which every user is saved; Is used in Riot and Identity containers
• REPORT_STATS - Send data to matrix.org: hostname, synapse version & uptime, total_users, total_nonbridged users, total_room_count, daily_active_users, daily_active_rooms, daily_messages and daily_sent_messages.
• DATABASE - database type - postgresql or sqlite
• POSTGRES_HOST - Postgres Host
• DB_USER - Matrix postgres database user
• DB_PASSWORD - Matrix postgres database password
• DB_NAME - Matrix postgres database name
• EMAIL_FROM - Email used to send notifications from Matrix
• RIOT_BASE_URL Will be included in emails
• PUBLIC_BASE_URL the same as SERVER_NAME
• REGISTRATION_ENABLED "yes"/"no"
• MXISD_TOKEN secret token, enables appservice-mxisd app that links to the identity service url to enable the sending of invitations to users that are not logged in
• MXISD_AS_TOKEN secret token, used in appservice-mxisd

⁠Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

The Original Code is free software; you can redistribute it and/or modify it under the terms of the Apache License as published by the Apache Software Foundation (ASF); either version 2 of the License, or (at your option) any later version.

⁠Funding

European Environment Agency (EU)⁠