vpncloud/src/usage.txt

44 lines
2.6 KiB
Plaintext
Raw Normal View History

2015-11-23 10:55:37 +00:00
Usage:
2019-01-03 18:48:34 +00:00
vpncloud [options] [--config <file>] [-t <type>] [-d <name>] [-l <port>] [-c <addr>...] [-s <subnet>...]
2015-11-23 10:55:37 +00:00
Options:
--config <file> Read configuration options from the
specified file.
2015-11-23 10:55:37 +00:00
-t <type>, --type <type> Set the type of network ("tap" or "tun").
2019-02-12 18:30:38 +00:00
--device-path <path> Set the path of the base device.
2015-11-23 16:10:42 +00:00
-d <name>, --device <name> Name of the virtual device.
2015-11-23 10:55:37 +00:00
-m <mode>, --mode <mode> The mode of the VPN ("hub", "switch",
"router", or "normal").
2016-05-02 06:35:11 +00:00
-l <port>, --listen <port> The port number on which to listen for data.
2015-11-23 10:55:37 +00:00
-c <addr>, --connect <addr> Address of a peer to connect to.
2019-01-03 18:48:34 +00:00
-s <subnet>, --subnet <subnet> The local subnets to use.
--magic <hex> Override the 4-byte magic header of each
packet.
2015-11-23 16:10:42 +00:00
--network-id <id> Optional token that identifies the network.
(DEPRECATED)
2015-11-23 16:10:42 +00:00
--shared-key <key> The shared key to encrypt all traffic.
2015-11-30 16:27:50 +00:00
--crypto <method> The encryption method to use ("aes256", or
"chacha20").
--peer-timeout <secs> Peer timeout in seconds.
2019-01-10 18:36:50 +00:00
--keepalive <secs> Periodically send message to keep
connections alive.
2015-11-23 19:53:58 +00:00
--dst-timeout <secs> Switch table entry timeout in seconds.
2019-02-19 21:04:21 +00:00
--beacon-store <path|command> The file or command to store the beacon.
--beacon-load <path|command> The file or command to load the beacon.
--beacon-interval <secs> Beacon store/load interval in seconds.
2015-11-23 18:06:25 +00:00
--ifup <command> A command to setup the network interface.
--ifdown <command> A command to bring down the network
interface.
2016-11-23 14:21:22 +00:00
--pid-file <file> Store the process id in this file when
daemonizing.
--user <user> Run as other user.
--group <group> Run as other group.
2016-11-23 14:21:22 +00:00
--log-file <file> Print logs also to this file.
2019-01-09 16:45:12 +00:00
--stats-file <file> Print statistics to this file.
--no-port-forwarding Disable automatic port forward.
2016-11-23 14:21:22 +00:00
--daemon Run the process in the background.
2015-11-23 10:55:37 +00:00
-v, --verbose Print debug information.
-q, --quiet Only print errors and warnings.
-h, --help Display the help.
2015-11-24 10:19:27 +00:00
-V, --version Print the version and exit.