signal-fire-relay-redis v0.3.0

WebRTC Signaling Server for node.js

Note: Starting with signal-fire 0.4.0, this relay is deprecated. Use signal-fire-relay instead!

signal-fire-relay-redis is a relay for signal-fire, a horizontally scalable signaling server for WebRTC. This module can be used as a reference implementation for writing your own relays.

For more information about the actual server module, see signal-fire.

Install

Install using npm:

npm i signal-fire-relay-redis --save

Usage

It's easy to add the relay to signal-fire:

const Server = require('signal-fire').Server
const Relay = require('signal-fire-relay-redis').Relay

const relay = new Relay({
  // These options are passed to `redis.createClient()`
})

// Create a server with the relay set
const server = new Server({
  relay: relay
})

That's all!

Changelog

• v0.3.0
  • Added deprecation notice. Starting with signal-fire v0.4.0, use signal-fire-relay instead!
• v0.2.0
  • The error event on the MQTT connection is now re-emitted
  • Renamed .relay() to .send() (breaking change, only compatible with signal-fire 0.3.0 or higher!)
• v0.1.0
  • Initial release

License

Copyright 2016 Michiel van der Velde.

This software is licensed under the MIT License.