From c49c162b4aafcd954bd9081ccbe1a0369c7e49ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Er=C3=A8be=20-=20Romain=20Gerard?= Date: Tue, 21 Jun 2016 22:16:19 +0200 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index f7467c6..e0c2dc6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ # wstunnel +``` + +Use the websockets protocol to tunnel {TCP,UDP} traffic +wsTunnelClient <---> wsTunnelServer <---> RemoteHost +Use secure connection (wss://) to bypass proxies +wstunnel [OPTIONS] ws[s]://wstunnelServer[:port] +Client options: + -L --localToRemote=[BIND:]PORT:HOST:PORT Listen on local and forward + traffic from remote + -u --udp forward UDP traffic instead of + TCP + -p --httpProxy=USER:PASS@HOST:PORT If set, will use this proxy to + connect to the server +Server options: + --server Start a server that will forward + traffic for you + -r --restrictTo=HOST:PORT Accept traffic to be forwarded + only to this service +Common options: + -v --verbose Print debug information + -q --quiet Print only errors + -h --help Display help message + -V --version Print version information + +``` ## TODO - [ ] Add sock5 proxy