Tidak Ada Deskripsi

afrokick 5e8d824ee4 fix npm audit 5 tahun lalu
.github 279d43f49b Create dockerimage.yml 5 tahun lalu
bin dd0b60416e ref 6 tahun lalu
dist a956168f55 fix issue with expire messages 5 tahun lalu
src a956168f55 fix issue with expire messages 5 tahun lalu
test a956168f55 fix issue with expire messages 5 tahun lalu
.eslintignore 42a626629b add eslint for ts 6 tahun lalu
.eslintrc.json c4f04b2ff8 add tests for WebSocketServer 5 tahun lalu
.gitignore dd0b60416e ref 6 tahun lalu
.gitpod.yml 8c48d6092a Update .gitpod.yml 5 tahun lalu
.travis.yml 1e09fcfb64 ref 6 tahun lalu
Dockerfile 2ee176e690 fix Dockerfile 5 tahun lalu
LICENSE b8dbd1f249 license and updated package json 12 tahun lalu
README.md 2109b916f5 docs: specify path for express integration 5 tahun lalu
app.json bd101ab44f enable "Deploy to Heroku" Button 10 tahun lalu
changelog.md 5e8d824ee4 fix npm audit 5 tahun lalu
package-lock.json 5e8d824ee4 fix npm audit 5 tahun lalu
package.json a956168f55 fix issue with expire messages 5 tahun lalu
tsconfig.json 7c23ed8351 fix warnings 5 tahun lalu

README.md

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
    path: '/peerjs'
}

const peerserver = ExpressPeerServer(server, options);

app.use(options.path, peerserver);

// == OR ==

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

app.use(options.path, 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.