aramperes/onetun
1
0
Fork 0
mirror of https://github.com/aramperes/onetun.git synced 2025-09-08 23:58:31 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Rename option to --preshared-key and add to README

Browse source
This commit is contained in:
Aram 🍐 2023-10-02 17:21:32 -04:00
parent 6f143280d1
commit 1333ea8a7c
3 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -188,6 +188,13 @@ You can bind to a static address instead using `--endpoint-bind-addr`:
onetun --endpoint-bind-addr 0.0.0.0:51820 --endpoint-addr 140.30.3.182:51820 [...]
```
The security of the WireGuard connection can be further enhanced with a **pre-shared key** (PSK). You can generate such a key with the `wg genpsk` command, and provide it using `--preshared-key`.
The peer must also have this key configured using the `PresharedKey` option.
```shell
onetun --preshared-key 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' [...]
```
## Architecture
**In short:** onetun uses [smoltcp's](https://github.com/smoltcp-rs/smoltcp) TCP/IP and UDP stack to generate IP packets