@libp2p/webrtc-star-signalling-server
signalling server to use with the libp2p WebRTC transport
Table of contents
Install
$ npm i @libp2p/webrtc-star-signalling-server
Description
Nodes using the libp2p-webrtc-star
transport will connect to a known point in the network, a rendezvous point where they can learn about other nodes (Discovery) and exchange their SDP offers (signalling data).
Usage
To start a server run:
$ webrtc-star --port=13579 --host=127.0.0.1
Defaults:
port
- 9090host
- '0.0.0.0'
Or in JavaScript:
import { sigServer } from '@libp2p/webrtc-star-signalling-server'
const server = await sigServer({
port: 24642,
host: '0.0.0.0',
metrics: false
})
await server.stop()
Hosted Rendezvous Server
We host signaling servers at wrtc-star1.par.dwebops.pub
and wrtc-star2.sjc.dwebops.pub
, that can be used for practical demos and experimentation, it should not be used for apps in production. Check Deployment.md for how to deploy your own server.
A libp2p-webrtc-star address, using the signalling server we provide, looks like:
/dns4/wrtc-star1.par.dwebops.pub/tcp/443/wss/p2p-webrtc-star/p2p/<your-peer-id>
Note: The address above indicates WebSockets Secure, which can be accessed from both http and https.
License
Licensed under either of
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.