update readme
This commit is contained in:
parent
a28b71c6af
commit
7270aa5550
2 changed files with 23 additions and 2 deletions
21
README.md
21
README.md
|
@ -101,6 +101,9 @@ Options:
|
||||||
'socks5://[::1]:1212' => listen locally with socks5 on port 1212 and forward dynamically requested tunnel
|
'socks5://[::1]:1212' => listen locally with socks5 on port 1212 and forward dynamically requested tunnel
|
||||||
'socks5://[::1]:1212?login=admin&password=admin' => listen locally with socks5 on port 1212 and only accept connection with login=admin and password=admin
|
'socks5://[::1]:1212?login=admin&password=admin' => listen locally with socks5 on port 1212 and only accept connection with login=admin and password=admin
|
||||||
|
|
||||||
|
'http://[::1]:1212' => start a http proxy on port 1212 and forward dynamically requested tunnel
|
||||||
|
'http://[::1]:1212?login=admin&password=admin' => start a http proxy on port 1212 and only accept connection with login=admin and password=admin
|
||||||
|
|
||||||
'tproxy+tcp://[::1]:1212' => listen locally on tcp on port 1212 as a *transparent proxy* and forward dynamically requested tunnel
|
'tproxy+tcp://[::1]:1212' => listen locally on tcp on port 1212 as a *transparent proxy* and forward dynamically requested tunnel
|
||||||
'tproxy+udp://[::1]:1212?timeout_sec=10' listen locally on udp on port 1212 as a *transparent proxy* and forward dynamically requested tunnel
|
'tproxy+udp://[::1]:1212?timeout_sec=10' listen locally on udp on port 1212 as a *transparent proxy* and forward dynamically requested tunnel
|
||||||
linux only and requires sudo/CAP_NET_ADMIN
|
linux only and requires sudo/CAP_NET_ADMIN
|
||||||
|
@ -115,6 +118,7 @@ Options:
|
||||||
'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
|
'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
|
'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
|
||||||
'socks5://[::1]:1212' => listen on server for incoming socks5 request on port 1212 and forward dynamically request from local machine
|
'socks5://[::1]:1212' => listen on server for incoming socks5 request on port 1212 and forward dynamically request from local machine
|
||||||
|
'http://[::1]:1212' => listen on server for incoming http proxy request on port 1212 and forward dynamically request from local machine (login/password is supported)
|
||||||
'unix://wstunnel.sock:g.com:443' => listen on server for incoming data from unix socket of path wstunnel.sock and forward to g.com:443 from local machine
|
'unix://wstunnel.sock:g.com:443' => listen on server for incoming data from unix socket of path wstunnel.sock and forward to g.com:443 from local machine
|
||||||
|
|
||||||
--no-color <NO_COLOR>
|
--no-color <NO_COLOR>
|
||||||
|
@ -225,7 +229,9 @@ Options:
|
||||||
system://0.0.0.0
|
system://0.0.0.0
|
||||||
|
|
||||||
**WARN** On windows you may want to specify explicitly the DNS resolver to avoid excessive DNS queries
|
**WARN** On windows you may want to specify explicitly the DNS resolver to avoid excessive DNS queries
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
SERVER
|
SERVER
|
||||||
Usage: wstunnel server [OPTIONS] <ws[s]://0.0.0.0[:port]>
|
Usage: wstunnel server [OPTIONS] <ws[s]://0.0.0.0[:port]>
|
||||||
|
|
||||||
|
@ -307,6 +313,21 @@ Options:
|
||||||
[Optional] Enables mTLS (client authentication with certificate). Argument must be PEM file
|
[Optional] Enables mTLS (client authentication with certificate). Argument must be PEM file
|
||||||
containing one or more certificates of CA's of which the certificate of clients needs to be signed with.
|
containing one or more certificates of CA's of which the certificate of clients needs to be signed with.
|
||||||
The ca will be automatically reloaded if it changes
|
The ca will be automatically reloaded if it changes
|
||||||
|
|
||||||
|
-p, --http-proxy <USER:PASS@HOST:PORT>
|
||||||
|
If set, will use this http proxy to connect to the client
|
||||||
|
|
||||||
|
[env: HTTP_PROXY=]
|
||||||
|
|
||||||
|
--http-proxy-login <LOGIN>
|
||||||
|
If set, will use this login to connect to the http proxy. Override the one from --http-proxy
|
||||||
|
|
||||||
|
[env: WSTUNNEL_HTTP_PROXY_LOGIN=]
|
||||||
|
|
||||||
|
--http-proxy-password <PASSWORD>
|
||||||
|
If set, will use this password to connect to the http proxy. Override the one from --http-proxy
|
||||||
|
|
||||||
|
[env: WSTUNNEL_HTTP_PROXY_PASSWORD=]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Release <a name="release"></a>
|
## Release <a name="release"></a>
|
||||||
|
|
|
@ -129,7 +129,7 @@ pub async fn propagate_local_to_remote(
|
||||||
biased;
|
biased;
|
||||||
|
|
||||||
read_len = local_rx.read_buf(ws_tx.buf_mut()) => read_len,
|
read_len = local_rx.read_buf(ws_tx.buf_mut()) => read_len,
|
||||||
|
|
||||||
_ = &mut should_close => break,
|
_ = &mut should_close => break,
|
||||||
|
|
||||||
_ = &mut has_pending_operations_pin => {
|
_ = &mut has_pending_operations_pin => {
|
||||||
|
@ -143,7 +143,7 @@ pub async fn propagate_local_to_remote(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
_ = timeout.tick(), if ping_frequency.is_some() => {
|
_ = timeout.tick(), if ping_frequency.is_some() => {
|
||||||
debug!("sending ping to keep connection alive");
|
debug!("sending ping to keep connection alive");
|
||||||
ws_tx.ping().await?;
|
ws_tx.ping().await?;
|
||||||
|
|
Loading…
Reference in a new issue