From 809a6d0e89b5af36407d849b3cec3c4be5a144f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=CE=A3rebe=20-=20Romain=20GERARD?= Date: Sun, 26 Nov 2023 18:25:35 +0100 Subject: [PATCH] update readme --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b2a891b..1bd19e7 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,11 @@ Options: 'udp://1212:1.1.1.1:53?timeout_sec=10' timeout_sec on udp force close the tunnel after 10sec. Set it to 0 to disable the timeout [default: 30] 'socks5://[::1]:1212' => listen locally with socks5 on port 1212 and forward dynamically requested tunnel 'stdio://google.com:443' => listen for data from stdio, mainly for `ssh -o ProxyCommand="wstunnel client -L stdio://%h:%p ws://localhost:8080" my-server` + -R, --remote-to-local <{tcp,udp}://[BIND:]PORT:HOST:PORT> + Listen on remote and forwards traffic from local. Can be specified multiple times. Only tcp is supported + examples: + 'tcp://1212:google.com:443' => listen on server for incoming tcp cnx on port 1212 and forward to google.com on port 443 from local machine + 'udp://1212:1.1.1.1:53' => listen on server for incoming udp on port 1212 and forward to cloudflare dns 1.1.1.1 on port 53 from local machine --socket-so-mark (linux only) Mark network packet with SO_MARK sockoption with the specified value. You need to use {root, sudo, capabilities} to run wstunnel when using this option @@ -234,11 +239,3 @@ and run those commands at the root of the project cargo build target/debug/wstunnel ... ``` - -## TODO -- [x] Add socks5 proxy -- [x] Add better logging -- [x] Add better error handling -- [x] Add httpProxy authentification -- [ ] Add Reverse tunnel -- [x] Add more tests for socks5 proxy