devture/matrix-corporal

Matrix Corporal Docker镜像文档

镜像概述和主要用途

Matrix Corporal 是一款用于管理 Matrix 服务器的协调器和网关工具。它能够根据配置策略持续管理 Matrix 服务器，通过对接外部系统（如内联网）作为单一事实来源，确保 Matrix 服务器的用户、房间、社区等配置始终与外部系统保持一致，实现自动化的服务器配置同步与管理。

核心功能和特性

• 配置策略管理：根据预设的配置策略自动管理 Matrix 服务器
• 外部系统同步：对接外部系统作为单一事实来源，确保用户、房间、社区等配置的一致性
• 协调器与网关：作为 Matrix 服务器的协调器和网关，实现配置的持续同步与更新
• 自动化配置：持续监控并重新配置 Matrix 服务器，无需手动干预

使用场景和适用范围

适用于需要集中管理 Matrix 服务器配置的场景，尤其是：

• 企业内联网环境，需将 Matrix 服务器用户、权限等配置与企业内部系统同步
• 多团队协作场景，需要统一管理 Matrix 房间和社区结构
• 任何需要自动化维护 Matrix 服务器配置一致性的环境

使用方法和配置说明

前提条件

1. 已创建符合要求的配置文件（配置说明参见 https://github.com/devture/matrix-corporal/blob/master/docs/configuration.md%EF%BC%89
2. 配置文件中 ListenInterface 需设置为 0.0.0.0（因运行在容器中）

Docker 部署示例

基本运行命令

bash
docker run \
-it \
--rm \
-p 127.0.0.1:41080:41080 \
-p 127.0.0.1:41081:41081 \
-v /local/path/to/config.json:/config.json:ro \
devture/matrix-corporal:latest

参数说明

• -it：交互式终端运行
• --rm：容器退出后自动删除
• -p 127.0.0.1:41080:41080 和 -p 127.0.0.1:41081:41081：端口映射，仅本地可访问（推荐搭配反向代理使用）
• -v /local/path/to/config.json:/config.json:ro：挂载本地配置文件到容器内，只读模式
• devture/matrix-corporal:latest：镜像名称和标签

重要提示

• 端口安全性：默认端口 41080 和 41081 仅本地暴露，建议部署在反向代理后方以确保安全
• 镜像版本：推荐使用带版本标签的镜像（如 devture/matrix-corporal:v2.0.0），而非 latest 标签，以确保环境稳定性