From 8d839466bc898d78ba2c3458ce8ae6521ed50715 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Er=C3=A8be=20-=20Romain=20Gerard?= Date: Thu, 25 Aug 2016 13:51:48 +0200 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3abdc9..2eefb77 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,8 @@ Common options: -V --version Print version information ``` -## Example +## Examples +### Simplest one On your remote host, start the wstunnel's server by typing this command in your terminal ``` wstunnel --server ws://0.0.0.0:8080 @@ -37,9 +38,11 @@ On the client side use this command to forwards traffic trought the websocket tu ``` wstunnel -D 8888 ws://myRemoteHost:8080 ``` -This command will create a sock5 server listenning only on loopback interface on port 8888 and will forwards traffic +This command will create a sock5 server listenning only on loopback interface on port 8888 and will forwards traffic. + Ex: With firefox you can setup a proxy using this tunnel by settings in networking preferences 127.0.0.1:8888 and selecting socks5 proxy +### When behind a corporate proxy An other useful example is when you want to bypass an http proxy (a corporate proxy for example) The most reliable way to do it is to use wstunnel as described below @@ -48,9 +51,11 @@ Start your wstunnel server with tls activated wstunnel --server wss://0.0.0.0:443 -r 127.0.0.1:22 ``` The server will listen on any interface on port 443 (https) and restrict traffic to be forwarded only to the ssh daemon. + **Be aware that the server will use self signed certificate with weak cryptographic algorithm. -It was made in order add the least possible overhead while still being compliant with tls. -So do not rely on wstunnel to protect your privacy, if you want to do forwards only traffic that is already secure by design (ex: https)** +It was made in order to add the least possible overhead while still being compliant with tls.** + +**So do not rely on wstunnel to protect your privacy, if you want to do forwards only traffic that is already secure by design (ex: https)** Now on the client side start the client with ```