Skip to content

Commit

Permalink
Update wireguard parameter explanation (#434)
Browse files Browse the repository at this point in the history
* Update wireguard parameter explanation

* Update wireguard.md
  • Loading branch information
chika0801 authored Dec 26, 2023
1 parent fba2d96 commit b9a9ded
Showing 1 changed file with 48 additions and 10 deletions.
58 changes: 48 additions & 10 deletions docs/config/outbounds/wireguard.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"mtu": 1420, // optional, default 1420
"reserved": [1, 2, 3],
"workers": 2, // optional, default runtime.NumCPU()
"domainStrategy": "ForceIP" // 需要 Xray-core v1.8.6 或更高版本
"domainStrategy": "ForceIP"
}
```

Expand All @@ -48,9 +48,11 @@ Wireguard 底层 tun 的分片大小。

> `reserved` \[ number \]
Wireguard 保留字节。<br>
例如通过 wireguard 连接 warp 时,由于 cloudflare 的限制,香港、洛杉矶部分 IP 需要有 reserved 的值才能成功连接。<br>
reserved 的值可使用第三方工具获得,例如 [warp-reg](https://github.com/badafans/warp-reg)[warp-reg.sh](https://github.com/chise0713/warp-reg.sh)
Wireguard 保留字节。

Xray-core v1.8.0 新增参数。<br>
通过 wireguard 连接 warp 时,由于 cloudflare 的限制,香港、洛杉矶部分 IP 需要有 `reserved` 的值才能成功连接。<br>
`reserved` 的值可使用第三方工具获得,例如:[warp-reg](https://github.com/badafans/warp-reg)[warp-reg.sh](https://github.com/chise0713/warp-reg.sh)

> `workers`: int
Expand All @@ -62,9 +64,46 @@ Wireguard 服务器列表,其中每一项是一个服务器配置。

> `domainStrategy`: "ForceIPv6v4" | "ForceIPv6" | "ForceIPv4v6" | "ForceIPv4" | "ForceIP"
需要 Xray-core v1.8.6 或更高版本。<br>
留空时默认值是 `"ForceIP"`。<br>
当接收到的请求是域名,无论 `domainStrategy` 是否留空(或不写 `domainStrategy`),使用[内置 DNS 服务器](./dns.md)解析获取 IP(若配置中没写 DNS 部分,使用系统 DNS),将此 IP 通过 wireguard 发出连接。
Xray-core v1.8.6 新增参数。<br>
若不写此参数,或留空,默认值 `"ForceIP"`。<br>
当目标地址为域名时,使用 Xray-core [内置 DNS 服务器](./dns.md)查询获取 IP(若没写 `"dns"` 配置,使用系统 DNS),将此 IP 通过 wireguard 发出连接。<br>

| domainStrategy | test-ipv6.com | bgp.he.net | chat.openai.com |
| :--- | :---: | :---: | :---: |
| ForceIPv6v4 | IPv6v4地址 | IPv6地址 | IPv6地址 |
| ForceIPv6 | 网站打不开 | IPv6地址 | IPv6地址 |
| ForceIPv4v6 | IPv6v4地址 **1** | IPv4地址 | IPv4地址 |
| ForceIPv4 | IPv4地址 | IPv4地址 | IPv4地址 |
| ForceIP | IPv6v4地址 **2** | IPv6地址 | IPv6地址 |

**1:** 提示`你已经有 IPv6 地址了,但你的浏览器不太愿意用,这一点比较令人担心。`<br>
**2:** 有机率提示`你已经有 IPv6 地址了,但你的浏览器不太愿意用,这一点比较令人担心。`

**注意1**
- 若与 `"queryStrategy"` 产生冲突,会造成网站不能打开。
- 例如当 `domainStrategy: "ForceIPv4"` 时,geosite:openai 的网站使用了 `"queryStrategy": "UseIPv6"`,将打开失败。

```jsonc
"dns": {
"servers": [
"https://1.1.1.1/dns-query",
{
"address": "https://1.1.1.1/dns-query",
"domains": [
"geosite:openai"
],
"skipFallback": true,
"queryStrategy": "UseIPv6" // 只查询 AAAA 记录
}
],
"queryStrategy": "UseIP" // 若不写此参数,默认值 UseIP,即同时查询 A 和 AAAA 记录,可选值 UseIPv4 和 UseIPv6,其它记录类型由系统 DNS 查询
},
```

**注意2**
- Xray-core v1.8.0 - v1.8.4 没有 `"domainStrategy"`
- 当目标地址为域名时,使用 Xray-core 内置 DNS 服务器查询获取 IP,使用 `"dns"` 配置中的 `"queryStrategy"` 的值来控制 IPv4 或 IPv6 优先级。
- 若没写 `"dns"` 配置,使用系统 DNS 查询获取 IP,IPv4 或 IPv6 优先级由系统控制。

### Peers

Expand All @@ -82,9 +121,8 @@ Wireguard 服务器列表,其中每一项是一个服务器配置。
服务器地址, 必填

::: tip
使用 url:端口号 格式,形如 `engage.cloudflareclient.com:2408`
:::
URL:端口 格式,例如 `engage.cloudflareclient.com:2408`<br>
IP:端口 格式,例如 `162.159.192.1:2408``[2606:4700:d0::a29f:c001]:2408`

> `publicKey`: string
Expand Down

0 comments on commit b9a9ded

Please sign in to comment.