diff --git a/en/guide/network/configurations.md b/en/guide/network/configurations.md index 4bc87dd..a503d79 100644 --- a/en/guide/network/configurations.md +++ b/en/guide/network/configurations.md @@ -3,45 +3,60 @@ You can use `easytier-core --help` to view all configuration items ```sh +A full meshed p2p VPN, connecting all your devices in one network with one command. + +Usage: easytier-core [OPTIONS] + Options: + -c, --config-file + path to the config file, NOTE: if this is set, all other options will be ignored --network-name - network name to identify this vpn network - [default: default] + network name to identify this vpn network [default: default] --network-secret - network secret to verify this node belongs to the vpn network - [default: ] + network secret to verify this node belongs to the vpn network [default: ] -i, --ipv4 - ipv4 address of this vpn node - -p, --peers + ipv4 address of this vpn node, if empty, this node will only forward packets and no TUN device will be + created + -d, --dhcp + automatically determine and set IP address by Easytier, and the + IP address starts from 10.0.0.1 by default. Warning, if there is an IP + conflict in the network when using DHCP, the IP will be automatically + changed. + -p, --peers [...] peers to connect initially -e, --external-node use a public shared node to discover peers -n, --proxy-networks export local networks to other peers in the vpn -r, --rpc-portal - rpc portal address to listen for management - [default: 127.0.0.1:15888] - -l, --listeners - listeners to accept connections, pass '' to avoid listening. - [default: tcp://0.0.0.0:11010 udp://0.0.0.0:11010 wg://0.0.0.0:11011] - --net-ns - specify the linux network namespace, default is the root namespace + rpc portal address to listen for management. 0 means random + port, 12345 means listen on 12345 of localhost, 0.0.0.0:12345 means + listen on 12345 of all interfaces. default is 0 and will try 15888 first [default: 0] + -l, --listeners [...] + listeners to accept connections, allow format: + a port number: 11010, means tcp/udp will listen on 11010, ws/wss will listen on 11010 and 11011, wg will + listen on 11011 + url: tcp://0.0.0.0:11010, tcp can be tcp, udp, ring, wg, ws, wss, + proto:port: wg:11011, means listen on 11011 with wireguard protocol + url and proto:port can occur multiple times. + [default: 11010] + --no-listener + do not listen on any port, only connect to peers --console-log-level - console log level - [possible values: trace, debug, info, warn, error, off] + console log level [possible values: trace, debug, info, warn, error, off] --file-log-level - file log level - [possible values: trace, debug, info, warn, error, off] + file log level [possible values: trace, debug, info, warn, error, off] --file-log-dir directory to store log files + --hostname + host name to identify this device -m, --instance-name - instance name to identify this vpn node in same machine - [default: default] - -d, --instance-id - instance uuid to identify this vpn node in whole vpn network example: 123e4567-e89b-12d3-a456-426614174000 + instance name to identify this vpn node in same machine [default: default] --vpn-portal url that defines the vpn portal, allow other vpn clients to connect. - example: wg://0.0.0.0:11010/10.14.14.0/24, means the vpn portal is a wireguard server listening on vpn.example.com:11010, and the vpn client is in network of 10.14.14.0/24 + example: wg://0.0.0.0:11010/10.14.14.0/24, means the vpn portal is a wireguard server listening on + vpn.example.com:11010, + and the vpn client is in network of 10.14.14.0/24 --default-protocol default protocol to use when connecting to peers -u, --disable-encryption @@ -50,6 +65,28 @@ Options: use multi-thread runtime, default is single-thread --disable-ipv6 do not use ipv6 + --dev-name + optional tun interface name + --mtu + mtu of the TUN device, default is 1420 for non-encryption, 1400 for encryption + --latency-first + latency first mode, will try to relay traffic with lowest latency path, default is using shortest path + --exit-nodes [...] + exit nodes to forward all traffic to, a virtual ipv4 address, priority is determined by the order of the + list + --enable-exit-node + allow this node to be an exit node, default is false + --no-tun + do not create TUN device, can use subnet proxy to access node + --use-smoltcp + enable smoltcp stack for subnet proxy + --manual-routes [...] + assign routes cidr manually, will disable subnet proxy and + wireguard routes propogated from peers. e.g.: 192.168.0.0/16 + --relay-network-whitelist [...] + only relay traffic of whitelisted networks, input is a wildcard + string, e.g.: '*' (all networks), 'def*' (network prefixed with def), can specify multiple networks + disable relay if arg is empty. default is allowing all networks -h, --help Print help -V, --version diff --git a/guide/network/configurations.md b/guide/network/configurations.md index 1d709c8..10b73ae 100644 --- a/guide/network/configurations.md +++ b/guide/network/configurations.md @@ -3,45 +3,60 @@ 可使用 `easytier-core --help` 查看全部配置项 ```sh +A full meshed p2p VPN, connecting all your devices in one network with one command. + +Usage: easytier-core [OPTIONS] + Options: + -c, --config-file + path to the config file, NOTE: if this is set, all other options will be ignored --network-name - network name to identify this vpn network - [default: default] + network name to identify this vpn network [default: default] --network-secret - network secret to verify this node belongs to the vpn network - [default: ] + network secret to verify this node belongs to the vpn network [default: ] -i, --ipv4 - ipv4 address of this vpn node - -p, --peers + ipv4 address of this vpn node, if empty, this node will only forward packets and no TUN device will be + created + -d, --dhcp + automatically determine and set IP address by Easytier, and the + IP address starts from 10.0.0.1 by default. Warning, if there is an IP + conflict in the network when using DHCP, the IP will be automatically + changed. + -p, --peers [...] peers to connect initially -e, --external-node use a public shared node to discover peers -n, --proxy-networks export local networks to other peers in the vpn -r, --rpc-portal - rpc portal address to listen for management - [default: 127.0.0.1:15888] - -l, --listeners - listeners to accept connections, pass '' to avoid listening. - [default: tcp://0.0.0.0:11010 udp://0.0.0.0:11010 wg://0.0.0.0:11011] - --net-ns - specify the linux network namespace, default is the root namespace + rpc portal address to listen for management. 0 means random + port, 12345 means listen on 12345 of localhost, 0.0.0.0:12345 means + listen on 12345 of all interfaces. default is 0 and will try 15888 first [default: 0] + -l, --listeners [...] + listeners to accept connections, allow format: + a port number: 11010, means tcp/udp will listen on 11010, ws/wss will listen on 11010 and 11011, wg will + listen on 11011 + url: tcp://0.0.0.0:11010, tcp can be tcp, udp, ring, wg, ws, wss, + proto:port: wg:11011, means listen on 11011 with wireguard protocol + url and proto:port can occur multiple times. + [default: 11010] + --no-listener + do not listen on any port, only connect to peers --console-log-level - console log level - [possible values: trace, debug, info, warn, error, off] + console log level [possible values: trace, debug, info, warn, error, off] --file-log-level - file log level - [possible values: trace, debug, info, warn, error, off] + file log level [possible values: trace, debug, info, warn, error, off] --file-log-dir directory to store log files + --hostname + host name to identify this device -m, --instance-name - instance name to identify this vpn node in same machine - [default: default] - -d, --instance-id - instance uuid to identify this vpn node in whole vpn network example: 123e4567-e89b-12d3-a456-426614174000 + instance name to identify this vpn node in same machine [default: default] --vpn-portal url that defines the vpn portal, allow other vpn clients to connect. - example: wg://0.0.0.0:11010/10.14.14.0/24, means the vpn portal is a wireguard server listening on vpn.example.com:11010, and the vpn client is in network of 10.14.14.0/24 + example: wg://0.0.0.0:11010/10.14.14.0/24, means the vpn portal is a wireguard server listening on + vpn.example.com:11010, + and the vpn client is in network of 10.14.14.0/24 --default-protocol default protocol to use when connecting to peers -u, --disable-encryption @@ -50,6 +65,28 @@ Options: use multi-thread runtime, default is single-thread --disable-ipv6 do not use ipv6 + --dev-name + optional tun interface name + --mtu + mtu of the TUN device, default is 1420 for non-encryption, 1400 for encryption + --latency-first + latency first mode, will try to relay traffic with lowest latency path, default is using shortest path + --exit-nodes [...] + exit nodes to forward all traffic to, a virtual ipv4 address, priority is determined by the order of the + list + --enable-exit-node + allow this node to be an exit node, default is false + --no-tun + do not create TUN device, can use subnet proxy to access node + --use-smoltcp + enable smoltcp stack for subnet proxy + --manual-routes [...] + assign routes cidr manually, will disable subnet proxy and + wireguard routes propogated from peers. e.g.: 192.168.0.0/16 + --relay-network-whitelist [...] + only relay traffic of whitelisted networks, input is a wildcard + string, e.g.: '*' (all networks), 'def*' (network prefixed with def), can specify multiple networks + disable relay if arg is empty. default is allowing all networks -h, --help Print help -V, --version