docs: production guide base setup #804
Conversation
vasco-santos
force-pushed
the
docs/production-guides-setup
branch
2 times, most recently
from
d3dfb1e to
0cc79e9
Compare
| * [Production](#production) | ||
| * [Star servers](#star-servers) | ||
| * [Delegate nodes](#delegate-nodes) | ||
| * [Circuit Relay](#circuit-relay) |
There was a problem hiding this comment.
Add SSL per libp2p/js-libp2p-relay-server#2 (comment)
doc/production/README.md
Outdated
|
|
||
| It is worth pointing out that with new discovery protocols on the way, as well as support for distributed signaling, the star servers should be deprecated on the long run. | ||
|
|
||
| ## Delegate nodes |
There was a problem hiding this comment.
These are IPFS only, we should clearly note that. Our only supported delegates atm leverage the IPFS http api.
doc/production/README.md
Outdated
| * [Circuit Relay](#circuit-relay) | ||
| * [SSL](#ssl) | ||
|
|
||
| ## `webrtc-star` servers |
There was a problem hiding this comment.
I think it would be helpful to more clearly state what environments these are useful for, which is to dial a browser. If that's not really in my user flow, I don't need them.
Also listing alternatives would be helpful. In this instance, relays.
|
|
||
| This guide aims to guide you from using the public infrastructure into setting up your own. | ||
|
|
||
| ## Table of Contents |
There was a problem hiding this comment.
I would reframe this guide. Right now it is focused on the services and less on what the user actually needs. I would think about it in terms of flows. Something like:
- Joining the Network
- How do I join the public network, how can I run my own bootstrap nodes? JS isn't currently great for being bootstrap nodes, because we need to improve the DHT first to be an effective server.
- Connecting to browser nodes
- This is where webrtc-star and relays come in
- Querying the network from the browser
- Delegates go here. In theory the DHT can work, it's just slow and requires WSS or webrtc-star support on all dialable nodes, we just really don't recommend it and if you're using the public dht it's really not going to work.
There was a problem hiding this comment.
Yes, I think this makes sense
There was a problem hiding this comment.
I added a "Others" section where I included the SSL subsection. SSL and other things will be transversal to the flows described
vasco-santos
force-pushed
the
docs/production-guides-setup
branch
from
dcf0e52 to
5660d8f
Compare
These were started in #718, but doing all of them in the same PR will just get things blocked longer. So, this PR is the first of a set of PRs that should land over time. One per guide to ease reviews and prioritize accordingly.
This PR adds the base README for the production guides.
Needs: