You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Dirk Klimpel 0b153ddcbb Update README.md 3 months ago
.github/workflows GitHub Pages Deploy (#189) 6 months ago
public Import users from CSV 2 years ago
src Add `path` to rooms tab "members" (#232) 5 months ago
.dockerignore Add git context to docker, so we can derive the release version 2 years ago
.env Allow fixed homeserver (#142) 1 year ago
.gitignore Create a base react-admin application 3 years ago
.prettierrc Fix typo in `.prettierrc` (#224) 6 months ago
.travis.yml Update nodejs version for travis 1 year ago
Dockerfile Make PUBLIC_URL and REACT_APP_SERVER configurable (#266) 3 months ago
LICENSE Create a base react-admin application 3 years ago
README.md Update README.md 3 months ago
docker-compose.yml Add docker-compose.yml 1 year ago
package.json Upgrade `react-admin` to `^3.19.7` (#241) 5 months ago
screenshots.jpg Add screenshots and install instructions 2 years ago
yarn.lock Bump minimist from 1.2.5 to 1.2.6 3 months ago

README.md

Build Status build-test

Synapse admin ui

This project is built using react-admin.

Usage

Supported Synapse

It needs at least Synapse v1.42.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

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=https://yourmatrixserver.example.com 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: https://github.com/Awesome-Technologies/synapse-admin.git
          # args:
          #   - NODE_OPTIONS="--max_old_space_size=1024"
          #   # see #266
          #   - PUBLIC_URL="/synapse-admin"
          #   - REACT_APP_SERVER="https://matrix.example.com"
        ports:
          - "8080:80"
        restart: unless-stopped
    
  • browse to http://localhost:8080

Screenshots

Screenshots

Development

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