PeerServer: A server for PeerJS

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

Run your own server on Gitpod!

https://peerjs.com

Usage

Run server

Natively

If you don't want to develop anything, just enter few commands below.

• Install the package globally:

$ npm install peer -g

• Run the server:

$ peerjs --port 9000 --key peerjs --path /myapp
Started PeerServer on ::, port: 9000, path: /myapp (v. 0.3.2)

• Check it: http://127.0.0.1:9000/myapp It should returns JSON with name, description and website fields.

Docker

Also, you can use Docker image to run a new container:

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

Kubernetes

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

Create a custom server:

If you have your own server, you can attach PeerServer.

• Install the package:

# $ cd your-project-path
# with npm    $ npm install peer
# with yarn    $ yarn add peer

• Use PeerServer object to create a new server:

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

• Check it: http://127.0.0.1:9000/myapp It should returns JSON with name, description and website fields.

Connecting to the server from client PeerJS:

Config / CLI options

You can provide config object to PeerServer function or specify options for peerjs CLI.

| CLI option | JS option | Description | Required | Default | | ------------------------ | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | :--------: | | --port, -p | port | Port to listen (number) | Yes | | | --key, -k | key | Connection key (string). Client must provide it to call API methods | No | "peerjs" | | --path | path | Path (string). The server responds for requests to the root URL + path. E.g. Set the path to /myapp and run server on 9000 port via peerjs --port 9000 --path /myapp Then open http://127.0.0.1:9000/myapp - you should see a JSON reponse. | No | "/" | | --proxied | proxied | Set true if PeerServer stays behind a reverse proxy (boolean) | No | false | | --expiretimeout, -t | expiretimeout | The amount of time after which a message sent will expire, the sender will then receive a EXPIRE message (milliseconds). | No | 5000 | | --alivetimeout | alivetimeout | Timeout for broken connection (milliseconds). If the server doesn't receive any data from client (includes pong messages), the client's connection will be destroyed. | No | 60000 | | --concurrentlimit, -c | concurrentlimit | Maximum number of clients' connections to WebSocket server (number) | No | 5000 | | --sslkey | sslkey | Path to SSL key (string) | No | | | --sslcert | sslcert | Path to SSL certificate (string) | No | | | --allowdiscovery | allowdiscovery | Allow to use GET /peers http API method to get an array of ids of all connected clients (boolean) | No | | | --cors | corsOptions | The CORS origins that can access this server | | | generateClientId | A function which generate random client IDs when calling /id API method (() => string) | No | uuid/v4 |

Using HTTPS

Simply pass in PEM-encoded certificate and key.

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

You can also pass any other SSL options accepted by https.createServer, such as SNICallback:

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.

By default, PeerServer uses uuid/v4 npm package to generate random client IDs.

You can set generateClientId option in config to specify a custom function to generate client IDs.

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

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

This will start a peerjs server on port 9000 exposed on port 9000 with key peerjs on path /myapp.

• Create a package.json file for GAE to read:

• Create an app.yaml file to configure the GAE application.

• Create server.js (which node will run by default for the start script):

const PORT = process.env.PORT || 9000; const server = app.listen(PORT, () => { console.log(App listening on port ${PORT}); console.log("Press Ctrl+C to quit."); });

gcloud app deploy --project=YOUR-PROJECT-ID-HERE --promote --quiet app.yaml

Privacy

See PRIVACY.md

Problems?

Discuss PeerJS on our Discord community: https://discord.gg/Ud2PvAtK37

Please post any bugs as a Github issue.