Back to notes

peers/peerjs-server

AI summary · Qwen Summary in Chinese Indexed
Original source

该页面介绍了 PeerJS 服务器 PeerServer 的用途、运行方式、配置选项、HTTPS 与代理设置、Express 集成以及部署和测试方法。

项目定位

  • PeerServer 是 PeerJS 的服务器。
  • 它帮助 PeerJS 客户端建立连接。
  • 数据不通过服务器代理。

运行方式

  • 可通过 npm 全局安装 peer 后使用 peerjs 命令启动。
  • 可使用 Docker 镜像 peerjs/peerjs-server 运行。
  • 可使用 kubectl 在 Kubernetes 中运行该镜像。

自定义服务器

  • 在 Node.js 项目中安装 peer 后,可使用 PeerServer 创建服务器。
  • 客户端 Peer 可通过 host、port 和 path 连接服务器。
  • 访问服务器路径可返回包含 name、description 和 website 字段的 JSON。

配置选项

  • CLI 和 JS 配置支持 port、key、path、proxied、expire_timeout、alive_timeout 和 concurrent_limit。
  • port 是必填项,key 默认值为 peerjs,path 默认值为 /。
  • 支持 SSL 证书、allow_discovery、CORS 和自定义 generateClientId。

HTTPS 与反向代理

  • 可传入 PEM 编码的 SSL 证书和密钥启用 HTTPS。
  • 支持传入 https.createServer 接受的 SSL 选项,例如 SNICallback。
  • 在反向代理后运行时,应设置 proxied 为 true。

集成与事件

  • 可通过 ExpressPeerServer 与现有 Express 应用集成。
  • 服务器在 peer 连接时发出 connection 事件。
  • 服务器在 peer 断开或不可达时发出 disconnect 事件。

部署与测试

  • 可使用 npm test 运行测试。
  • Docker Hub 提供可直接使用的 peerjs/peerjs-server 镜像。
  • 文档提供了在 Google App Engine 上部署的示例,需要 flex 环境以支持 WebSocket。