hex/wstunnel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Former-commit-id: c6a3a2d35f2929e82396e24fd49af20c38db44d5
Former-commit-id: df1f2a77b5fc4e7efa33b05c8ab77321551cf522 [formerly 9c962b250c7a71fe2a2bdee55f620a28151607db [formerly 91f9ef5da4b1d01f27609a7f45b1794a0d8e7769] [formerly 91f9ef5da4b1d01f27609a7f45b1794a0d8e7769 [formerly fd8c81951fad4dff24ddd469221e5e3b83f34ba6]]]
Former-commit-id: cff0d6d532078f04f689493f315e7762c1e0e392
Former-commit-id: 21887918e628fd287dcd8d34d44cddb65240b996
Former-commit-id: beac30420af0bd91a1c27e29e6c2c6c7a9cc2e40
Former-commit-id: c0ea2155efe9c3c5c02f353e1785b6585ef6dd9a
This commit is contained in:
Erèbe - Romain Gerard 2016-08-26 10:55:37 +02:00 committed by GitHub
parent 323a53854c
commit 2c5b5db8ce
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,4 +1,28 @@
# Wstunnel
## Description
Most of the time when you are using a public network, you are behind some kind of firewall or proxy in order to limit the traffic to only use certain type of protocols, but most of the time http is allowed.
This tool uses the websocket protocol which is compatible with http in order to bypass firewalls and proxies and tunnel what ever traffic you want.
My inspiration went from [this project](https://www.npmjs.com/package/wstunnel) but as I don't want to have to install npm and nodejs to use this tool, I remade it in Haskell and improve it.
**What to expect :**
* Good error messages and debug informations
* Static tunneling (TCP and UDP)
* Dynamic tunneling (socks5 proxy)
* Support for proxy
* **Standalone binary for linux x86_64** (so just cp it where you want)
* Standalone archive for windows
[Binaries](https://github.com/erebe/wstunnel/tree/master/bin)
P.S: Please do not pay attention to Main.hs because as I hate to write command line code this file is crappy
## Command line
```
Use the websockets protocol to tunnel {TCP,UDP} traffic
wsTunnelClient <---> wsTunnelServer <---> RemoteHost