peerjs/peerjs-server

PeerServer：PeerJS的信令服务器镜像

镜像概述和主要用途

PeerServer是PeerJS的信令服务器，用于帮助PeerJS客户端建立直接的P2P连接，数据传输不经过服务器代理。该Docker镜像提供即用型部署方案，支持多种配置选项，适用于需要建立P2P通信的应用场景。

核心功能和特性

• 支持WebSocket连接，实现客户端间信令交换
• 提供灵活的配置选项，包括端口、路径、密钥等
• 支持HTTPS加密通信
• 可与现有Express应用集成
• 提供连接和断开事件监听
• 支持反向代理部署
• 允许自定义客户端ID生成规则

使用场景和适用范围

适用于需要建立P2P连接的各类应用，如：

• 视频/音频通话应用
• 实时文件共享工具
• 在线协作平台
• 多人游戏
• 实时数据同步应用

使用方法和配置说明

Docker部署

基本运行

sh
docker run -p 9000:9000 -d peerjs/peerjs-server

自定义端口和路径

sh
docker run -p 8080:8080 -d peerjs/peerjs-server --port 8080 --path /myapp

Kubernetes部署

sh
kubectl run peerjs-server --image=peerjs/peerjs-server --port 9000 --expose -- --port 9000 --path /myapp

配置参数说明

使用HTTPS

通过传递PEM编码的证书和密钥启用HTTPS：

javascript
const fs = require("fs");
const { PeerServer } = require("peer");

const peerServer = PeerServer({
  port: 9000,
  ssl: {
    key: fs.readFileSync("/path/to/ssl/key.key"),
    cert: fs.readFileSync("/path/to/ssl/certificate.crt"),
  },
});

也可传递其他HTTPS选项，如SNICallback：

javascript
const fs = require("fs");
const { PeerServer } = require("peer");

const peerServer = PeerServer({
  port: 9000,
  ssl: {
    SNICallback: (servername, cb) => {
      // 自定义SNI处理逻辑
    },
  },
});

反向代理部署

若PeerServer位于反向代理后，需设置proxied选项：

javascript
const { PeerServer } = require("peer");

const peerServer = PeerServer({
  port: 9000,
  path: "/myapp",
  proxied: true, // 传递给express的trust proxy设置
});

自定义客户端ID生成

默认使用uuid/v4生成客户端ID，可通过generateClientId选项自定义：

javascript
const { PeerServer } = require("peer");

const customGenerationFunction = () =>
  (Math.random().toString(36) + "0000000000000000000").substr(2, 16);

const peerServer = PeerServer({
  port: 9000,
  path: "/myapp",
  generateClientId: customGenerationFunction,
});

访问[***]

与现有Express应用结合

javascript
const express = require("express");
const { ExpressPeerServer } = require("peer");

const app = express();

app.get("/", (req, res) => res.send("Hello world!"));

const server = app.listen(9000);

const peerServer = ExpressPeerServer(server, {
  path: "/myapp",
});

app.use("/peerjs", peerServer);

访问[***]

事件监听

• connection：当客户端连接到服务器时触发

javascript
peerServer.on('connection', (client) => { /* 处理连接事件 */ });

• disconnect：当客户端断开连接或无法访问时触发

javascript
peerServer.on('disconnect', (client) => { /* 处理断开事件 */ });

构建自定义镜像

sh
docker build -t my-peerjs-server https://github.com/peers/peerjs-server.git

运行自定义镜像：

sh
docker run -p 9000:9000 -d my-peerjs-server

客户端连接示例

html
<script>
  const peer = new Peer("someid", {
    host: "localhost",
    port: 9000,
    path: "/myapp",
  });
</script>