@jacktea/pdf-viewer-server 0.1.3 → 0.1.4

package/README.md

@@ -0,0 +1,66 @@
+# @jacktea/pdf-viewer-server
+
+Jacktea PDF Viewer 的实时协作后端服务，基于 Socket.io 实现。
+
+## 简介
+
+如果你希望在你的 PDF 预览器中接入多人实时协作功能（如：实时看到别人的高亮、批注、评论拉取与同步），可以使用此 Node.js 服务。
+
+服务端主要负责多端状态同步和协同数据的分发，目前作为本地运行或自行部署的独立微服务使用。
+
+## 特性
+
+- ⚡ **实时光标与轨迹**：可以看到其他协作者的鼠标滚动和选择轨迹。
+- 🔄 **秒级同步更新**：文档中的任何批注添加与修改均会基于房间隔离实时广播。
+- 🔒 **权限拦截机制**：内置房间与用户身份概念的验证能力。
+
+## 安装
+
+你可以全局安装作为 CLI 服务启动：
+
+```bash
+npm install -g @jacktea/pdf-viewer-server
+```
+
+或者在你的自有工程中配合脚本启动：
+
+```bash
+npm install @jacktea/pdf-viewer-server
+```
+
+## 启动服务
+
+### 1. 全局 CLI 方式 (开发调试)
+
+全局安装后，在终端任意目录直接执行：
+
+```bash
+pdf-viewer-server
+```
+*(默认监听 `3000` 端口)*
+
+### 2. 作为 Node 包在你的项目中启动
+
+你可以通过 npm scripts 启动：
+
+```json
+{
+  "scripts": {
+    "start:collab": "pdf-viewer-server"
+  }
+}
+```
+
+### 3. Server 配置环境变量
+
+服务支持通过配置环境变量来控制行为，例如：
+
+```bash
+PORT=8080 CORS_ORIGINS="https://app.example.com" pdf-viewer-server
+```
+
+主要参量：
+- `PORT`: 启动端口 (默认 `3000`)
+- `CORS_ORIGINS`: 允许跨域请求的域名白名单，逗号分隔
+- `ALLOW_ALL_ORIGINS`: `true` (开启无限制 CORS，仅开发环境)
+- `REQUIRE_AUTH`: `true` | `false` (是否必须校验认证 token)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jacktea/pdf-viewer-server",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "private": false,
   "bin": {
     "pdf-viewer-server": "./dist/server.js"