Browse Source

Update README

pull/104/head
B. Blechschmidt 2 years ago
parent
commit
4f5a128972
  1. 22
      README.md

22
README.md

@ -114,19 +114,29 @@ sudo ip link del tun0
``` ```
Tunnel interface to proxy. Tunnel interface to proxy.
Usage: tun2proxy [OPTIONS] --proxy <URL> Usage: tun2proxy [OPTIONS] --proxy <URL> [ADMIN_COMMAND]...
Arguments:
[ADMIN_COMMAND]... Specify a command to run with root-like capabilities in the new namespace when using `--unshare`.
This could be useful to start additional daemons, e.g. `openvpn` instance
Options: Options:
-p, --proxy <URL> Proxy URL in the form proto://[username[:password]@]host:port, where proto is one of socks4, -p, --proxy <URL> Proxy URL in the form proto://[username[:password]@]host:port, where proto is one of
socks5, http. For example: socks5://myname:[email protected]:1080 socks4, socks5, http. For example: socks5://myname:[email protected]:1080
-t, --tun <name> Name of the tun interface [default: tun0] -t, --tun <name> Name of the tun interface, such as tun0, utun4, etc. If this option is not provided, the
OS will generate a random one
--tun-fd <fd> File descriptor of the tun interface --tun-fd <fd> File descriptor of the tun interface
--unshare Create a tun interface in a newly created unprivileged namespace while maintaining proxy
connectivity via the global network namespace
-6, --ipv6-enabled IPv6 enabled -6, --ipv6-enabled IPv6 enabled
-s, --setup Routing and system setup, which decides whether to setup the routing and system configuration, -s, --setup Routing and system setup, which decides whether to setup the routing and system
this option requires root privileges configuration. This option is only available on Linux and requires root-like privileges.
See `capabilities(7)`
-d, --dns <strategy> DNS handling strategy [default: direct] [possible values: virtual, over-tcp, direct] -d, --dns <strategy> DNS handling strategy [default: direct] [possible values: virtual, over-tcp, direct]
--dns-addr <IP> DNS resolver address [default: 8.8.8.8] --dns-addr <IP> DNS resolver address [default: 8.8.8.8]
-b, --bypass <IP> IPs used in routing setup which should bypass the tunnel -b, --bypass <IP> IPs used in routing setup which should bypass the tunnel
--tcp-timeout <seconds> TCP timeout in seconds [default: 600]
--udp-timeout <seconds> UDP timeout in seconds [default: 10]
-v, --verbosity <level> Verbosity level [default: info] [possible values: off, error, warn, info, debug, trace] -v, --verbosity <level> Verbosity level [default: info] [possible values: off, error, warn, info, debug, trace]
-h, --help Print help -h, --help Print help
-V, --version Print version -V, --version Print version

Loading…
Cancel
Save