github/dndx-phantun
1
0
Fork 0
mirror of https://github.com/dndx/phantun.git synced 2025-01-19 06:19:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(phantun) add -h option information

Browse Source
This commit is contained in:
Datong Sun 2021-09-28 23:31:07 -07:00
parent 6285efd0d7
commit 2b7588adfe
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -64,10 +64,13 @@ It is also assumed that **Phantun Client** listens for incoming UDP packets at
(the `--remote` option for client). (the `--remote` option for client).
Phantun creates TUN interface for both the Client and Server. For Client, Phantun assigns itself the IP address 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 `net.ipv4.ip_forward` enabled and setup appropriate iptables rules for NAT between your physical
NIC address and Phantun's TUN interface address. 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: 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. 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 ## 4. Start Phantun daemon
**Note:** Run Phantun executable with `-h` option to see full detailed options.
### Server ### Server
Note: `4567` is the TCP port Phantun should listen on and must corresponds to the DNAT Note: `4567` is the TCP port Phantun should listen on and must corresponds to the DNAT