Find a file
Manuel Stahl dda8ba5e85 Update nodejs version for travis
Change-Id: I7d44f5df7d4479efcb1d44f5ba23467effad147e
2021-05-05 19:31:50 +02:00
public Import users from CSV 2020-11-02 18:29:56 +00:00
src Replace enzyme with testing-library/react 2021-05-05 19:23:01 +02:00
.dockerignore Add git context to docker, so we can derive the release version 2020-07-29 17:49:30 +02:00
.gitignore Create a base react-admin application 2020-02-07 21:20:57 +01:00
.prettierrc yarn: Upgrade packages 2020-04-06 12:17:42 +02: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 Use current node image as builder 2020-08-25 17:19:17 +02:00
LICENSE Create a base react-admin application 2020-02-07 21:20:57 +01:00
package.json Replace enzyme with testing-library/react 2021-05-05 19:23:01 +02:00
README.md Enable sorting in tab of users' media (#138) 2021-05-04 16:18:12 +02:00
screenshots.jpg Add screenshots and install instructions 2020-07-08 07:49:42 +00:00
yarn.lock Replace enzyme with testing-library/react 2021-05-05 19:23:01 +02:00

Build Status

Synapse admin ui

This project is built using react-admin.

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

  1. Download the source code from github and run using nodejs
  2. Run the Docker container

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

Screenshots

Screenshots

Development

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