Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mafintosh/signalhub
Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff.
https://github.com/mafintosh/signalhub
Last synced: 13 days ago
JSON representation
Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff.
- Host: GitHub
- URL: https://github.com/mafintosh/signalhub
- Owner: mafintosh
- License: mit
- Created: 2015-04-16T22:58:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T18:17:25.000Z (9 months ago)
- Last Synced: 2024-10-04T09:57:54.264Z (about 1 month ago)
- Language: JavaScript
- Size: 55.7 KB
- Stars: 667
- Watchers: 21
- Forks: 96
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-peer-to-peer - signalhub
- awesome-dat - signalhub - simple signalling server that can be used to coordinate handshaking with webrtc (Dat Core Modules / Networking)
- awesome-peer-to-peer - signalhub
- awesome-network-js - signalhub
- starred-awesome - signalhub - Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff. (JavaScript)
- awesome-starred - mafintosh/signalhub - Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff. (others)
README
# signalhub
Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff.
```
npm install signalhub
```
Or to install the command line tool
```
npm install -g signalhub
```
[](http://travis-ci.org/mafintosh/signalhub)
## Usage
``` js
var signalhub = require('signalhub')
var hub = signalhub('my-app-name', [
'http://yourhub.com'
])
hub.subscribe('my-channel')
.on('data', function (message) {
console.log('new message received', message)
})
hub.broadcast('my-channel', {hello: 'world'})
```
## API
#### `hub = signalhub(appName, urls)`
Create a new hub client. If you have more than one hub running specify them in an array
``` js
// use more than one server for redundancy
var hub = signalhub('my-app-name', [
'https://signalhub1.example.com',
'https://signalhub2.example.com',
'https://signalhub3.example.com'
])
```
The `appName` is used to namespace the subscriptions/broadcast so you can reuse the
signalhub for more than one app.
#### `stream = hub.subscribe(channel)`
Subscribe to a channel on the hub. Returns a readable stream of messages
#### `hub.broadcast(channel, message, [callback])`
Broadcast a new message to a channel on the hub
#### `hub.close([callback])`
Close all subscriptions
## CLI API
You can use the command line api to run a hub server
```
signalhub listen -p 8080 # starts a signalhub server on 8080
```
To listen on https, use the `--key` and `--cert` flags to specify the path to the private
key and certificate files, respectively. These will be passed through to the node `https`
package.
To avoid logging to console on every subscribe/broadcast event use the `--quiet` or `-q` flag.
Or broadcast/subscribe to channels
```
signalhub broadcast my-app my-channel '{"hello":"world"}' -p 8080 -h yourhub.com
signalhub subscribe my-app my-channel -p 8080 -h yourhub.com
```
## Browserify
This also works in the browser using browserify :)
## Publicly available signalhubs
Through the magic of free hosting, here are some free open signalhub servers!
For serious applications though, consider deploying your own instances.
- https://signalhub-jccqtwhdwc.now.sh
- https://signalhub-hzbibrznqa.now.sh
## Deploying with popular services
No additional configuration is needed.
### now.sh
```
now mafintosh/signalhub
```
### Heroku
[](https://heroku.com/deploy)
## License
MIT