alexbabel/synapse 镜像文档

镜像概述

alexbabel/synapse 是一个基于 matrixdotorg/synapse 的Docker镜像，在官方Synapse镜像基础上扩展集成了 synapse-s3-storage-provider 和 shared-secret-authenticator 两个组件。该镜像旨在为Matrix Synapse部署提供增强功能，满足S3存储需求和共享密钥认证场景。

核心功能与特性

核心集成组件

• synapse-s3-storage-provider：Matrix Synapse的S3存储提供器，支持将媒体文件（如图片、视频等）存储到Amazon S3或兼容S3的对象存储服务中，解决本地存储容量限制问题。
• shared-secret-authenticator：提供共享密钥认证机制，允许通过预共享密钥进行用户认证，增强部署的认证灵活性。

基础特性

• 继承 matrixdotorg/synapse 的全部功能，包括Matrix协议实现、房间管理、用户管理等核心功能。
• 保持与官方Synapse镜像版本同步（通过 <version> 标签控制），确保兼容性和安全性。

使用场景与适用范围

• 需要将Matrix Synapse的媒体文件存储到S3或兼容S3的对象存储服务的部署场景。
• 需要使用共享密钥认证机制进行用户身份验证的私有或半私有Synapse部署。
• 对官方Synapse镜像功能有扩展需求，同时希望简化集成流程的用户。

使用方法与配置说明

基础使用

该镜像的基础使用方式与 matrixdotorg/synapse 一致，可参考官方文档进行初始配置（如生成配置文件、数据库设置等）。

生成配置文件（首次使用）

docker run --rm -v /path/to/synapse/config:/data alexbabel/synapse:latest generate

启动容器

docker run -d \
  --name synapse \
  -v /path/to/synapse/config:/data \
  -p 8008:8008 \
  alexbabel/synapse:latest

配置S3存储（synapse-s3-storage-provider）

需在Synapse配置文件（homeserver.yaml）中添加S3存储配置，示例如下：

media_storage_providers:
  - module: "synapse_s3_storage_provider.S3StorageProviderBackend"
    store_local: True  # 本地媒体文件存储到S3
    store_remote: True  # 远程媒体文件存储到S3
    config:
      bucket: "your-s3-bucket"
      region_name: "your-region"
      access_key_id: "your-access-key"
      secret_access_key: "your-secret-key"
      endpoint_url: "[***]"  # 非AWS S3时需指定
      # 可选配置：存储路径前缀、签名版本等
      prefix: "synapse-media/"
      signature_version: "s3v4"

配置共享密钥认证（shared-secret-authenticator）

1. 在Synapse配置文件（homeserver.yaml）中启用认证提供器：

password_providers:
  - module: "shared_secret_authenticator.SharedSecretAuthenticator"
    config:
      shared_secret: "your-shared-secret-key"  # 预共享密钥
      # 可选配置：是否允许注册、用户默认权限等
      enable_registration: False
      admin_users: ["@admin:example.com"]

2. 客户端认证时，需在请求中包含共享密钥（具体方式参考 shared-secret-authenticator 官方文档）。

Dockerfile说明

该镜像基于官方 matrixdotorg/synapse:<version> 构建，通过 pip 安装扩展组件：

FROM matrixdotorg/synapse:<version>

RUN pip install synapse-s3-storage-provider shared-secret-authenticator

其中 <version> 为官方Synapse镜像的版本标签，确保与目标Synapse版本匹配。

部署示例

基础Docker Run部署

docker run -d \
  --name synapse \
  -p 8008:8008 \
  -v /path/to/synapse/config:/data \
  -e SYNAPSE_CONFIG_PATH=/data/homeserver.yaml \
  alexbabel/synapse:latest

结合S3和共享密钥认证的配置示例

1. 准备包含S3存储和共享密钥认证配置的 homeserver.yaml 文件；
2. 启动容器并挂载配置文件：

docker run -d \
  --name synapse-enhanced \
  -p 8008:8008 \
  -v /path/to/custom-config:/data \
  -e AWS_ACCESS_KEY_ID=your-access-key \
  -e AWS_SECRET_ACCESS_KEY=your-secret-key \
  alexbabel/synapse:latest

注：环境变量可用于传递敏感配置（如AWS密钥），或直接在 homeserver.yaml 中配置。

注意事项

• 确保 synapse-s3-storage-provider 和 shared-secret-authenticator 的版本与Synapse版本兼容，可通过 pip install 时指定版本号（如 synapse-s3-storage-provider==x.x.x）。
• S3存储配置需确保目标存储服务可访问，且密钥具有足够权限（如读写对象）。
• 共享密钥应妥善保管，避免泄露导致未授权访问。