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(README) bump the release to v0.4.2 and fixed default site-local address in doc

Browse Source
This commit is contained in:
Datong Sun 2022-04-16 09:58:07 -07:00
parent a3eff42453
commit c2341b6662
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -35,7 +35,7 @@ Table of Contents
# Latest release # Latest release
[v0.4.1](https://github.com/dndx/phantun/releases/tag/v0.4.1) [v0.4.2](https://github.com/dndx/phantun/releases/tag/v0.4.2)
# Overview # Overview
@ -73,8 +73,8 @@ 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 `fec8::2` by default. `192.168.200.2` and `fcc8::2` by default.
For **Server**, it assigns `192.168.201.2` and `fec9::2` by default. Therefore, your Kernel must have For **Server**, it assigns `192.168.201.2` and `fcc9::2` by default. Therefore, your Kernel must have
IPv4/IPv6 forwarding enabled and setup appropriate iptables/nftables rules for NAT between your physical IPv4/IPv6 forwarding enabled and setup appropriate iptables/nftables rules for NAT between your physical
NIC address and Phantun's Tun interface address. NIC address and Phantun's Tun interface address.
@ -83,11 +83,11 @@ run the executable with `-h` options to see how to change them.
Another way to help understand this network topology (please see the diagram above for an illustration of this topology): Another way to help understand this network topology (please see the diagram above for an illustration of this topology):
Phantun Client is like a machine with private IP address (`192.168.200.2`/`fec8::2`) behind a router. Phantun Client is like a machine with private IP address (`192.168.200.2`/`fcc8::2`) behind a router.
In order for it to reach the Internet, you will need to SNAT the private IP address before it's traffic In order for it to reach the Internet, you will need to SNAT the private IP address before it's traffic
leaves the NIC. leaves the NIC.
Phantun Server is like a server with private IP address (`192.168.201.2`/`fec9::2`) behind a router. Phantun Server is like a server with private IP address (`192.168.201.2`/`fcc9::2`) behind a router.
In order to access it from the Internet, you need to `DNAT` it's listening port on the router In order to access it from the Internet, you need to `DNAT` it's listening port on the router
and change the destination IP address to where the server is listening for incoming connections. and change the destination IP address to where the server is listening for incoming connections.
@ -166,7 +166,7 @@ table inet nat {
chain prerouting { chain prerouting {
type nat hook prerouting priority dstnat; policy accept; type nat hook prerouting priority dstnat; policy accept;
iif eth0 tcp dport 4567 dnat ip to 192.168.201.2 iif eth0 tcp dport 4567 dnat ip to 192.168.201.2
iif eth0 tcp dport 4567 dnat ip6 to fec9::2 iif eth0 tcp dport 4567 dnat ip6 to fcc9::2
} }
} }
``` ```
@ -177,7 +177,7 @@ table inet nat {
``` ```
iptables -t nat -A PREROUTING -p tcp -i eth0 --dport 4567 -j DNAT --to-destination 192.168.201.2 iptables -t nat -A PREROUTING -p tcp -i eth0 --dport 4567 -j DNAT --to-destination 192.168.201.2
ip6tables -t nat -A PREROUTING -p tcp -i eth0 --dport 4567 -j DNAT --to-destination fec9::2 ip6tables -t nat -A PREROUTING -p tcp -i eth0 --dport 4567 -j DNAT --to-destination fcc9::2
``` ```
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)