Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 1.61 KB

README.md

File metadata and controls

59 lines (44 loc) · 1.61 KB
Raw

WebSocket signaling server for y-webrtc

A WebSocket signaling server for y-webrtc peers.

About

This WebSocket signaling server listens for messages sent by y-webrtc implementations responding to subscribe, unsubscribe, publish, and ping messages from peers.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

  1. Clone repository
git clone [email protected]:ferviddigital/y-webrtc-signaler.git
  1. Install NPM packages
cd y-webrtc-signaler
npm install

Usage

npm run dev

Client code

const provider = new WebrtcProvider('your-room-name', ydoc, {
  //...
  signaling: [
    'ws://localhost:8787'
  ]
});

Deployment

You can deploy this code on:

Heroku

Deploy

Render

Deploy to Render

Google Cloud

Run on Google Cloud

Roadmap

  • Make easily deployable to cloud services

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

y-webrtc-signaler is licensed under the MIT License.

Roy McKenzie - [email protected]