Sin descripción

lmb be66a1b346 Fix bin/peerjs hace 10 años
bin be66a1b346 Fix bin/peerjs hace 10 años
lib be66a1b346 Fix bin/peerjs hace 10 años
test eb4f31dabd Tests with _server startup and teardown callbacks hace 10 años
.gitignore 1c5b22c93c move things around hace 12 años
.travis.yml 102b39f066 change version hace 12 años
LICENSE b8dbd1f249 license and updated package json hace 12 años
README.md 2ce55f8e33 Pass `server` or `port` option to PeerServer hace 10 años
changelog.md 7335327b44 0.2.6 hace 11 años
package.json 9e0d861715 Migrate to express from restify hace 10 años

README.md

Build Status

PeerServer: A server for PeerJS

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

##http://peerjs.com

If you prefer to use a cloud hosted PeerServer instead of running your own, sign up for a free API key here

Run PeerServer

Install the library:

$> npm install peer

Run the server:

$> peerjs --port 9000 --key peerjs

Or, create a custom server:

var PeerServer = require('peer').PeerServer;
var server = PeerServer({port: 9000, path: '/myapp'});

Connecting to the server from PeerJS:

<script>
    // No API key required when not using cloud server
    var peer = new Peer('someid', {host: 'localhost', port: 9000, path: '/myapp'});
</script>

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

var fs = require('fs');
var PeerServer = require('peer').PeerServer;

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

Combining with existing express app

WebSocket server needs server instance to bootup, so we should create express app, then get server from listen method and only after that bind PeerServer to express application.

var express = require('express');
var app = express();
var PeerServer = require('peer').PeerServer;

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

var server = app.listen(9000);

app.use(PeerServer({ server: server, path: '/api' }));

Events

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

server.on('connection', function(id) { ... })

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

server.on('disconnect', function(id) { ... })

Problems?

Discuss PeerJS on our Google Group: https://groups.google.com/forum/?fromgroups#!forum/peerjs

Please post any bugs as a Github issue.