Explain what a signalhub is and does and requires
aschrijver opened this issue · comments
In the dat-js documentation at Under the hood in the code snippet there is the concept of a signalhub coming out-of-the-blue:
var DEFAULT_SIGNALHUBS = 'https://signalhub.mafintosh.com'
There is not any explanation what this means. Do you have to run one or more of these servers for webrtc solution to work?
Googling on signalhub + webrtc gives the github repo of signalhub with only the - unhelpful - text:
Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff.
More googling finds webrtc-swarm and:
Creates a new webrtc swarm using signalhub hub for discovery and connection brokering.
Now in the dat-js README there is no mention of signalhub, but it's in the package.json
and the code. (Also note that from the Docs page there is no link to the dat-js project it documents)
As a Dat user, one should not have to go through all this effort, dive in code, to find the important concepts.
Recommendation
Update docs with:
- What is a signalhub?
- What does it do, how does it work?
- Is it required, are there alternatives?
- What are server / operational requirements?