From e3b080ba7fe6e93d2ee51eda34c5261241c8d56f Mon Sep 17 00:00:00 2001 From: HeshamTB Date: Mon, 18 Mar 2024 19:55:43 +0300 Subject: [PATCH] README Signed-off-by: HeshamTB --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index a0db3b7..762e0f1 100644 --- a/README.md +++ b/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 + +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 +```