Skip to content

Commit e1ac62e

Browse files
committed
readme: update readme
Signed-off-by: Date Huang <tjjh89017@hotmail.com>
1 parent 824e78e commit e1ac62e

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ STUNMESH is a Wireguard helper tool to get through Full-Cone NAT.
44

55
Inspired by manuels' [wireguard-p2p](https://github.com/manuels/wireguard-p2p) project
66

7+
Supported Platform:
8+
- Linux (amd64, arm, arm64, mips)
9+
- MacOS* (amd64, arm64)
10+
- FreeBSD (amd64, arm64)
11+
12+
> [!NOTE]
13+
> We only support wireguard-go in MacOS, Wireguard App store version is not supported because of sandbox currently.
14+
715
Tested with
816
- VyOS 2025.07.14-0022-rolling (built-in Wireguard kernel module)
917
- Ubuntu with Wireguard in Kernel module
@@ -26,6 +34,9 @@ Once getting info from internet, it will setup peer endpoint with wireguard tool
2634
make all
2735
```
2836

37+
> [!NOTE]
38+
> For FreeBSD and MacOS, please use GNU Makefile `gmake` to build.
39+
2940
## Usage
3041

3142
```
@@ -299,7 +310,7 @@ plugins:
299310
remote_api:
300311
type: exec
301312
command: "curl"
302-
args: ["-s", "-X", "POST", "https://api.example.com/stunmesh"]
313+
args: ["-s", "-X", "POST", "-H", "Content-Type: application/json", "--data-binary", "@-", "https://api.example.com/stunmesh"]
303314
```
304315

305316
## Example Usage
@@ -550,8 +561,6 @@ plugins:
550561
551562
Ping each other to check or you can use `wg` to show the info.
552563

553-
554-
555564
## Extra Usage
556565
You could use OSPF on Wireguard interface to create full mesh site-to-site VPN with dynamic routing.<br />
557566
Never be bothered to setup static route.<br />
@@ -646,7 +655,6 @@ protocols {
646655
647656
- one shot command
648657
- auto execute when routing engine notify change
649-
- plugin based storage
650658
651659
## License
652660
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

0 commit comments

Comments
 (0)