Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
docs: remove websocket-star docs
Browse files Browse the repository at this point in the history
[`libp2p-websocket-star`](libp2p/js-libp2p-websocket-star#57) has a security vulnerability and was not converted in the refactor. This PR removes the `libp2p-websocket-star` information until libp2p/js-libp2p-stardust#14 lands and we can recommend using it instead.

refs #2600
  • Loading branch information
Alan Shaw authored Feb 7, 2020
1 parent e493673 commit 65e7105
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ We've come a long way, but this project is still in Alpha, lots of development i
- [How to enable WebRTC support for js-ipfs in the Browser](#how-to-enable-webrtc-support-for-js-ipfs-in-the-browser)
- [Is there WebRTC support for js-ipfs with Node.js?](#is-there-webrtc-support-for-js-ipfs-with-nodejs)
- [How can I configure an IPFS node to use a custom `signaling endpoint` for my WebRTC transport?](#how-can-i-configure-an-ipfs-node-to-use-a-custom-signaling-endpoint-for-my-webrtc-transport)
- [Is there a more stable alternative to webrtc-star that offers a similar functionality?](#is-there-a-more-stable-alternative-to-webrtc-star-that-offers-a-similar-functionality)
- [I see some slowness when hopping between tabs Chrome with IPFS nodes, is there a reason why?](#i-see-some-slowness-when-hopping-between-tabs-chrome-with-ipfs-nodes-is-there-a-reason-why)
- [Can I use IPFS in my Electron App?](#can-i-use-ipfs-in-my-electron-app)
- [Have more questions?](#have-more-questions)
Expand Down Expand Up @@ -1072,24 +1071,6 @@ const node = await IPFS.create({
The code above assumes you are running a local `signaling server` on port `9090`. Provide the correct values accordingly.
#### Is there a more stable alternative to webrtc-star that offers a similar functionality?
Yes, websocket-star! A WebSockets based transport that uses a Relay to route the messages. To enable it, just do:
```JavaScript
const node = await IPFS.create({
config: {
Addresses: {
Swarm: [
'/dns4/ws-star.discovery.libp2p.io/tcp/443/wss/p2p-websocket-star'
]
}
}
})

// your instance with websocket-star is ready
```
#### I see some slowness when hopping between tabs Chrome with IPFS nodes, is there a reason why?
Yes, unfortunately, due to [Chrome aggressive resource throttling policy](https://github.com/ipfs/js-ipfs/issues/611), it cuts freezes the execution of any background tab, turning an IPFS node that was running on that webpage into a vegetable state.
Expand Down

0 comments on commit 65e7105

Please sign in to comment.