Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libp2p/js-libp2p-websocket-star-rendezvous
The rendezvous service for libp2p-websocket-star enabled nodes meet and talk with each other
https://github.com/libp2p/js-libp2p-websocket-star-rendezvous
Last synced: 4 months ago
JSON representation
The rendezvous service for libp2p-websocket-star enabled nodes meet and talk with each other
- Host: GitHub
- URL: https://github.com/libp2p/js-libp2p-websocket-star-rendezvous
- Owner: libp2p
- License: mit
- Archived: true
- Created: 2017-09-08T08:21:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-10T10:45:28.000Z (over 4 years ago)
- Last Synced: 2024-04-25T20:21:22.661Z (8 months ago)
- Language: JavaScript
- Size: 1.23 MB
- Stars: 24
- Watchers: 16
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
⛔️ DEPRECATED: libp2p-websocket-star-rendezvous is not supported anymore from [[email protected]](https://github.com/libp2p/js-libp2p/releases/tag/v0.27.0). Check [js-libp2p/doc/CONFIGURATION.md](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md) for what modules are currently supported.
# libp2p-websocket-star-rendezvous
[](http://ipn.io)
[](http://libp2p.io/)
[](http://webchat.freenode.net/?channels=%23libp2p)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-libp2p-websocket-star-rendezvous)
[](https://travis-ci.com/libp2p/js-libp2p-websocket-star-rendezvous)
[](https://david-dm.org/libp2p/js-libp2p-websocket-star-rendezvous)
[](https://github.com/feross/standard)
> The rendezvous service for [libp2p-websocket-star](https://github.com/libp2p/js-libp2p-websocket-star).
## Lead Maintainer
[Jacob Heun](https://github.com/jacobheun)
## Descriptions
Nodes using `libp2p-websocket-star` will connect to a known point in the network, a rendezvous point where they can learn about other nodes (Discovery) and route their messages to other nodes (2 hop message routing, also known as relay).
## Usage
`libp2p-websocket-star-rendezvous` is the rendezvous server required for `libp2p-websocket-star` and can be used to start a rendezvous server for development. To do that, first install the module globally in your machine with:
```bash
> npm install --global libp2p-websocket-star-rendezvous
```
This will install a `rendezvous` CLI tool. Now you can spawn the server with:
```bash
> rendezvous --port=9090 --host=127.0.0.1
```
Defaults:
- `port` - 9090
- `host` - '0.0.0.0'
## Docker
A docker image is offered for running this service in production
```
docker pull libp2p/websocket-star-rendezvous:release
docker run -d -p 9090:9090 --name rendezvous libp2p/websocket-star-rendezvous:release
```
To disable prometheus metrics run the server with `-e DISABLE_METRICS=1`
```
docker run -d -p 9090:9090 --name rendezvous -e DISABLE_METRICS=1 libp2p/websocket-star-rendezvous:release
```
## Hosted Rendezvous server
We host a rendezvous server at `ws-star.discovery.libp2p.io` that can be used for practical demos and experimentation, it **should not be used for apps in production**.
A libp2p-websocket-star address, using the signalling server we provide, looks like:
`/dns4/ws-star.discovery.libp2p.io/wss/p2p-websocket-star/ipfs/`
Note: The address above indicates WebSockets Secure, which can be accessed from both http and https.
### Using WSS
To be able to interact with a rendezvous server from an HTTPS site, you will need to use websocket secure. To host a secure websocket server, you must provide a keypair to the server.
#### Using key and certificate
```bash
> rendezvous --key="path/to/key.key" --cert="path/to/cert.cert"
```
#### Using PFX with passphrase
```bash
> rendezvous --pfx="path/to/pair.pfx" --passphrase="passphrase"
```
### This module uses `pull-streams`
We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
You can learn more about pull-streams at:
- [The history of Node.js streams, nodebp April 2014](https://www.youtube.com/watch?v=g5ewQEuXjsQ)
- [The history of streams, 2016](http://dominictarr.com/post/145135293917/history-of-streams)
- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
- [pull-streams documentation](https://pull-stream.github.io/)
#### Converting `pull-streams` to Node.js Streams
If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/pull-stream/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
```js
const pullToStream = require('pull-stream-to-stream')
const nodeStreamInstance = pullToStream(pullStreamInstance)
// nodeStreamInstance is an instance of a Node.js Stream
```
To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
LICENSE MIT