You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Readme file states that the example config provided at src/data/config.json.example should be self-explanatory, but it isn't. In particular, the meaning of the following fields is unclear:
host: Is "localhost" a valid value?
secure: Should it be false when setting up on localhost?
path: What's the path to PeerJS? How should we know it?
realm: What does this even do? Does it matter?
config: Why is there a config field inside a config eludes me. It seems the only thing it contains is iceServers, so it should probably be renamed to xxxConfig, where xxx is the thing that receives it, I guess something to do with WebRTC.
config.iceServers: What addresses should we type in here? What server should we use?
The config isn't valid JSON anyway (it's just valid JS), so maybe we should stop pretending it's JSON, rename it to config.js.example and comment it properly?
The text was updated successfully, but these errors were encountered:
@devil418 Valid concerns. The readme was thrown together rather quickly before I more or less paused development on this project, so it may be that it's highly insufficient. I can go over the points you brought up in your comment one by one if you wish, but over the next few days I'll try to write a guide to set this up from scratch. Also maybe containerize the entire thing to make both the server and client easier to develop.
The Readme file states that the example config provided at
src/data/config.json.example
should be self-explanatory, but it isn't. In particular, the meaning of the following fields is unclear:The config isn't valid JSON anyway (it's just valid JS), so maybe we should stop pretending it's JSON, rename it to config.js.example and comment it properly?
The text was updated successfully, but these errors were encountered: