synclounge/syncloungeserver

SyncLounge Socket Server

这是与https://github.com/ttshivers/synclounge%E9%85%8D%E5%A5%97%E7%9A%84socket%E6%9C%8D%E5%8A%A1%E5%99%A8%E3%80%82%E9%99%A4%E9%9D%9E%E6%82%A8%E5%8F%AA%E6%83%B3%E8%BF%90%E8%A1%8C%E6%AD%A4socket%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%8C%E5%90%A6%E5%88%99%E5%BB%BA%E8%AE%AE%E6%9F%A5%E7%9C%8Bwebapp%EF%BC%8C%E5%9B%A0%E4%B8%BAwebapp%E5%B7%B2%E5%8C%85%E5%90%AB%E6%AD%A4%E6%9C%8D%E5%8A%A1%E5%99%A8%E3%80%82

该socket服务器可用作独立程序或作为库集成，如https://github.com/ttshivers/synclounge/blob/master/server.js%E4%B8%AD%E7%9A%84%E4%BD%BF%E7%94%A8%E6%96%B9%E5%BC%8F%E3%80%82

核心功能与特性

• 提供实时通信能力，支持SyncLounge服务的同步功能
• 可独立运行或作为库集成到其他应用中
• 支持配置端口、静态文件路径、基础URL和ping间隔等参数
• 可通过环境变量或命令行参数灵活配置

使用场景与适用范围

• 需要独立部署SyncLounge socket服务器的场景
• 希望同时运行socket服务器和webapp，通过静态路径配置提供webapp文件
• 开发或扩展SyncLounge相关服务时作为基础组件使用

安装与使用

基本安装（npm）

bash
npm install -g syncloungeserver

基本运行

bash
syncloungeserver

同时提供webapp服务

若需同时提供webapp静态文件服务：

bash
syncloungeserver --static_path /path/to/syncloungewebapp/dist
# 或使用环境变量
STATIC_PATH='/path/to/syncloungewebapp/dist' syncloungeserver

Docker部署示例

基本运行

bash
docker run -d -p 8088:8088 --name synclounge-server synclounge/syncloungeserver

带静态文件服务

bash
docker run -d -p 8088:8088 \
  -v /local/path/to/syncloungewebapp/dist:/app/webapp \
  -e STATIC_PATH=/app/webapp \
  --name synclounge-server synclounge/syncloungeserver

配置选项

所有选项可通过环境变量或命令行参数提供。

端口（Port）

• 默认值：8088
• 命令行参数：--port <端口号>
• 环境变量：PORT=<端口号>

示例：

bash
syncloungeserver --port 1234
# 或
PORT=1234 syncloungeserver

静态文件路径（Static Path）

• 默认值：无（不提供静态文件服务）
• 命令行参数：--static_path <路径>
• 环境变量：STATIC_PATH=<路径>

指定后，服务器将从该目录提供静态文件，适用于同时运行socket服务器和webapp的场景。

示例：

bash
syncloungeserver --static_path /apps/synclounge/dist
# 或
STATIC_PATH='/apps/synclounge/dist' syncloungeserver

基础URL（Base URL）

• 默认值：'/'
• 命令行参数：--base_url <URL路径>
• 环境变量：BASE_URL=<URL路径>

示例：

bash
syncloungeserver --base_url '/somebase'
# 或
BASE_URL='/somebase' syncloungeserver

Ping间隔（Ping Interval）

• 默认值：*** ms（10秒）
• 命令行参数：--ping_interval <毫秒数>
• 环境变量：PING_INTERVAL=<毫秒数>

示例：

bash
syncloungeserver --ping_interval 15000
# 或
PING_INTERVAL=15000 syncloungeserver

手动构建

可克隆仓库自行构建：

bash
git clone https://github.com/synclounge/syncloungeserver.git
cd syncloungeserver
npm install
npm run build

构建后运行：

bash
npm run start