Find a file
Manuel Stahl 4b1277f653 Rework configuration process
Dynamically loads `config.json` on startup.

Fixes #167, #284, #449, #486

Change-Id: I9efb1079c0c88e6e0272c5fda734a367aa8f84a3
2024-04-23 11:56:39 +02:00
.github Bump softprops/action-gh-release from 2.0.3 to 2.0.4 (#510) 2024-04-23 10:50:40 +02:00
public Rework configuration process 2024-04-23 11:56:39 +02:00
src Rework configuration process 2024-04-23 11:56:39 +02:00
.dockerignore Add git context to docker, so we can derive the release version 2020-07-29 17:49:30 +02:00
.gitignore Create a base react-admin application 2020-02-07 21:20:57 +01:00
.prettierrc Fix build environment 2023-01-16 13:42:16 +01:00
docker-compose.yml Rework configuration process 2024-04-23 11:56:39 +02:00
Dockerfile Rework configuration process 2024-04-23 11:56:39 +02:00
LICENSE Create a base react-admin application 2020-02-07 21:20:57 +01:00
package.json Use officially recommended language packages 2024-04-22 15:20:11 +02:00
README.md Rework configuration process 2024-04-23 11:56:39 +02:00
screenshots.jpg Add screenshots and install instructions 2020-07-08 07:49:42 +00:00
yarn.lock Use officially recommended language packages 2024-04-22 15:20:11 +02:00

GitHub license Build Status build-test gh-pages docker-release github-release

Synapse admin ui

This project is built using react-admin.

Usage

Supported Synapse

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

You get your server version with the request /_synapse/admin/v1/server_version. See also Synapse version API.

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

Prerequisites

You need access to the following endpoints:

  • /_matrix
  • /_synapse/admin

See also Synapse administration endpoints

Use without install

You can use the current version of Synapse Admin without own installation direct via GitHub Pages.

Note: If you want to use the deployment, you have to make sure that the admin endpoints (/_synapse/admin) are accessible for your browser. Remember: You have no need to expose these endpoints to the internet but to your network. If you want your own deployment, follow the Step-By-Step Install Guide below.

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: https://github.com/Awesome-Technologies/synapse-admin/releases/latest
  • unpack the .tar.gz
  • move or symlink the synapse-admin-x.x.x 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 https://github.com/Awesome-Technologies/synapse-admin.git
  • change into downloaded directory: cd synapse-admin
  • download dependencies: yarn install
  • start web server: yarn start

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.

    services:
      synapse-admin:
        container_name: synapse-admin
        hostname: synapse-admin
        build:
          context: https://github.com/Awesome-Technologies/synapse-admin.git
          # args:
          #   - NODE_OPTIONS="--max_old_space_size=1024"
          #   # see #266, PUBLIC_URL must be without surrounding quotation marks
          #   - PUBLIC_URL=/synapse-admin
        ports:
          - "8080:80"
        restart: unless-stopped
    
  • browse to http://localhost:8080

Restricting available homeserver

You can restrict the homeserver(s), so that the user can no longer define it himself.

Edit config.json to restrict either to a single homeserver:

{
  "restrictBaseUrl": "https://your-matrixs-erver.example.com"
}

or to a list of homeservers:

{
  "restrictBaseUrl": [
    "https://your-first-matrix-server.example.com",
    "https://your-second-matrix-server.example.com"
  ]
}

The config.json can be injected into a Docker container using a bind mount.

services:
  synapse-admin:
    ...
    volumes:
      ./config.json:/app/config.json
    ...

Screenshots

Screenshots

Development

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