Co-authored-by: Dominik Fuchß <firstname.lastname@example.org>
|3 months ago|
|.github/workflows||6 months ago|
|public||2 years ago|
|src||5 months ago|
|.dockerignore||2 years ago|
|.env||1 year ago|
|.gitignore||3 years ago|
|.prettierrc||6 months ago|
|.travis.yml||1 year ago|
|Dockerfile||3 months ago|
|LICENSE||3 years ago|
|README.md||3 months ago|
|docker-compose.yml||1 year ago|
|package.json||5 months ago|
|screenshots.jpg||2 years ago|
|yarn.lock||3 months ago|
Synapse admin ui
This project is built using react-admin.
It needs at least Synapse v1.42.0 for all functions to work as expected!
You get your server version with the request
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:
See also Synapse administration endpoints
Use without install
You can use the current version of Synapse Admin without own installation direct via GitHub Pages.
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.
You have three options:
- Download the tarball and serve with any webserver
- Download the source code from github and run using nodejs
- 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.xinto 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:
- download dependencies:
- start web server:
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
Steps for 3)
run the Docker container from the public docker registry:
docker run -p 8080:80 awesometechnologies/synapse-adminor 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
yarn testto run all style, lint and unit tests
yarn fixto fix the coding style