2020-02-11 16:41:35 +08:00
|
|
|
[](https://travis-ci.org/Awesome-Technologies/synapse-admin)
|
|
|
|
|
|
2020-01-27 21:57:27 +08:00
|
|
|
# Synapse admin ui
|
|
|
|
|
|
|
|
|
|
This project is built using [react-admin](https://marmelab.com/react-admin/).
|
|
|
|
|
|
2020-08-07 03:43:19 +08:00
|
|
|
It needs at least Synapse v1.18.0 for all functions to work as expected!
|
2020-07-05 01:32:45 +08:00
|
|
|
|
2020-10-26 17:08:33 +08:00
|
|
|
You get your server version with the request `/_synapse/admin/v1/server_version`.
|
|
|
|
|
See also [Synapse version API](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/version_api.rst).
|
|
|
|
|
|
|
|
|
|
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:
|
2020-11-12 23:16:32 +08:00
|
|
|
|
2020-10-26 17:08:33 +08:00
|
|
|
- `/_matrix`
|
|
|
|
|
- `/_synapse/admin`
|
|
|
|
|
|
|
|
|
|
See also [Synapse administration endpoints](https://github.com/matrix-org/synapse/blob/develop/docs/reverse_proxy.md#synapse-administration-endpoints)
|
|
|
|
|
|
2020-07-05 01:32:45 +08:00
|
|
|
## Step-By-Step install:
|
|
|
|
|
|
|
|
|
|
You have two options:
|
|
|
|
|
|
2020-07-08 15:55:52 +08:00
|
|
|
1. Download the source code from github and run using nodejs
|
|
|
|
|
2. Run the Docker container
|
2020-07-05 01:32:45 +08:00
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
2020-07-29 23:49:00 +08:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
- Use `yarn test` to run all style, lint and unit tests
|
|
|
|
|
- Use `yarn fix` to fix the coding style
|
