Need help with synapse-admin?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

295 Stars 51 Forks Apache License 2.0 145 Commits 42 Opened issues


Services available


Need anything else?

Contributors list

Build Status build-test

Synapse admin ui

This project is built using react-admin.

It needs at least Synapse v1.38.0 for all functions to work as expected!

You get your server version with the request

. See also Synapse version API.

After entering the URL on the login page of synapse-admin the server version appears below the input field.

You need access to the following endpoints:

  • /_matrix
  • /_synapse/admin

See also Synapse administration endpoints

Step-By-Step install:

You have three options:

  1. Download the tarball and serve with any webserver
  2. Download the source code from github and run using nodejs
  3. Run the Docker container

Steps for 1):

  • make sure you have a webserver installed that can serve static files (any webserver like nginx or apache will do)
  • configure a vhost for synapse admin on your webserver
  • download the .tar.gz from the latest release:
  • unpack the .tar.gz
  • move or symlink the
    into your vhosts root dir
  • open the url of the vhost in your browser

Steps for 2):

  • make sure you have installed the following: git, yarn, nodejs
  • download the source code:
    git clone
  • change into downloaded directory:
    cd synapse-admin
  • download dependencies:
    yarn install
  • start web server:
    yarn start

You can fix the homeserver, so that the user can no longer define it himself. Either you define it at startup (e.g.

REACT_APP_SERVER= yarn start
) or by editing it in the .env file. See also the documentation.

Steps for 3):

  • run the Docker container from the public docker registry:
    docker run -p 8080:80 awesometechnologies/synapse-admin
    or use the docker-compose.yml:
    docker-compose up -d

note: if you're building on an architecture other than amd64 (for example a raspberry pi), make sure to define a maximum ram for node. otherwise the build will fail.

  version: "3"

services: synapse-admin: container_name: synapse-admin hostname: synapse-admin build: context: # args: # - NODE_OPTIONS="--max_old_space_size=1024" ports: - "8080:80" restart: unless-stopped

  • browse to http://localhost:8080




  • Use
    yarn test
    to run all style, lint and unit tests
  • Use
    yarn fix
    to fix the coding style

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.