-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
1.0 #116
1.0 #116
Conversation
In order to establish a signalling channel using SaltyRTC, the following | ||
information has to be available to both peers: | ||
|
||
* WebSocket URI scheme (`ws` or `wss`), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't we always require wss?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah: Although the SaltyRTC protocol takes many security measures to prevent eavesdropping, it is still highly RECOMMENDED to use WebSocket in its secure mode
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's optional but recommended.
Protocol.md
Outdated
``` | ||
<scheme>://<server-host>:<server-port>/<signalling-path> | ||
?<server-permanent-public-key>#<authentication-token-hex> | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd format this by indentation, it's easier to read in ASCII form and the result is the same.
Readme.md
Outdated
Note that the specifications' versions are independent from each other. | ||
In case a new version of a specification breaks backwards compatibility | ||
to another specification, it will include a section stating how | ||
compatibility is affected. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should also include a CHANGELOG.md file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest adding a Changelog
section into the specification once a specification is being updated. Having one log for several specs seems confusing to me. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good.
Release Process | ||
=============== | ||
|
||
Signing key: https://lgrahl.de/pgp-key.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd recommend to include the fingerprint too.
Releasing.md
Outdated
export VERSION=protocol|chunking-<version> | ||
# For tasks: | ||
export VERSION=task-<task-name>-<version> | ||
export GPG=0482ABA6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you specify the full fingerprint? https://evil32.com/
Ok now? |
Releasing.md
(how can we both sign releases @dbrgn?)