1
0
mirror of https://github.com/fumiama/WireGold.git synced 2026-06-05 07:50:24 +08:00
Files
WireGold/README.md
2022-04-15 16:15:14 +08:00

53 lines
1.5 KiB
Markdown

<div align="center">
<img src=".github/rikka.png" width = "360" height = "360" alt="WireGold-Rikka"><br>
<h1>WireGold</h1>
Wire Golang Guard = WireGold<br><br>
</div>
## Usage
> If you are running in windows, remember to select the `wintun.dll` of your arch in `lower/wintun` and place it alongside the compiled exe
```bash
wg [-c config.yaml] [-d|w] [-g] [-h] [-m mtu] [-p]
```
#### Instructions
```bash
-c string
specify conf file (default "config.yaml")
-d print debug logs
-g generate key pair
-h display this help
-m int
set the mtu of wg (default 32700)
-p show my publickey
-w only show logs above warn level
```
- **macos mojave**: max mtu (under ipv4 endpoint) is `9159`
- **ipv6 endpoint**: the recommand mtu is `1280~1400` to prevent the big segments from being dropped
## Config file example
```yaml
IP: 192.168.233.1
SubNet: 192.168.233.0/24
PrivateKey: 暲菉斂狧污爉窫擸紈卆帞蔩慈睠庮扝憚瞼縀
EndPoint: 0.0.0.0:56789
Peers:
-
IP: "192.168.233.2"
SubNet: 192.168.233.0/24
PublicKey: 徯萃嵾爻燸攗窍褃冔蒔犡緇袿屿組待族砇嘀
EndPoint: 1.2.3.4:56789
AllowedIPs: ["192.168.233.2/32"]
KeepAliveSeconds: 0
QueryList: ["192.168.233.3"]
QuerySeconds: 10
AllowTrans: false
-
IP: "192.168.233.3"
SubNet: 192.168.233.0/24
PublicKey: 牢喨粷詸衭譛浾蘹櫠砙杹蟫瑳叩刋橋経挵蘀
EndPoint: ""
AllowedIPs: ["192.168.233.3/32"]
KeepAliveSeconds: 0
AllowTrans: false
```