Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

node-uuid -> uuid #136

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,53 @@

The open-source version of SimpleWebRTC has been deprecated. This repository will remain as-is but is no longer actively maintained.
Read more about the "new" SimpleWebRTC (which is an entirely different thing) on https://simplewebrtc.com

# signalmaster

A simple signaling server for clients to connect and do signaling for WebRTC.

Specifically created as a default connection point for [SimpleWebRTC.js](https://github.com/HenrikJoreteg/SimpleWebRTC)

It also supports vending STUN/TURN servers with the shared secret mechanism as described in [this draft](http://tools.ietf.org/html/draft-uberti-behave-turn-rest-00). This mechanism is implemented e.g. by [rfc-5766-turn-server](https://code.google.com/p/rfc5766-turn-server/) or by a [patched version](https://github.com/otalk/restund) of [restund](http://creytiv.com/restund.html).
It also supports vending STUN/TURN servers with the shared secret mechanism as described in [this draft](http://tools.ietf.org/html/draft-uberti-behave-turn-rest-00). This mechanism is implemented e.g. by [rfc-5766-turn-server](https://code.google.com/p/rfc5766-turn-server/) or by a [patched version](https://github.com/otalk/restund) of [restund](http://creytiv.com/restund.html).

Read more:
- [Introducing SimpleWebRTC and conversat.io](http://blog.andyet.com/2013/02/22/introducing-simplewebrtcjs-and-conversatio/)
- [SimpleWebRTC.com](http://simplewebrtc.com)
- [talky.io](https://talky.io)

- [Introducing SimpleWebRTC and conversat.io](http://blog.andyet.com/2013/02/22/introducing-simplewebrtcjs-and-conversatio/)
- [SimpleWebRTC.com](http://simplewebrtc.com)
- [talky.io](https://talky.io)

## Running

Running the server requires a valid installation of node.js which can be installed from the nodejs.org website. After installing the package you will need to install the node dependencies.

1) npm install
1. npm install

2) run the server using "node server.js"
2. run the server using "node server.js"

3) In the console you will see a message which tells you where the server is running:
3. In the console you will see a message which tells you where the server is running:

"signal master is running at: http://localhost:8888"
"signal master is running at: http://localhost:8888"

4) Open a web browser to the specified URL and port to ensure that the server is running properly. You should see the message when you go to the /socket.io/ subfolder (e.g. http://localhost:8888/socket.io/), you should see a message like this:
4. Open a web browser to the specified URL and port to ensure that the server is running properly. You should see the message when you go to the /socket.io/ subfolder (e.g. http://localhost:8888/socket.io/), you should see a message like this:

{"code":0,"message":"Transport unknown"}
{"code":0,"message":"Transport unknown"}

### Production Environment
* generate your ssl certs

- generate your ssl certs

```shell
$ ./scripts/generate-ssl-certs.sh
```
* run in Production mode

- run in Production mode

```shell
$ NODE_ENV=production node server.js
```

## Use with Express

var express = require('express')
var sockets = require('signalmaster/sockets')

Expand All @@ -53,11 +58,13 @@ $ NODE_ENV=production node server.js

## Docker

You can build this image by calling:
You can build this image by calling:

docker build -t signalmaster https://github.com/moaazsidat/signalmaster.git

docker build -t signalmaster https://github.com/andyet/signalmaster.git
(old) docker build -t signalmaster https://github.com/andyet/signalmaster.git

To run the image execute this:
To run the image execute this:

docker run --name signalmaster -d -p 8888:8888 signalmaster

Expand Down
10 changes: 4 additions & 6 deletions config/production.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@
"/* maxClients */": "/* maximum number of clients per room. 0 = no limit */",
"maxClients": 0
},
"stunservers": [
{
"urls": "$STUNSERVER_URL"
}
],
"stunservers": [{
"urls": "stun:stun.l.google.com:19302"
}],
"turnservers": []
}
}
Loading