chore: update docs

This commit is contained in:
xishang0128 2023-12-31 03:22:01 +08:00
parent 2e87c6f4da
commit 22862f20cc
No known key found for this signature in database
GPG key ID: 44A1E10B5ADF68CB

View file

@ -112,25 +112,25 @@ tun:
# gso: false # 启用通用分段卸载, 仅支持 Linux # gso: false # 启用通用分段卸载, 仅支持 Linux
# gso-max-size: 65536 # 通用分段卸载包的最大大小 # gso-max-size: 65536 # 通用分段卸载包的最大大小
# strict-route: true # 将所有连接路由到tun来防止泄漏但你的设备将无法其他设备被访问 # strict-route: true # 将所有连接路由到tun来防止泄漏但你的设备将无法其他设备被访问
inet4-route-address: # 启用 auto_route 时使用自定义路由而不是默认路由 inet4-route-address: # 启用 auto-route 时使用自定义路由而不是默认路由
- 0.0.0.0/1 - 0.0.0.0/1
- 128.0.0.0/1 - 128.0.0.0/1
inet6-route-address: # 启用 auto_route 时使用自定义路由而不是默认路由 inet6-route-address: # 启用 auto-route 时使用自定义路由而不是默认路由
- "::/1" - "::/1"
- "8000::/1" - "8000::/1"
# endpoint-independent-nat: false # 启用独立于端点的 NAT # endpoint-independent-nat: false # 启用独立于端点的 NAT
# include_interface: # 限制被路由的接口。默认不限制, 与 `exclude_interface` 冲突 # include-interface: # 限制被路由的接口。默认不限制, 与 `exclude-interface` 冲突
# - "lan0" # - "lan0"
# exclude_interface: # 排除路由的接口, 与 `include_interface` 冲突 # exclude-interface: # 排除路由的接口, 与 `include-interface` 冲突
# - "lan1" # - "lan1"
# include-uid: # UID 规则仅在 Linux 下被支持,并且需要 auto_route # include-uid: # UID 规则仅在 Linux 下被支持,并且需要 auto-route
# - 0 # - 0
# include-uid-range: # 限制被路由的的用户范围 # include-uid-range: # 限制被路由的的用户范围
# - 1000-99999 # - 1000:9999
# exclude-uid: # 排除路由的的用户 # exclude-uid: # 排除路由的的用户
#- 1000 #- 1000
# exclude-uid-range: # 排除路由的的用户范围 # exclude-uid-range: # 排除路由的的用户范围
# - 1000-99999 # - 1000:9999
# Android 用户和应用规则仅在 Android 下被支持 # Android 用户和应用规则仅在 Android 下被支持
# 并且需要 auto-route # 并且需要 auto-route
@ -651,9 +651,8 @@ proxies: # socks5
type: hysteria type: hysteria
server: server.com server: server.com
port: 443 port: 443
# ports: 1000,2000-3000,5000 # port 不可省略, # ports: 1000,2000-3000,5000 # port 不可省略
auth_str: yourpassword # 将会在未来某个时候删除 auth-str: yourpassword
# auth-str: yourpassword
# obfs: obfs_str # obfs: obfs_str
# alpn: # alpn:
# - h3 # - h3
@ -662,14 +661,11 @@ proxies: # socks5
down: "200 Mbps" # 若不写单位,默认为 Mbps down: "200 Mbps" # 若不写单位,默认为 Mbps
# sni: server.com # sni: server.com
# skip-cert-verify: false # skip-cert-verify: false
# recv_window_conn: 12582912 # 将会在未来某个时候删除
# recv-window-conn: 12582912 # recv-window-conn: 12582912
# recv_window: 52428800 # 将会在未来某个时候删除
# recv-window: 52428800 # recv-window: 52428800
# ca: "./my.ca" # ca: "./my.ca"
# ca_str: "xyz" # 将会在未来某个时候删除
# ca-str: "xyz" # ca-str: "xyz"
# disable_mtu_discovery: false # disable-mtu-discovery: false
# fingerprint: xxxx # fingerprint: xxxx
# fast-open: true # 支持 TCP 快速打开,默认为 false # fast-open: true # 支持 TCP 快速打开,默认为 false
@ -710,7 +706,7 @@ proxies: # socks5
# dialer-proxy: "ss1" # dialer-proxy: "ss1"
# remote-dns-resolve: true # 强制dns远程解析默认值为false # remote-dns-resolve: true # 强制dns远程解析默认值为false
# dns: [ 1.1.1.1, 8.8.8.8 ] # 仅在remote-dns-resolve为true时生效 # dns: [ 1.1.1.1, 8.8.8.8 ] # 仅在remote-dns-resolve为true时生效
# 如果peers不为空该段落中的allowed_ips不可为空前面段落的server,port,ip,ipv6,public-key,pre-shared-key均会被忽略但private-key会被保留且只能在顶层指定 # 如果peers不为空该段落中的allowed-ips不可为空前面段落的server,port,ip,ipv6,public-key,pre-shared-key均会被忽略但private-key会被保留且只能在顶层指定
# peers: # peers:
# - server: 162.159.192.1 # - server: 162.159.192.1
# port: 2480 # port: 2480
@ -718,7 +714,7 @@ proxies: # socks5
# ipv6: fd01:5ca1:ab1e:80fa:ab85:6eea:213f:f4a5 # ipv6: fd01:5ca1:ab1e:80fa:ab85:6eea:213f:f4a5
# public-key: Cr8hWlKvtDt7nrvf+f0brNQQzabAqrjfBvas9pmowjo= # public-key: Cr8hWlKvtDt7nrvf+f0brNQQzabAqrjfBvas9pmowjo=
# # pre-shared-key: 31aIhAPwktDGpH4JDhA8GNvjFXEf/a6+UaQRyOAiyfM= # # pre-shared-key: 31aIhAPwktDGpH4JDhA8GNvjFXEf/a6+UaQRyOAiyfM=
# allowed_ips: ['0.0.0.0/0'] # allowed-ips: ['0.0.0.0/0']
# reserved: [209,98,59] # reserved: [209,98,59]
# tuic # tuic
@ -1014,42 +1010,42 @@ listeners:
type: tun type: tun
# rule: sub-rule-name1 # 默认使用 rules如果未找到 sub-rule 则直接使用 rules # rule: sub-rule-name1 # 默认使用 rules如果未找到 sub-rule 则直接使用 rules
# proxy: proxy # 如果不为空则直接将该入站流量交由指定proxy处理(当proxy不为空时这里的proxy名称必须合法否则会出错) # proxy: proxy # 如果不为空则直接将该入站流量交由指定proxy处理(当proxy不为空时这里的proxy名称必须合法否则会出错)
stack: system # gvisor / lwip stack: system # gvisor / mixed
dns-hijack: dns-hijack:
- 0.0.0.0:53 # 需要劫持的 DNS - 0.0.0.0:53 # 需要劫持的 DNS
# auto-detect-interface: false # 自动识别出口网卡 # auto-detect-interface: false # 自动识别出口网卡
# auto-route: false # 配置路由表 # auto-route: false # 配置路由表
# mtu: 9000 # 最大传输单元 # mtu: 9000 # 最大传输单元
inet4-address: # 必须手动设置ipv4地址段 inet4-address: # 必须手动设置ipv4地址段
- 198.19.0.1/30 - 198.19.0.1/30
inet6-address: # 必须手动设置ipv6地址段 inet6-address: # 必须手动设置ipv6地址段
- "fdfe:dcba:9877::1/126" - "fdfe:dcba:9877::1/126"
# strict_route: true # 将所有连接路由到tun来防止泄漏但你的设备将无法其他设备被访问 # strict-route: true # 将所有连接路由到tun来防止泄漏但你的设备将无法其他设备被访问
# inet4_route_address: # 启用 auto_route 时使用自定义路由而不是默认路由 # inet4-route-address: # 启用 auto-route 时使用自定义路由而不是默认路由
# - 0.0.0.0/1 # - 0.0.0.0/1
# - 128.0.0.0/1 # - 128.0.0.0/1
# inet6_route_address: # 启用 auto_route 时使用自定义路由而不是默认路由 # inet6-route-address: # 启用 auto-route 时使用自定义路由而不是默认路由
# - "::/1" # - "::/1"
# - "8000::/1" # - "8000::/1"
# endpoint_independent_nat: false # 启用独立于端点的 NAT # endpoint-independent-nat: false # 启用独立于端点的 NAT
# include_uid: # UID 规则仅在 Linux 下被支持,并且需要 auto_route # include-uid: # UID 规则仅在 Linux 下被支持,并且需要 auto-route
# - 0 # - 0
# include_uid_range: # 限制被路由的的用户范围 # include-uid-range: # 限制被路由的的用户范围
# - 1000-99999 # - 1000:99999
# exclude_uid: # 排除路由的的用户 # exclude-uid: # 排除路由的的用户
# - 1000 # - 1000
# exclude_uid_range: # 排除路由的的用户范围 # exclude-uid-range: # 排除路由的的用户范围
# - 1000-99999 # - 1000:99999
# Android 用户和应用规则仅在 Android 下被支持 # Android 用户和应用规则仅在 Android 下被支持
# 并且需要 auto_route # 并且需要 auto-route
# include_android_user: # 限制被路由的 Android 用户 # include-android-user: # 限制被路由的 Android 用户
# - 0 # - 0
# - 10 # - 10
# include_package: # 限制被路由的 Android 应用包名 # include-package: # 限制被路由的 Android 应用包名
# - com.android.chrome # - com.android.chrome
# exclude_package: # 排除被路由的 Android 应用包名 # exclude-package: # 排除被路由的 Android 应用包名
# - com.android.captiveportallogin # - com.android.captiveportallogin
# 入口配置与 Listener 等价,传入流量将和 socks,mixed 等入口一样按照 mode 所指定的方式进行匹配处理 # 入口配置与 Listener 等价,传入流量将和 socks,mixed 等入口一样按照 mode 所指定的方式进行匹配处理
# shadowsocks,vmess 入口配置传入流量将和socks,mixed等入口一样按照mode所指定的方式进行匹配处理 # shadowsocks,vmess 入口配置传入流量将和socks,mixed等入口一样按照mode所指定的方式进行匹配处理