Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bengreenier/node-dss
dead simple signalling for webrtc.
https://github.com/bengreenier/node-dss
webrtc webrtc-signaling
Last synced: 3 months ago
JSON representation
dead simple signalling for webrtc.
- Host: GitHub
- URL: https://github.com/bengreenier/node-dss
- Owner: bengreenier
- License: mit
- Created: 2019-02-26T22:20:32.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:16:03.000Z (about 2 years ago)
- Last Synced: 2024-10-14T07:49:07.506Z (4 months ago)
- Topics: webrtc, webrtc-signaling
- Language: JavaScript
- Size: 193 KB
- Stars: 57
- Watchers: 4
- Forks: 33
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-dss
[![Build Status](https://travis-ci.org/bengreenier/node-dss.svg?branch=master)](https://travis-ci.org/bengreenier/node-dss)
dead simple signalling for webrtc.
## Why
Think of this as a message broker service. It allows you to pass messages to a predetermined reciever. We use this as a lightweight replacement for a signalling server, where both clients have known identities. This saves us from the more complex logic of tracking live clients, and communicating peer 'join' and 'leave' events.
## How
> Note: To see logs, use the environment variable `DEBUG` with the `dss` namespace. IE: `set DEBUG=dss*`.
You'll need to install [nodejs](https://nodejs.org) to leverage this service.
First install dependencies with [npm](http://npmjs.com/) - from the project directory run: `npm install`. Then run the service with `npm start` from the project directory.
__Without the `DEBUG` environment variable set as-documented above, there will be no output from the process indicating a successful start.__
### Check for a message
Use `GET` to `/data/:id` where `:id` identifies your client
#### No messages for you
```
GET /data/user1 HTTP/1.1
Host: localhost:3000404
```
#### You have a message
```
GET /data/user1 HTTP/1.1
Host: localhost:3000200
```
### Post a message
Use `POST` to `/data/:id` where `:id` identifies the destination client. The body is your message. MIME not required.
#### Message uploaded
```
POST /data/user1 HTTP/1.1
Host: localhost:3000200
```
## License
MIT