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

Commit 979af0e

Browse files
committed
add websocket-star to FAQ
1 parent 5a927bb commit 979af0e

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ const node = new IPFS({
334334
config: {
335335
Addresses: {
336336
Swarm: [
337-
"/dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star"
337+
'/dns4/wrtc-star.discovery.libp2p.io/wss/p2p-webrtc-star'
338338
]
339339
}
340340
}
@@ -369,7 +369,7 @@ const node = new IPFS({
369369
Swarm: [
370370
"/ip4/0.0.0.0/tcp/4002",
371371
"/ip4/127.0.0.1/tcp/4003/ws",
372-
"/dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star"
372+
"/dns4/wrtc-star.discovery.libp2p.io/wss/p2p-webrtc-star"
373373
]
374374
}
375375
},
@@ -394,7 +394,7 @@ npm install wrtc --global
394394
npm install electron-webrtc --global
395395
```
396396

397-
Then, update your IPFS Daemon config to include the multiaddr for this new transport on the `Addresses.Swarm` array. Add: `"/dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star"`
397+
Then, update your IPFS Daemon config to include the multiaddr for this new transport on the `Addresses.Swarm` array. Add: `"/dns4/wrtc-star.discovery.libp2p.io/wss/p2p-webrtc-star"`
398398

399399
#### How can I configure an IPFS node to use a custom `signaling endpoint` for my WebRTC transport?
400400

@@ -417,6 +417,26 @@ const node = new IPFS({
417417

418418
The code above assumes you are running a local `signaling server` on port `9090`. Provide the correct values accordingly.
419419

420+
#### Is there a more stable alternative to websocket-star that offers a similar functionality?
421+
422+
Yes, websocket-star! A WebSockets based transport that uses a Relay to route the messages. To enable it, just do:
423+
424+
```JavaScript
425+
const node = new IPFS({
426+
config: {
427+
Addresses: {
428+
Swarm: [
429+
'/dns4/ws-star.discovery.libp2p.io/wss/p2p-websocket-star'
430+
]
431+
}
432+
}
433+
})
434+
435+
node.on('ready', () => {
436+
// your instance with websocket-star is ready
437+
})
438+
```
439+
420440
#### I see some slowness when hopping between tabs Chrome with IPFS nodes, is there a reason why?
421441

422442
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.

0 commit comments

Comments
 (0)