2020-01-27 16:57:27 +03:00
|
|
|
# Synapse admin ui
|
|
|
|
|
|
|
|
|
|
This project is built using [react-admin](https://marmelab.com/react-admin/).
|
|
|
|
|
|
2021-12-07 19:00:49 +03:00
|
|
|
It needs at least Synapse v1.49.0 for all functions to work as expected!
|
2020-07-04 20:32:45 +03:00
|
|
|
|
2020-10-26 12:08:33 +03:00
|
|
|
You get your server version with the request `/_synapse/admin/v1/server_version`.
|
2021-07-06 10:57:44 +03:00
|
|
|
See also [Synapse version API](https://matrix-org.github.io/synapse/develop/admin_api/version_api.html).
|
2020-10-26 12:08:33 +03:00
|
|
|
|
|
|
|
|
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 18:16:32 +03:00
|
|
|
|
2020-10-26 12:08:33 +03:00
|
|
|
- `/_matrix`
|
|
|
|
|
- `/_synapse/admin`
|
|
|
|
|
|
2021-07-06 10:57:44 +03:00
|
|
|
See also [Synapse administration endpoints](https://matrix-org.github.io/synapse/develop/reverse_proxy.html#synapse-administration-endpoints)
|
2020-10-26 12:08:33 +03:00
|
|
|
|
2021-12-17 12:09:24 +03:00
|
|
|
## Step-By-Step install
|
2020-07-04 20:32:45 +03:00
|
|
|
|
|
|
|
|
- make sure you have installed the following: git, yarn, nodejs
|
2022-01-29 15:06:39 +03:00
|
|
|
- download the source code: `git clone https://github.com/matrix07012/synapse-admin.git`
|
2020-07-04 20:32:45 +03:00
|
|
|
- change into downloaded directory: `cd synapse-admin`
|
|
|
|
|
- download dependencies: `yarn install`
|
|
|
|
|
- start web server: `yarn start`
|
|
|
|
|
|
2021-05-18 13:39:53 +03:00
|
|
|
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](.env) file. See also the
|
|
|
|
|
[documentation](https://create-react-app.dev/docs/adding-custom-environment-variables/).
|
|
|
|
|
|
2020-07-04 20:32:45 +03:00
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
2020-07-29 18:49:00 +03:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
- Use `yarn test` to run all style, lint and unit tests
|
|
|
|
|
- Use `yarn fix` to fix the coding style
|
