Shizanit/synapse-admin
1
0
Fork 0
mirror of https://github.com/UA-Fediland/synapse-admin.git synced 2024-11-09 00:04:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
synapse-admin/README.md
Manuel Stahl c841720f0c Fix style 
Change-Id: I345a942905f15edfa21f51de228efd7671f080c7
2020-11-16 10:55:00 +01:00

1.6 KiB
Raw Blame History

Build Status

Synapse admin ui

This project is built using react-admin.

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

You need access to the following endpoints:

  • /_matrix
  • /_synapse/admin

See also Synapse administration endpoints

Step-By-Step install:

You have two options:

  1. Download the source code from github and run using nodejs
  2. Run the Docker container

Steps for 1):

  • 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 2):

  • run the Docker container: docker run -p 8080:80 awesometechnologies/synapse-admin
  • 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