Find a file
Michael Albert 38541b8f02 Fix english translation for room deletion
Change-Id: I5bb02e64832902a79379d66c77d3128169d3fca8
2022-02-17 20:15:49 +01:00
.github/workflows GitHub Pages Deploy (#189) 2022-01-31 17:38:34 +01:00
public Import users from CSV 2020-11-02 18:29:56 +00:00
src Fix english translation for room deletion 2022-02-17 20:15:49 +01:00
.dockerignore Add git context to docker, so we can derive the release version 2020-07-29 17:49:30 +02:00
.env Allow fixed homeserver (#142) 2021-05-18 12:39:53 +02:00
.gitignore Create a base react-admin application 2020-02-07 21:20:57 +01:00
.prettierrc Fix typo in .prettierrc (#224) 2022-01-31 17:24:37 +01:00
.travis.yml Update nodejs version for travis 2021-05-05 19:31:50 +02:00
docker-compose.yml Add docker-compose.yml 2021-04-21 10:51:17 +02:00
Dockerfile Switch Dockerfile to use current LTS version of Node (#205) 2021-11-15 21:35:23 +01:00
LICENSE Create a base react-admin application 2020-02-07 21:20:57 +01:00
package.json Bump version and update dependencies 2021-12-17 20:38:18 +01:00
README.md Add more headlines for installation to README (#216) 2022-01-31 17:39:18 +01:00
screenshots.jpg Add screenshots and install instructions 2020-07-08 07:49:42 +00:00
yarn.lock Bump nanoid from 3.1.30 to 3.2.0 (#229) 2022-01-31 17:20:39 +01:00

Build Status build-test

Synapse admin ui

This project is built using react-admin.

It needs at least Synapse v1.41.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 three options:

  1. Download the tarball and serve with any webserver
  2. Download the source code from github and run using nodejs
  3. 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.x into 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: cd synapse-admin
  • download dependencies: yarn install
  • start web server: 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 3)

  • 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 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

Screenshots

Screenshots

Development

  • Use yarn test to run all style, lint and unit tests
  • Use yarn fix to fix the coding style