https://github.com/innovailable/easy-signaling

A WebRTC signaling server
https://github.com/innovailable/easy-signaling

Last synced: 9 months ago
JSON representation

A WebRTC signaling server

• Host: GitHub
• URL: https://github.com/innovailable/easy-signaling
• Owner: Innovailable
• License: agpl-3.0
• Created: 2014-08-30T23:13:37.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2022-12-14T00:39:03.000Z (over 3 years ago)
• Last Synced: 2025-10-06T22:25:13.281Z (9 months ago)
• Language: CoffeeScript
• Size: 188 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# easy signaling

## What is this?

WebRTC Signaling with as few complexity as possible. It is compatible with

[rtc-lib](https://github.com/Innovailable/rtc-lib). You can use the signaling

server standalone or integrate it in your Node.js project.

## Standalone

Install the package with

    npm install -g easy-signaling

To use the signaling server in standalone mode simply run

    easy-signaling

You can use the environment variables `BIND_PORT` (defaults to 8080) and

`BIND_HOST` (defaults to 0.0.0.0) to configure the listening socket of the

server. A websocket server will be listening on the specified port and provide

signaling to clients.

## Library

If you want to include the server in your project install add the dependency

'easy-signaling' to your package.json.

You can either use a `Hotel` to provide multiple rooms ...

    var hotel = new require("easy-signaling").Hotel()

    hotel.create_guest(connection, "room_name")

... or use `Room` if you need only one room ...

    var room = new require("easy-signaling").Room()

    room.create_guest(connection)

The `connection` object in the examples is a `Channel` implementing the

connectino to the client. You can implement your own `Channel` or use

`WebsocketChannel` which is a wrapper around WebSockets provided by the `ws`

library.

The complete documenation is available

[here](http://innovailable.github.io/easy-signaling/).