README
Signed-off-by: HeshamTB <hishaminv@gmail.com>
This commit is contained in:
parent
6c032e1d97
commit
e3b080ba7f
21
README.md
21
README.md
@ -1,2 +1,23 @@
|
||||
# hvpn-node3
|
||||
|
||||
```
|
||||
NAME:
|
||||
./hvpn-node - HVPN node API server
|
||||
|
||||
USAGE:
|
||||
./hvpn-node [global options] [arguments...]
|
||||
|
||||
AUTHOR:
|
||||
Hesham T. Banafa <hishaminv@gmail.com>
|
||||
|
||||
GLOBAL OPTIONS:
|
||||
--log-level value (default: "INFO") [$LOG_LEVEL]
|
||||
--private-key value Path to file with private key
|
||||
--cidr value, -n value The network subnet used for the internal IP Pool (default: "10.42.0.0/16")
|
||||
--interface value, -i value Name of the Wireguard interface to be created and managed (default: "hvpn0")
|
||||
--endpoint value Wireguard endpoint domain or address without the port (default: "domain.name.notset")
|
||||
--port value, -p value UDP Port for wireguard device (default: 6416)
|
||||
--host value IP address to listen on for HTTP API requests (default: "0.0.0.0")
|
||||
--http-port value TCP Port for HTTP API (default: 8080)
|
||||
--help, -h show help
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user