dnomd343/syncplay

Syncplay Docker镜像文档

镜像概述

Syncplay Docker镜像是一个用于快速部署Syncplay服务的容器化解决方案。Syncplay允许多个用户同步观看视频内容，实现播放进度、暂停/播放等控制的实时共享，适用于远程协作观影场景。本镜像支持多架构，提供灵活的配置方式，可通过命令行参数或环境变量自定义服务特性。

!https://github.com/Syncplay/syncplay/raw/master/syncplay/resources/hicolor/128x128/apps/syncplay.png

项目地址：https://github.com/dnomd343/syncplay-docker.git

核心功能与特性

• 多架构支持：适配多种硬件架构，确保广泛兼容性
• 灵活配置：支持通过命令行参数或环境变量进行服务配置
• 安全增强：支持TLS加密传输，可设置访问密码及盐值
• 房间管理：支持房间隔离、永久房间设置，提升用户分组体验
• 功能控制：可禁用聊天/就绪状态、启用统计功能、限制用户名/消息长度
• 持久化支持：可选持久化模式，保持服务器运行状态

使用场景

• 远程朋友/家人同步观看影视内容，共享观影体验
• 线上学习小组同步观看教学视频，实现协同学习
• 社区/团队组织线上观影活动，统一播放进度控制

使用方法

基础部署

通过以下命令快速启动默认配置的Syncplay服务（监听TCP 8999端口）：

bash
docker run -d --net=host --restart=always --name=syncplay dnomd343/syncplay

自定义参数部署

可通过命令行参数自定义服务配置，支持的参数如下：

bash
docker run -d --net=host --restart=always --name=syncplay dnomd343/syncplay \
  --port [端口号] \          # 指定服务端口
  --password [密码] \        # 设置访问密码
  --motd [欢迎消息] \        # 设置服务器欢迎消息(MOTD)
  --salt [盐值文本] \        # 设置密码哈希盐值
  --random-salt \            # 使用随机生成的盐值
  --isolate-rooms \          # 启用房间隔离模式
  --disable-chat \           # 禁用聊天功能
  --disable-ready \          # 禁用就绪状态标记
  --enable-stats \           # 启用服务器统计功能
  --enable-tls \             # 启用TLS加密
  --persistent \             # 启用持久化存储
  --max-username [数字] \    # 设置用户名最大长度
  --max-chat-message [数字] \# 设置聊天消息最大长度
  --permanent-rooms [房间名...] \ # 设置永久房间
  --listen-ipv4 0.0.0.0 \    # 指定IPv4监听地址
  --listen-ipv6 ::           # 指定IPv6监听地址

TLS加密配置

启用TLS需挂载包含证书文件的目录（需包含cert.pem、chain.pem和privkey.pem三个文件）：

bash
docker run -d --net=host --restart=always --name=syncplay \
  --volume <证书目录>:/certs/ dnomd343/syncplay --enable-tls

环境变量配置

支持通过环境变量配置服务，环境变量为命令行参数的大写形式（-替换为_），布尔值用ON表示：

bash
docker run --rm -it \
  --env PORT=8999 \                  # 服务端口
  --env PASSWORD="访问密码" \        # 访问密码
  --env MOTD="欢迎使用Syncplay" \    # 欢迎消息
  --env SALT="自定义盐值" \          # 密码盐值
  --env RANDOM_SALT=ON \             # 启用随机盐值
  --env ISOLATE_ROOMS=ON \           # 启用房间隔离
  --env DISABLE_CHAT=ON \            # 禁用聊天
  --env DISABLE_READY=ON \           # 禁用就绪状态
  --env ENABLE_STATS=ON \            # 启用统计
  --env ENABLE_TLS=ON \              # 启用TLS
  --env PERSISTENT=ON \              # 启用持久化
  --env MAX_USERNAME=256 \           # 用户名最大长度
  --env MAX_CHAT_MESSAGE=2048 \      # 消息最大长度
  --env LISTEN_IPV4="127.0.0.1" \    # IPv4监听地址
  --env LISTEN_IPV6="::1" \          # IPv6监听地址
  dnomd343/syncplay

配置参数说明

参数与环境变量对应表

高级配置

关于配置文件、docker-compose部署及故障排除等高级用法，请参考https://github.com/dnomd343/syncplay-docker.git%E3%80%82