awesometechnologies/synapse-admin

Synapse 管理界面

概述

本项目是Matrix Synapse homeserver的管理界面，基于react-admin构建。所有功能正常工作需至少Synapse v1.34.0版本。通过登录页面输入服务器URL后，输入框下方会显示服务器版本（可通过请求/_synapse/admin/v1/server_version获取，详见https://matrix-org.github.io/synapse/develop/admin_api/version_api.html）。使用时需确保能访问以下端点：

• /_matrix
• /_synapse/admin（详见https://matrix-org.github.io/synapse/develop/reverse_proxy.html#synapse-administration-endpoints）

核心功能与特性

• 提供Web界面管理Matrix Synapse homeserver
• 支持查看服务器版本信息
• 可通过环境变量或配置文件固定homeserver地址，限制用户自定义
• 需访问Synapse的核心管理端点实现功能

使用场景

适用于Matrix Synapse服务器管理员，通过Web界面便捷管理Synapse homeserver，简化服务器配置与维护流程。

安装与使用方法

安装选项

有两种安装方式：

1. 从GitHub下载源码，使用nodejs运行
2. 运行Docker容器（推荐）

选项1：源码安装

• 确保已安装git、yarn、nodejs
• 克隆源码：git clone https://github.com/Awesome-Technologies/synapse-admin.git
• 进入目录：cd synapse-admin
• 安装依赖：yarn install
• 启动Web服务器：yarn start

可固定homeserver地址，用户将无法自行定义：

• 启动时设置：REACT_APP_SERVER=https://yourmatrixserver.example.com yarn start
• 或编辑.env文件（详见https://create-react-app.dev/docs/adding-custom-environment-variables/）

选项2：Docker部署

直接运行容器

从公共Docker registry运行：

bash
docker run -p 8080:80 docker.xuanyuan.run/awesometechnologies/synapse-admin

使用docker-compose

创建docker-compose.yml文件：

yaml
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"  # 非amd64架构（如树莓派）构建时需取消注释并设置
    ports:
      - "8080:80"
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

注意：在非amd64架构（如树莓派）上构建时，需定义node最大内存，否则构建可能失败，可通过NODE_OPTIONS="--max_old_space_size=1024"参数设置。

访问界面

部署完成后，通过http://localhost:8080访问管理界面。

开发相关

• 运行yarn test执行所有样式、 lint 和单元测试
• 运行yarn fix修复代码风格问题

截图