120 lines
2.6 KiB
Markdown
120 lines
2.6 KiB
Markdown
[](https://travis-ci.org/peers/peerjs-server)
|
|
|
|
# PeerServer: A server for PeerJS #
|
|
|
|
PeerServer helps broker connections between PeerJS clients. Data is not proxied through the server.
|
|
|
|
## [http://peerjs.com](http://peerjs.com)
|
|
|
|
### Run PeerServer
|
|
|
|
Install the library:
|
|
|
|
```bash
|
|
$> npm install peer
|
|
```
|
|
|
|
Run the server:
|
|
|
|
```bash
|
|
$> peerjs --port 9000 --key peerjs
|
|
```
|
|
|
|
Or, create a custom server:
|
|
|
|
```javascript
|
|
var PeerServer = require('peer').PeerServer;
|
|
var server = PeerServer({port: 9000, path: '/myapp'});
|
|
```
|
|
|
|
Connecting to the server from PeerJS:
|
|
|
|
```html
|
|
<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.
|
|
|
|
```javascript
|
|
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'),
|
|
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](http://expressjs.com/4x/api.html#app-settings)
|
|
if it is truthy.
|
|
|
|
```javascript
|
|
var PeerServer = require('peer').PeerServer;
|
|
var server = PeerServer({port: 9000, path: '/myapp', proxied: true});
|
|
```
|
|
|
|
### Combining with existing express app
|
|
|
|
```javascript
|
|
var express = require('express');
|
|
var app = express();
|
|
var ExpressPeerServer = require('peer').ExpressPeerServer;
|
|
|
|
app.get('/', function(req, res, next) { res.send('Hello world!'); });
|
|
|
|
// =======
|
|
|
|
var server = app.listen(9000);
|
|
|
|
var options = {
|
|
debug: true
|
|
}
|
|
|
|
var peerserver = ExpressPeerServer(server, options);
|
|
|
|
app.use('/api', peerserver);
|
|
|
|
// == OR ==
|
|
|
|
var server = require('http').createServer(app);
|
|
var peerserver = ExpressPeerServer(server, options);
|
|
|
|
app.use('/peerjs', peerserver);
|
|
|
|
server.listen(9000);
|
|
|
|
// ========
|
|
```
|
|
|
|
### Events
|
|
|
|
The `'connection'` event is emitted when a peer connects to the server.
|
|
|
|
```javascript
|
|
peerserver.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.
|
|
|
|
```javascript
|
|
peerserver.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.
|