No Description

Michelle Bu 7335327b44 0.2.6 11 years ago
bin 8c1eb5d978 Allow discovery 11 years ago
lib 9b3f7a3f38 Make IDs *always* 16 characters 11 years ago
test 9b3f7a3f38 Make IDs *always* 16 characters 11 years ago
.gitignore 1c5b22c93c move things around 12 years ago
.travis.yml 102b39f066 change version 12 years ago
LICENSE b8dbd1f249 license and updated package json 12 years ago
README.md 2983739725 Update README and script to accept path 11 years ago
changelog.md 7335327b44 0.2.6 11 years ago
package.json 7335327b44 0.2.6 11 years ago

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 = new 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 = new PeerServer({
  port: 9000,
  ssl: {
    key: fs.readFileSync('/path/to/your/ssl/key/here.key'),
    certificate: fs.readFileSync('/path/to/your/ssl/certificate/here.crt')
  }
});

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.