mirror of https://github.com/UA-Fediland/synapse-admin.git synced 2025-10-22 18:56:47 +00:00

https://hub.docker.com/r/awesometechnologies/synapse-admin

Find a file

sakkiii f6f437b17a version tag on docker hub (#187 ) * version tag on docker hub * resolve name collision * master branch added for latest tag * prettier-ignore fix		2021-12-08 22:02:43 +01:00
.github/workflows	version tag on docker hub (#187 )	2021-12-08 22:02:43 +01:00
public	Import users from CSV	2020-11-02 18:29:56 +00:00
src	Add sorting users by creation timestamp (#174 )	2021-12-08 21:59:09 +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	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	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	Increment version	2021-08-25 10:42:34 +02:00
README.md	Enable modify user `external_ids` (#179 )	2021-11-15 20:40:05 +01:00
screenshots.jpg	Add screenshots and install instructions	2020-07-08 07:49:42 +00:00
yarn.lock	Bump tar from 6.1.8 to 6.1.11 (#207 )	2021-11-15 21:18:58 +01:00

README.md

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

Step-By-Step install:

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

Development

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