peerjs-server/README.md
2019-04-01 17:23:07 +03:00

1.6 KiB

Build Status

PeerServer: A server for PeerJS

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

https://peerjs.com

Run PeerServer

  1. Clone app:
git clone https://github.com/peers/peerjs-server.git
  1. Install dependencies:
npm install
  1. Run the server:
npm run start

Connecting to the server from PeerJS:

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

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

node ./src/index.js --port 9000 --path /myapp --sslKeyPath /path/to/your/ssl/key/here.key --sslCertPath /path/to/your/ssl/certificate/here.crt

Running PeerServer behind a reverse proxy

Make sure to set the proxied option. The option is passed verbatim to the expressjs trust proxy setting if it is truthy.

node ./src/index.js --port 9000 --path /myapp --proxied true

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 Google Group: https://groups.google.com/forum/?fromgroups#!forum/peerjs

Please post any bugs as a Github issue.