crabapples
/
websockify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #198 from halfgaar/master 

Clarified SSL section in README
This commit is contained in:
Joel Martin 2015-10-05 12:15:50 -05:00
parent 62c3a59192 3c04cf8c45
commit 50cc65f1e4
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -47,17 +47,29 @@ which is why the negotiation is necessary.
### Encrypted WebSocket connections (wss://) ### Encrypted WebSocket connections (wss://)
To encrypt the traffic using the WebSocket 'wss://' URI scheme you To encrypt the traffic using the WebSocket 'wss://' URI scheme you need to
need to generate a certificate for websockify to load. By default websockify generate a certificate and key for Websockify to load. By default, Websockify
loads a certificate file name `self.pem` but the `--cert=CERT` option can loads a certificate file name `self.pem` but the `--cert=CERT` and `--key=KEY`
override the file name. You can generate a self-signed certificate using options can override the file name. You can generate a self-signed certificate
openssl. When asked for the common name, use the hostname of the server where using openssl. When asked for the common name, use the hostname of the server
the proxy will be running: where the proxy will be running:
``` ```
openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem
``` ```
For a self-signed certificate to work, you need to make your client/browser
understand it. You can do this by installing it as accepted certificate, or by
using that same certificate for a HTTPS connection to which you navigate first
and approve. Browsers generally don't give you the "trust certificate?" prompt
by opening a WSS socket with invalid certificate, hence you need to have it
acccept it by either of those two methods.
If you have a commercial/valid SSL certificate with one ore more intermediate
certificates, concat them into one file, server certificate first, then the
intermediate(s) from the CA, etc. Point to this file with the `--cert` option
and then also to the key with `--key`. Finally, use `--ssl-only` as needed.
### Websock Javascript library ### Websock Javascript library