SyncLounge Docker镜像文档

镜像概述和主要用途

SyncLounge（前身为PlexTogether）是一款用于跨多个位置的多个播放器同步Plex内容的工具。它通过中间服务器实现多个观看会话的同步，无论客户端是在同一房间还是全球各地。用户可创建房间，邀请他人加入，由房间主机控制播放（播放、暂停、 seek等操作），并自动搜索所有可用Plex媒体服务器中的等效内容，实现同步观看体验。

工作原理

SyncLounge通过中间服务器在多个客户端间通信，第一个加入房间的用户成为主机，主机的播放指令（如播放、暂停、 seek）会同步至房间内其他客户端。若主机切换播放内容，SyncLounge会自动搜索所有可用Plex媒体服务器，查找等效内容（即使来自不同Plex媒体服务器），确保其他用户能同步观看。

核心功能与特性

• 跨网络Plex客户端同步：支持互联网上不同位置的Plex客户端间同步播放。
• 专用SyncLounge播放器：内置专为同步设计的播放器，直接在SyncLounge中播放内容。
• 环境调优设置：
  • 客户端轮询间隔：设置SyncLounge轮询客户端获取新信息的频率。
  • 同步灵活性：设置可接受的与主机的时间差（毫秒）。
  • 同步方法：
    • 直接Seek：直接跳转到主机所在位置。
    • 跳过前进：向前跳10秒，暂停后10秒恢复播放。
• Plex媒体服务器屏蔽：限制SyncLounge搜索内容的服务器范围。
• 自动播放内容：自动搜索所有可用Plex媒体服务器，查找与主机内容相似的资源。
• Plex媒体服务器浏览：在SyncLounge内查找、搜索内容并推送至Plex客户端。
• 元数据获取：从Plex媒体服务器获取内容元数据。
• 房间聊天：支持房间内用户实时聊天。
• 密码锁定房间：通过密码保护房间，防止未授权访问。
• 邀请链接生成：生成短链接，方便邀请他人加入房间。
• 内容支持：支持电影和电视剧（不支持音乐）。

支持的Plex客户端

理论上，所有实现Plex客户端协议的客户端均可使用，但部分客户端因协议实现差异，兼容性可能不同。低功耗客户端（如树莓派客户端）可能难以实现完美同步。

不支持

• Plex网页播放器（Chrome/Safari/Firefox）

支持

• Plex媒体播放器（Plex Media Player）
• Plex家庭影院（Plex Home Theater）
• OpenPHT
• Rasplex
• Roku
• Android
• Nvidia Shield
• iOS（iPhone和iPad）
• AppleTV

功能损坏

• Xbox One
• Xbox 360
• PS3
• PS4

使用方法与配置说明

安装说明

默认情况下，SyncLounge监听8088端口，所有路径为相对路径，可通过反向代理部署在任何子目录或子域名下，无需额外配置。当前版本中，Web应用和 socket 服务器已整合，只需代理该端口。

Docker安装（推荐）

Docker镜像是最简单的部署方式，开箱即用：

sh
# 拉取镜像
docker pull synclounge/synclounge

# 运行容器
docker run -p 8088:8088 synclounge/synclounge:latest

可通过环境变量修改默认配置中的任何参数。

Linux无Docker安装

确保已安装nodejs：

sh
# 全局安装SyncLounge
sudo npm install -g synclounge

# 运行SyncLounge
synclounge

若需修改默认配置，可通过环境变量（与配置参数同名）、命令行参数或配置文件（运行时指定：synclounge --config_file /path/to/config.json）。

Nginx反向代理配置示例

若需在Nginx后运行SyncLounge，以下是配置示例：

子域名配置（sub.domain.com）

nginx
map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      '';
}

server {
    listen 80;
    listen [::]:80;
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    # 替换为你的域名
    server_name somesubdomain.yourserver.com;

    # 配置SSL证书（自行补充）

    location / {
        # 替换为容器地址或localhost
        proxy_pass [***]
        proxy_http_version 1.1;
        proxy_socket_keepalive on;
        proxy_redirect off;

        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Host $server_name;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Port $server_port;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_set_header Sec-WebSocket-Extensions $http_sec_websocket_extensions;
        proxy_set_header Sec-WebSocket-Key $http_sec_websocket_key;
        proxy_set_header Sec-WebSocket-Version $http_sec_websocket_version;
    }
}

子文件夹配置（domain.com/somefolder/）

如需在子文件夹下运行，修改反向代理配置如下：

nginx
map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      '';
}

server {
    listen 80;
    listen [::]:80;
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    # 替换为你的域名
    server_name somesubdomain.yourserver.com;

    # 配置SSL证书（自行补充）

    # 替换"somefolder"为你的子文件夹名称
    location /somefolder/ {
        # 替换为容器地址或localhost，注意末尾斜杠
        proxy_pass [***]
        proxy_http_version 1.1;
        proxy_socket_keepalive on;
        proxy_redirect off;

        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Host $server_name;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Port $server_port;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_set_header Sec-WebSocket-Extensions $http_sec_websocket_extensions;
        proxy_set_header Sec-WebSocket-Key $http_sec_websocket_key;
        proxy_set_header Sec-WebSocket-Version $http_sec_websocket_version;
    }
}

旧版帮助

FAQ、自托管、开发、贡献等更多文档已迁移至docs.synclounge.tv。

贡献者

• samcm - 开发者
• gcordalis - 用户界面
• Brandz - 设计
• TheGrimmChester - 开发/测试
• MagicalCodeMonkey - 开发/测试
• ttshivers - 开发者
• Starbix - Docker支持
• kg6jay - 测试

联系方式

• ***服务器
• ***：SyncLounge

许可证

SyncLounge采用MIT许可证，详见LICENSE.txt文件。SyncLounge与Plex Inc.无任何关联。

使用的Material Design库遵循CC-BY 4.0许可。