awesometechnologies/synapse-admin
Admin UI for Matrix Synapse homeserver.
1M+
This project is built using react-admin.
It needs at least Synapse v1.34.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
You have two options:
Steps for 1):
git clone https://github.com/Awesome-Technologies/synapse-admin.git
cd synapse-admin
yarn install
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 2):
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.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"
ports:
- "8080:80"
restart: unless-stopped
browse to http://localhost:8080
yarn test
to run all style, lint and unit testsyarn fix
to fix the coding styledocker pull awesometechnologies/synapse-admin