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

docs(readme) add link for fake-tcp docs

Browse Source
This commit is contained in:
Datong Sun 2022-04-08 21:15:09 -07:00
parent 9bf78adc92
commit dff0c4ca28
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -24,6 +24,7 @@ Table of Contents
* [MTU overhead](#mtu-overhead) * [MTU overhead](#mtu-overhead)
* [MTU calculation for WireGuard](#mtu-calculation-for-wireguard) * [MTU calculation for WireGuard](#mtu-calculation-for-wireguard)
* [Version compatibility](#version-compatibility) * [Version compatibility](#version-compatibility)
* [Documentations](#documentations)
* [Performance](#performance) * [Performance](#performance)
* [Future plans](#future-plans) * [Future plans](#future-plans)
* [Compariation to udp2raw](#compariation-to-udp2raw) * [Compariation to udp2raw](#compariation-to-udp2raw)
@ -176,6 +177,8 @@ sudo setcap cap_net_admin=+pe phantun_client
**Note:** Run Phantun executable with `-h` option to see full detailed options. **Note:** Run Phantun executable with `-h` option to see full detailed options.
[Back to TOC](#table-of-contents)
### 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
@ -252,6 +255,13 @@ of Server/Client of Phantun on both ends to ensure maximum compatibility.
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
# Documentations
For users who wish to use `fake-tcp` library inside their own project, refer to the documentations for the library at:
[https://docs.rs/fake-tcp](https://docs.rs/fake-tcp).
[Back to TOC](#table-of-contents)
# Performance # Performance
Performance was tested on AWS t3.xlarge instance with 4 vCPUs and 5 Gb/s NIC. WireGuard was used Performance was tested on AWS t3.xlarge instance with 4 vCPUs and 5 Gb/s NIC. WireGuard was used