Skip to content

Commit 90151ea

Browse files
authored
chore(proxies): add masque (#127)
1 parent 09803cd commit 90151ea

4 files changed

Lines changed: 160 additions & 0 deletions

File tree

docs/config/proxies/masque.en.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# MASQUE
2+
3+
```{.yaml linenums="1"}
4+
proxies:
5+
- name: "masque"
6+
type: masque
7+
server: server.com
8+
port: 443
9+
private-key: "BASE64_ENCODED_PRIVATE_KEY"
10+
public-key: "BASE64_ENCODED_PUBLIC_KEY"
11+
ip: 172.16.0.2/32
12+
ipv6: fd00::2/128
13+
mtu: 1280
14+
udp: true
15+
# remote-dns-resolve: true
16+
# dns:
17+
# - 8.8.8.8
18+
# - 1.1.1.1
19+
```
20+
21+
[Common Fields](./index.md)
22+
23+
## private-key
24+
25+
Required, base64-encoded ECDSA private key.
26+
27+
## public-key
28+
29+
Required, base64-encoded ECDSA public key (server-side public key).
30+
31+
## ip
32+
33+
Local IPv4 address in CIDR format (e.g., 172.16.0.2/32).
34+
35+
## ipv6
36+
37+
Local IPv6 address in CIDR format (e.g., fd00::2/128).
38+
39+
## mtu
40+
41+
MTU size for the TUN device, defaults to 1280.
42+
43+
## udp
44+
45+
Whether to enable UDP support, defaults to false.
46+
47+
## remote-dns-resolve
48+
49+
Whether to enable remote DNS resolution through the MASQUE tunnel.
50+
51+
## dns
52+
53+
List of remote DNS servers, takes effect when `remote-dns-resolve` is enabled.

docs/config/proxies/masque.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# MASQUE
2+
3+
```{.yaml linenums="1"}
4+
proxies:
5+
- name: "masque"
6+
type: masque
7+
server: server.com
8+
port: 443
9+
private-key: "BASE64_ENCODED_PRIVATE_KEY"
10+
public-key: "BASE64_ENCODED_PUBLIC_KEY"
11+
ip: 172.16.0.2/32
12+
ipv6: fd00::2/128
13+
mtu: 1280
14+
udp: true
15+
# remote-dns-resolve: true
16+
# dns:
17+
# - 8.8.8.8
18+
# - 1.1.1.1
19+
```
20+
21+
[通用字段](./index.md)
22+
23+
## private-key
24+
25+
必须,base64 编码的 ECDSA 私钥
26+
27+
## public-key
28+
29+
必须,base64 编码的 ECDSA 公钥(服务器端公钥)
30+
31+
## ip
32+
33+
本地 IPv4 地址,CIDR 格式(如 172.16.0.2/32)
34+
35+
## ipv6
36+
37+
本地 IPv6 地址,CIDR 格式(如 fd00::2/128)
38+
39+
## mtu
40+
41+
TUN 设备的 MTU 大小,默认为 1280
42+
43+
## udp
44+
45+
是否启用 UDP 支持,默认为 false
46+
47+
## remote-dns-resolve
48+
49+
是否启用远程 DNS 解析,通过 MASQUE 隧道解析 DNS
50+
51+
## dns
52+
53+
远程 DNS 服务器列表,在启用 `remote-dns-resolve` 后生效

docs/config/proxies/masque.ru.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# MASQUE
2+
3+
```{.yaml linenums="1"}
4+
proxies:
5+
- name: "masque"
6+
type: masque
7+
server: server.com
8+
port: 443
9+
private-key: "BASE64_ENCODED_PRIVATE_KEY"
10+
public-key: "BASE64_ENCODED_PUBLIC_KEY"
11+
ip: 172.16.0.2/32
12+
ipv6: fd00::2/128
13+
mtu: 1280
14+
udp: true
15+
# remote-dns-resolve: true
16+
# dns:
17+
# - 8.8.8.8
18+
# - 1.1.1.1
19+
```
20+
21+
[Общие поля](./index.md)
22+
23+
## private-key
24+
25+
Обязательно, закрытый ключ ECDSA в кодировке base64
26+
27+
## public-key
28+
29+
Обязательно, открытый ключ ECDSA в кодировке base64 (открытый ключ сервера)
30+
31+
## ip
32+
33+
Локальный IPv4-адрес в формате CIDR (например, 172.16.0.2/32)
34+
35+
## ipv6
36+
37+
Локальный IPv6-адрес в формате CIDR (например, fd00::2/128)
38+
39+
## mtu
40+
41+
Размер MTU устройства TUN, по умолчанию 1280
42+
43+
## udp
44+
45+
Включить ли поддержку UDP, по умолчанию false
46+
47+
## remote-dns-resolve
48+
49+
Включить ли удаленное разрешение DNS через туннель MASQUE
50+
51+
## dns
52+
53+
Список удаленных DNS-серверов, действует при включении `remote-dns-resolve`

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,7 @@ nav:
277277
- TUIC: config/proxies/tuic.md
278278
- WireGuard: config/proxies/wg.md
279279
- SSH: config/proxies/ssh.md
280+
- MASQUE: config/proxies/masque.md
280281
- 代理集合:
281282
- 代理集合配置: config/proxy-providers/index.md
282283
- 代理集合内容: config/proxy-providers/content.md

0 commit comments

Comments
 (0)