mirror
/
tun2proxy-mirror
mirror of https://github.com/tun2proxy/tun2proxy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Update README

pull/104/head
B. Blechschmidt 2 years ago
parent
e8469f0aee
commit
4f5a128972
1 changed files with 24 additions and 14 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 38
      README.md

38
README.md
View File

@ -114,22 +114,32 @@ 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
--tun-fd <fd> File descriptor of the tun interface OS will generate a random one
-6, --ipv6-enabled IPv6 enabled --tun-fd <fd> File descriptor of the tun interface
-s, --setup Routing and system setup, which decides whether to setup the routing and system configuration, --unshare Create a tun interface in a newly created unprivileged namespace while maintaining proxy
this option requires root privileges connectivity via the global network namespace
-d, --dns <strategy> DNS handling strategy [default: direct] [possible values: virtual, over-tcp, direct] -6, --ipv6-enabled IPv6 enabled
--dns-addr <IP> DNS resolver address [default: 8.8.8.8] -s, --setup Routing and system setup, which decides whether to setup the routing and system
-b, --bypass <IP> IPs used in routing setup which should bypass the tunnel configuration. This option is only available on Linux and requires root-like privileges.
-v, --verbosity <level> Verbosity level [default: info] [possible values: off, error, warn, info, debug, trace] See `capabilities(7)`
-h, --help Print help -d, --dns <strategy> DNS handling strategy [default: direct] [possible values: virtual, over-tcp, direct]
-V, --version Print version --dns-addr <IP> DNS resolver address [default: 8.8.8.8]
-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]
-h, --help Print help
-V, --version Print version
``` ```
Currently, tun2proxy supports HTTP, SOCKS4/SOCKS4a and SOCKS5. A proxy is supplied to the `--proxy` argument in the Currently, tun2proxy supports HTTP, SOCKS4/SOCKS4a and SOCKS5. A proxy is supplied to the `--proxy` argument in the
URL format. For example, an HTTP proxy at `1.2.3.4:3128` with a username of `john.doe` and a password of `secret` is URL format. For example, an HTTP proxy at `1.2.3.4:3128` with a username of `john.doe` and a password of `secret` is

Write Preview
Loading…
Cancel
Save