peerjs-server

Server for PeerJS

Github星跟蹤圖

Build Status
npm version
Downloads

PeerServer: A server for PeerJS

PeerServer helps broker connections between PeerJS clients. Data is not proxied through the server.

Run your own server on Gitpod!

Open in Gitpod

https://peerjs.com

Run PeerServer

  1. Install PeerServer from npm or github:

NPM

npm install peer

github

git clone https://github.com/peers/peerjs-server.git#master
npm install
  1. Run the server:
$> peerjs --port 9000 --key peerjs --path /myapp

Or, create a custom server:

const { PeerServer } = require('peer');
const server = PeerServer({port: 9000, path: '/myapp'});
  1. Check that server works: open browser with http://localhost:9000/myapp It should returns JSON with name, description and website fields.

Connecting to the server from PeerJS:

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

Using HTTPS: Simply pass in PEM-encoded certificate and key.

const fs = require('fs');
const { PeerServer } = require('peer');

const server = PeerServer({
  port: 9000,
  ssl: {
    key: fs.readFileSync('/path/to/your/ssl/key/here.key'),
    cert: fs.readFileSync('/path/to/your/ssl/certificate/here.crt')
  }
});

Running PeerServer behind a reverse proxy

Make sure to set the proxied option, otherwise IP based limiting will fail.
The option is passed verbatim to the
expressjs trust proxy setting
if it is truthy.

const { PeerServer } = require('peer');
const server = PeerServer({port: 9000, path: '/myapp', proxied: true});

Combining with existing express app

const express = require('express');
const app = express();
const { ExpressPeerServer } = require('peer');

app.get('/', (req, res, next) => { res.send('Hello world!'); });

// =======

const server = app.listen(9000);

const options = {
    debug: true
}

const peerserver = ExpressPeerServer(server, options);

app.use('/api', peerserver);

// == OR ==

const server = require('http').createServer(app);
const peerserver = ExpressPeerServer(server, options);

app.use('/peerjs', peerserver);

server.listen(9000);

// ========

Events

The 'connection' event is emitted when a peer connects to the server.

peerserver.on('connection', (client) => { ... });

The 'disconnect' event is emitted when a peer disconnects from the server or
when the peer can no longer be reached.

peerserver.on('disconnect', (client) => { ... });

Running tests

npm test

Docker

You can build this image simply by calling:

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

To run the image execute this:

docker run -p 9000:9000 -d peerjs

This will start a peerjs server on port 9000 exposed on port 9000.

Problems?

Discuss PeerJS on our Telegram chat:
https://t.me/joinchat/ENhPuhTvhm8WlIxTjQf7Og

Please post any bugs as a Github issue.

主要指標

概覽
名稱與所有者peers/peerjs-server
主編程語言TypeScript
編程語言JavaScript (語言數: 3)
平台
許可證MIT License
所有者活动
創建於2013-01-05 06:49:08
推送於2025-07-01 17:55:37
最后一次提交2025-07-01 11:57:11
發布數30
最新版本名稱v1.1.0-rc.2 (發布於 )
第一版名稱0.1.2 (發布於 )
用户参与
星數4.6k
關注者數137
派生數1.1k
提交數0.9k
已啟用問題?
問題數232
打開的問題數36
拉請求數133
打開的拉請求數8
關閉的拉請求數60
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?