From 2b7588adfe9ce14142078c8a1968a92cb2aff092 Mon Sep 17 00:00:00 2001 From: Datong Sun Date: Tue, 28 Sep 2021 23:31:07 -0700 Subject: [PATCH] docs(phantun) add `-h` option information --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 57d943f..a970e55 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,13 @@ It is also assumed that **Phantun Client** listens for incoming UDP packets at (the `--remote` option for client). Phantun creates TUN interface for both the Client and Server. For Client, Phantun assigns itself the IP address -`192.168.200.2` and for Server, it assigns `192.168.201.2`. Therefore, your Kernel must have +`192.168.200.2` by default and for Server, it assigns `192.168.201.2` by default. Therefore, your Kernel must have `net.ipv4.ip_forward` enabled and setup appropriate iptables rules for NAT between your physical NIC address and Phantun's TUN interface address. +You may customize the name of Tun interface created by Phantun and the assigned addresses. Please +run the executable with `-h` options to see how to change them. + Another way to help understand this network topology: Phantun Client is like a machine with private IP address (`192.168.200.2`) behind a router. @@ -167,6 +170,8 @@ sudo setcap cap_net_admin=+pe phantun_client ## 4. Start Phantun daemon +**Note:** Run Phantun executable with `-h` option to see full detailed options. + ### Server Note: `4567` is the TCP port Phantun should listen on and must corresponds to the DNAT