统一入口与服务端入站 完整字段索引¶
由配置源码生成
本页由 scripts/config-reference.py 从 core-config 的公开 Serde 结构生成，覆盖 YAML/JSON 实际接受的字段、重命名、别名、默认规则和 枚举写法。修改配置模型后必须重新生成；CI 会拒绝缺字段或过期页面。
Mixed、TUN、TPROXY、REDIRECT、Panel、Shadowsocks、WireGuard、Young、gRPC、REALITY 和 XHTTP 入站。
全手册当前覆盖 828 个字段、55 个枚举类型。 行为说明和跨字段约束请同时阅读同分类下的人工手册页面。
Inbound¶
inbounds 使用 type 判别入口，透明入口字段与 TUN 字段位于同一层。
type | 专用字段 | 公共透明字段 |
|---|---|---|
mixed | listen、listen_port、udp、users、streamSettings | tag、enabled |
tun | TUN 全部字段 | tag、enabled、traffic、dns_mode、stack、mtu、offload、exclude |
tproxy | 透明入口共用字段 | tag、enabled、traffic、dns_mode、stack、offload、exclude |
redirect | 透明入口共用字段 | tag、enabled、traffic、dns_mode、stack、offload、exclude |
ebpf | Aya eBPF 字段 | tag、enabled、redirect_address、bypass_rule_set、UID 过滤、dns_mode、策略路由与 map 容量 |
每个 tag 必须唯一。当前运行时最多启用一个 Mixed，并且 tun、tproxy、redirect、ebpf 中最多启用一个宿主流量入口。
Listen¶
Listen 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
local | ListenLocal（可选） | 可选；默认不设置 | 无 | Port(u16)Detail(ListenLocalDetail) | Listen 的 local 参数。解析类型为 ListenLocal（可选）；组合约束由 wuther-core check 校验。 源码 |
panel | PanelBind（可选） | 可选；默认不设置 | 无 | Off(bool)Port(u16)Address(String) | Listen 的 panel 参数。解析类型为 PanelBind（可选）；组合约束由 wuther-core check 校验。 源码 |
xhttp | XhttpListenSet（可选） | 可选；默认不设置 | split-httpsplit_httpsplithttp | 无 | XHTTP/SplitHTTP 服务端监听。既接受单个对象，也接受对象数组。 源码 |
shadowsocks | ShadowsocksListenSet（可选） | 可选；默认不设置 | ss | One(ShadowsocksListen)Many(Vec<ShadowsocksListen>) | Shadowsocks SIP003/SIP004/SIP022 服务端监听。 源码 |
share | Share（可选） | 可选；默认不设置 | 无 | falsehomeall | Listen 的 share 参数。解析类型为 Share（可选）；组合约束由 wuther-core check 校验。 源码 |
auth | 字符串 列表 | 可选；默认空 | 无 | 无 | Listen 的 auth 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
reality | RealityListen 列表 | 可选；默认空 | reality-inboundsreality_inbounds | 无 | REALITY 是一层入站流安全协议；每个条目独立监听并在认证后交给 protocol 指定的内层代理协议。 源码 |
wireguard | WireGuardListen 列表 | 可选；默认空 | wireguard-inboundswireguard_inbounds | 无 | WireGuard 服务端入站。每个条目绑定一个 UDP 端口，并把已认证对端的 IPv4/IPv6 包交给 WutherCore 的 TCP/UDP 路由运行时。 源码 |
young | YoungListen 列表 | 可选；默认空 | young-inboundsyoung_inbounds | 无 | Young 原生入站。传输层是 Firefox 使用的 Mozilla Neqo HTTP/3/WebTransport。 源码 |
grpc | GrpcListen 列表 | 可选；默认空 | grpc-inboundsgrpc_inbounds | 无 | Xray gRPC (gun) 入站。每个条目独立监听，并把 Tun/TunMulti 双向流交给 protocol 指定的内层代理协议。 源码 |
ShadowsocksListen¶
ShadowsocksListen 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
enabled | 布尔值 | 可选；默认 true | 无 | 无 | 控制该配置块是否启用；关闭时保留配置但不启动对应运行时能力。 源码 |
address | 字符串 | 可选；默认 0.0.0.0 | host | 无 | 监听或连接使用的主机/IP 地址；是否允许域名由所在协议和校验阶段决定。 源码 |
port | 0-65535 整数 | 必填 | 无 | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
method | 字符串 | 必填 | 无 | 无 | ShadowsocksListen 的 method 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
password | 字符串 | 必填 | 无 | 无 | 敏感认证材料；不要写入公开仓库、日志或截图。 源码 |
mode | 字符串 | 可选；默认 tcp_and_udp | 无 | 无 | ShadowsocksListen 的 mode 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
plugin | 字符串（可选） | 可选；默认不设置 | 无 | 无 | SIP003 服务端插件可执行文件。插件监听公开地址，Shadowsocks 服务端本身只监听插件分配的回环地址。 源码 |
plugin-opts | 字符串（可选） | 可选；默认不设置 | plugin_opts | 无 | ShadowsocksListen 的 plugin-opts 参数。解析类型为 字符串（可选）；组合约束由 wuther-core check 校验。 源码 |
plugin-args | 字符串 列表 | 可选；默认空 | plugin_args | 无 | ShadowsocksListen 的 plugin-args 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
plugin-mode | 字符串（可选） | 可选；默认不设置 | plugin_mode | 无 | ShadowsocksListen 的 plugin-mode 参数。解析类型为 字符串（可选）；组合约束由 wuther-core check 校验。 源码 |
plugin-startup-timeout | 时长 | 可选；默认 10s | plugin_startup_timeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
users | ShadowsocksUser 列表 | 可选；默认空 | 无 | 无 | ShadowsocksListen 的 users 参数。解析类型为 ShadowsocksUser 列表；组合约束由 wuther-core check 校验。 源码 |
handshake-timeout | 时长 | 可选；默认 10s | handshake_timeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
udp-timeout | 时长 | 可选；默认 5m | udp_timeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
max-connections | 非负整数 | 可选；默认 1024 | max_connections | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
max-udp-associations | 非负整数 | 可选；默认 4096 | max_udp_associations | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
tag | 字符串（可选） | 可选；默认不设置 | 无 | 无 | 用于显示、日志和其它配置项引用的稳定名称。 源码 |
ShadowsocksUser¶
ShadowsocksUser 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
name | 字符串 | 必填 | 无 | 无 | 用于显示、日志和其它配置项引用的稳定名称。 源码 |
key | 字符串 | 必填 | 无 | 无 | ShadowsocksUser 的 key 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
WireGuardListen¶
WireGuardListen 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
host | 字符串 | 可选；默认 0.0.0.0 | 无 | 无 | 监听或连接使用的主机/IP 地址；是否允许域名由所在协议和校验阶段决定。 源码 |
port | 0-65535 整数 | 必填 | 无 | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
privateKey | 字符串 | 必填 | private_keyprivate-key | 无 | 敏感认证材料；不要写入公开仓库、日志或截图。 源码 |
peers | WireGuardListenPeer 列表 | 必填 | 无 | 无 | WireGuardListen 的 peers 参数。解析类型为 WireGuardListenPeer 列表；组合约束由 wuther-core check 校验。 源码 |
mtu | 非负整数 | 可选；默认 1420 | 无 | 无 | WireGuardListen 的 mtu 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
packetQueue | 非负整数 | 可选；默认 1024 | packet_queuepacket-queue | 无 | WireGuardListen 的 packetQueue 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
handshakeRateLimit | 非负整数 | 可选；默认 100 | handshake_rate_limithandshake-rate-limit | 无 | WireGuardListen 的 handshakeRateLimit 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
WireGuardListenPeer¶
WireGuardListenPeer 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
publicKey | 字符串 | 必填 | public_keypublic-key | 无 | WireGuardListenPeer 的 publicKey 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
presharedKey | 字符串（可选） | 可选；默认不设置 | preshared_keypreshared-key | 无 | WireGuardListenPeer 的 presharedKey 参数。解析类型为 字符串（可选）；组合约束由 wuther-core check 校验。 源码 |
allowedIPs | 字符串 列表 | 必填 | allowed_ipsallowed-ips | 无 | WireGuardListenPeer 的 allowedIPs 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
reserved | 0-255 整数 列表 | 可选；默认空 | 无 | 无 | WireGuardListenPeer 的 reserved 参数。解析类型为 0-255 整数 列表；组合约束由 wuther-core check 校验。 源码 |
persistentKeepalive | 0-65535 整数（可选） | 可选；默认不设置 | persistent_keepalivepersistent-keepalive | 无 | WireGuardListenPeer 的 persistentKeepalive 参数。解析类型为 0-65535 整数（可选）；组合约束由 wuther-core check 校验。 源码 |
YoungListen¶
YoungListen 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
host | 字符串 | 可选；默认 0.0.0.0 | 无 | 无 | 监听或连接使用的主机/IP 地址；是否允许域名由所在协议和校验阶段决定。 源码 |
port | 0-65535 整数 | 必填 | 无 | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
nssDatabase | 字符串 | 必填 | nss_databasenss-databasenss-db | 无 | YoungListen 的 nssDatabase 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
certificateNickname | 字符串 | 必填 | certificate_nicknamecertificate-nicknamecertificate | 无 | YoungListen 的 certificateNickname 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
authority | 字符串 | 必填 | 无 | 无 | YoungListen 的 authority 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
path | 字符串 | 可选；默认 /assets | 无 | 无 | 文件或 URL 路径；相对路径按运行进程的工作目录解析。 源码 |
users | 字符串 列表 | 可选；默认空 | 无 | 无 | YoungListen 的 users 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
clockSkew | 时长 | 可选；默认 2m | clock_skewclock-skew | 无 | YoungListen 的 clockSkew 参数。解析类型为 时长；组合约束由 wuther-core check 校验。 源码 |
idleTimeout | 时长 | 可选；默认 5m | idle_timeoutidle-timeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
maxStreams | 非负整数 | 可选；默认 1024 | max_streamsmax-streams | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
maxSessions | 非负整数 | 可选；默认 4096 | max_sessionsmax-sessions | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
maxFlowsPerSession | 非负整数 | 可选；默认 1024 | max_flows_per_sessionmax-flows-per-session | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
paddingMin | 0-65535 整数 | 可选；默认 d_e_f_a_u_l_t__p_a_d_d_i_n_g__m_i_n | padding_minpadding-min | 无 | YoungListen 的 paddingMin 参数。解析类型为 0-65535 整数；组合约束由 wuther-core check 校验。 源码 |
paddingMax | 0-65535 整数 | 可选；默认 d_e_f_a_u_l_t__p_a_d_d_i_n_g__m_a_x | padding_maxpadding-max | 无 | YoungListen 的 paddingMax 参数。解析类型为 0-65535 整数；组合约束由 wuther-core check 校验。 源码 |
paddingSchemeLength | 0-65535 整数 | 可选；默认 d_e_f_a_u_l_t__p_a_d_d_i_n_g__s_c_h_e_m_e__l_e_n_g_t_h | padding_scheme_lengthpadding-scheme-length | 无 | YoungListen 的 paddingSchemeLength 参数。解析类型为 0-65535 整数；组合约束由 wuther-core check 校验。 源码 |
decoyStatus | 0-65535 整数 | 可选；默认 404 | decoy_statusdecoy-status | 无 | YoungListen 的 decoyStatus 参数。解析类型为 0-65535 整数；组合约束由 wuther-core check 校验。 源码 |
decoyBody | 字符串 | 可选；默认 <!doctype html><html><head><title>Not Found</title></head><body><h1>Not Found</h1></body></html> | decoy_bodydecoy-body | 无 | YoungListen 的 decoyBody 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
GrpcListen¶
GrpcListen 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
host | 字符串 | 可选；默认 0.0.0.0 | 无 | 无 | 监听或连接使用的主机/IP 地址；是否允许域名由所在协议和校验阶段决定。 源码 |
port | 0-65535 整数 | 必填 | 无 | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
protocol | 字符串 | 可选；默认 vless | 无 | 无 | GrpcListen 的 protocol 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
users | 字符串 列表 | 可选；默认空 | 无 | 无 | GrpcListen 的 users 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
grpcSettings | GrpcTransportSettings | 可选；使用类型默认值 | grpcgrpc_settingsgrpc-settings | 无 | GrpcListen 的 grpcSettings 参数。解析类型为 GrpcTransportSettings；组合约束由 wuther-core check 校验。 源码 |
security | GrpcListenSecurity | 可选；默认 None | 无 | none（默认）tlsreality | 底层安全载波。省略时是明文 h2c；TLS 与 REALITY 必须显式选择， 防止密钥配置存在但因拼写或遗漏而静默降级。 源码 |
tlsSettings | XhttpDownloadTlsSettings（可选） | 可选；默认不设置 | tls_settingstls-settings | 无 | 与 Xray tlsSettings 同构的完整 TLS 对象。gRPC 会强制协商 h2， 其余证书、ECH、mTLS、版本、密码套件与曲线字段不做裁剪。 源码 |
requireClientCertificate | 布尔值 | 可选；默认 false | require_client_certificaterequire-client-certificate | 无 | GrpcListen 的 requireClientCertificate 参数。解析类型为 布尔值；组合约束由 wuther-core check 校验。 源码 |
realitySettings | RealityListen（可选） | 可选；默认不设置 | reality_settingsreality-settings | 无 | REALITY 服务端设置复用完整的监听模型。嵌套对象的 host、port、 protocol 与 users 由外层 gRPC 监听统一覆盖，避免重复配置冲突。 源码 |
handshakeTimeout | 时长 | 可选；默认 10s | handshake_timeouthandshake-timeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
maxMuxSessions | 非负整数 | 可选；默认 1024 | max_mux_sessionsmax-mux-sessions | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
maxConnections | 非负整数 | 可选；默认 4096 | max_connectionsmax-connections | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
maxConcurrentStreams | 非负整数 | 可选；默认 1024 | max_concurrent_streamsmax-concurrent-streams | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
maxHeaderListSize | 非负整数 | 可选；默认 65536 | max_header_list_sizemax-header-list-size | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
trustedXForwardedFor | 字符串 列表 | 可选；默认空 | trusted_x_forwarded_fortrusted-x-forwarded-for | 无 | 与 Xray 一致：这里存放“信任标记请求头”的名称；仅当请求中至少 存在一个标记头时，才采用 X-Forwarded-For 的第一个地址。 源码 |
RealityListen¶
Xray REALITY 服务端监听配置。 字段名同时接受 Xray 的 camelCase 与本项目常用的 snake/kebab 写法； 未知字段一律拒绝，避免把密钥或限速字段拼错后静默降级。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
host | 字符串 | 可选；默认 0.0.0.0 | 无 | 无 | 监听或连接使用的主机/IP 地址；是否允许域名由所在协议和校验阶段决定。 源码 |
port | 0-65535 整数 | 可选；默认 0 | 无 | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
protocol | 字符串 | 可选；默认 vless | 无 | 无 | RealityListen 的 protocol 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
users | 字符串 列表 | 可选；默认空 | 无 | 无 | RealityListen 的 users 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
target | RealityTarget（可选） | 可选；默认不设置 | 无 | Port(u16)Address(String) | RealityListen 的 target 参数。解析类型为 RealityTarget（可选）；组合约束由 wuther-core check 校验。 源码 |
dest | RealityTarget（可选） | 可选；默认不设置 | 无 | Port(u16)Address(String) | RealityListen 的 dest 参数。解析类型为 RealityTarget（可选）；组合约束由 wuther-core check 校验。 源码 |
type | 字符串（可选） | 可选；默认不设置 | target_typetarget-type | 无 | RealityListen 的 type 参数。解析类型为 字符串（可选）；组合约束由 wuther-core check 校验。 源码 |
show | 布尔值 | 可选；默认 false | 无 | 无 | RealityListen 的 show 参数。解析类型为 布尔值；组合约束由 wuther-core check 校验。 源码 |
masterKeyLog | 字符串（可选） | 可选；默认不设置 | master_key_logmaster-key-log | 无 | RealityListen 的 masterKeyLog 参数。解析类型为 字符串（可选）；组合约束由 wuther-core check 校验。 源码 |
xver | 0-255 整数 | 可选；默认 0 | 无 | 无 | RealityListen 的 xver 参数。解析类型为 0-255 整数；组合约束由 wuther-core check 校验。 源码 |
serverNames | 字符串 列表 | 可选；默认空 | server_namesserver-names | 无 | RealityListen 的 serverNames 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
privateKey | 字符串 | 可选；默认空字符串 | private_keyprivate-key | 无 | 敏感认证材料；不要写入公开仓库、日志或截图。 源码 |
minClientVer | 字符串（可选） | 可选；默认不设置 | min_client_vermin-client-ver | 无 | 对应范围或资源量的下限。 源码 |
maxClientVer | 字符串（可选） | 可选；默认不设置 | max_client_vermax-client-ver | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
maxTimeDiff | 非负整数 | 可选；默认 0 | max_time_diffmax-time-diff | 无 | 与 Xray 一致，单位为毫秒；0 表示不限制时钟差。 源码 |
shortIds | 字符串 列表 | 可选；默认空 | short_idsshort-ids | 无 | RealityListen 的 shortIds 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
mldsa65Seed | 字符串（可选） | 可选；默认不设置 | mldsa65_seedmldsa65-seed | 无 | RealityListen 的 mldsa65Seed 参数。解析类型为 字符串（可选）；组合约束由 wuther-core check 校验。 源码 |
limitFallbackUpload | RealityFallbackLimit | 可选；使用类型默认值 | limit_fallback_uploadlimit-fallback-upload | 无 | RealityListen 的 limitFallbackUpload 参数。解析类型为 RealityFallbackLimit；组合约束由 wuther-core check 校验。 源码 |
limitFallbackDownload | RealityFallbackLimit | 可选；使用类型默认值 | limit_fallback_downloadlimit-fallback-download | 无 | RealityListen 的 limitFallbackDownload 参数。解析类型为 RealityFallbackLimit；组合约束由 wuther-core check 校验。 源码 |
limits | RealityResourceLimits | 可选；使用类型默认值 | 无 | 无 | RealityListen 的 limits 参数。解析类型为 RealityResourceLimits；组合约束由 wuther-core check 校验。 源码 |
streamSettings | crate::NodeStreamSettings（可选） | 可选；默认不设置 | stream_settings | 无 | Socket policy and TCP FinalMask applied before the REALITY ClientHello. 源码 |
RealityFallbackLimit¶
RealityFallbackLimit 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
afterBytes | 非负整数 | 可选；默认 0 | after_bytesafter-bytes | 无 | RealityFallbackLimit 的 afterBytes 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
bytesPerSec | 非负整数 | 可选；默认 0 | bytes_per_secbytes-per-sec | 无 | RealityFallbackLimit 的 bytesPerSec 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
burstBytesPerSec | 非负整数 | 可选；默认 0 | burst_bytes_per_secburst-bytes-per-sec | 无 | RealityFallbackLimit 的 burstBytesPerSec 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
RealityResourceLimits¶
RealityResourceLimits 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
handshake_timeout | 时长 | 可选；默认 10s | handshake-timeouthandshakeTimeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
target_handshake_timeout | 时长 | 可选；默认 5s | target-handshake-timeouttargetHandshakeTimeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
idle_timeout | 时长 | 可选；默认 5m | idle-timeoutidleTimeout | 无 | 超时上限；时长字段接受 ms、s、m、h 等 humantime 写法。 源码 |
max_client_hello_records | 非负整数 | 可选；默认 16 | max-client-hello-recordsmaxClientHelloRecords | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
max_client_hello_record_payload | 非负整数 | 可选；默认 16640 | max-client-hello-record-payloadmaxClientHelloRecordPayload | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
max_client_hello_bytes | 非负整数 | 可选；默认 u16::MAX as usize | max-client-hello-bytesmaxClientHelloBytes | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
max_client_hello_wire_bytes | 非负整数 | 可选；默认 98304 | max-client-hello-wire-bytesmaxClientHelloWireBytes | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
max_target_records | 非负整数 | 可选；默认 12 | max-target-recordsmaxTargetRecords | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
max_target_handshake_bytes | 非负整数 | 可选；默认 98304 | max-target-handshake-bytesmaxTargetHandshakeBytes | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
application_buffer_bytes | 非负整数 | 可选；默认 262144 | application-buffer-bytesapplicationBufferBytes | 无 | RealityResourceLimits 的 application_buffer_bytes 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
max_concurrent_handshakes | 非负整数 | 可选；默认 1024 | max-concurrent-handshakesmaxConcurrentHandshakes | 无 | 对应资源或并发量的硬上限，用于限制内存、连接或任务扩张。 源码 |
ListenLocalDetail¶
ListenLocalDetail 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
tag | 字符串（可选） | 可选；默认不设置 | 无 | 无 | 用于显示、日志和其它配置项引用的稳定名称。 源码 |
host | 字符串 | 可选；默认 127.0.0.1 | 无 | 无 | 监听或连接使用的主机/IP 地址；是否允许域名由所在协议和校验阶段决定。 源码 |
port | 0-65535 整数 | 必填 | 无 | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
auth | 字符串 列表 | 可选；默认空 | 无 | 无 | ListenLocalDetail 的 auth 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
udp | 布尔值 | 可选；默认 true | 无 | 无 | ListenLocalDetail 的 udp 参数。解析类型为 布尔值；组合约束由 wuther-core check 校验。 源码 |
streamSettings | crate::NodeStreamSettings（可选） | 可选；默认不设置 | stream_settings | 无 | Xray-compatible listener socket policy and server-side final masks. Both spellings are accepted so native YAML and imported Xray objects share one typed configuration path. 源码 |
MixedInboundOptions¶
MixedInboundOptions 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
tag | 字符串 | 可选；由 default_mixed_inbound_tag() 决定 | 无 | 无 | 用于显示、日志和其它配置项引用的稳定名称。 源码 |
enabled | 布尔值 | 可选；默认 true | 无 | 无 | 控制该配置块是否启用；关闭时保留配置但不启动对应运行时能力。 源码 |
listen | 字符串 | 可选；默认 127.0.0.1 | hostbind | 无 | MixedInboundOptions 的 listen 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
listen_port | 0-65535 整数 | 必填 | listen-portport | 无 | 监听或连接使用的端口；0 是否允许由所在配置块校验。 源码 |
udp | 布尔值 | 可选；默认 true | 无 | 无 | MixedInboundOptions 的 udp 参数。解析类型为 布尔值；组合约束由 wuther-core check 校验。 源码 |
users | InboundUser 列表 | 可选；默认空 | 无 | 无 | MixedInboundOptions 的 users 参数。解析类型为 InboundUser 列表；组合约束由 wuther-core check 校验。 源码 |
streamSettings | crate::NodeStreamSettings（可选） | 可选；默认不设置 | stream_settings | 无 | MixedInboundOptions 的 streamSettings 参数。解析类型为 crate::NodeStreamSettings（可选）；组合约束由 wuther-core check 校验。 源码 |
InboundUser¶
InboundUser 配置对象。
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
username | 字符串 | 必填 | user | 无 | InboundUser 的 username 参数。解析类型为 字符串；组合约束由 wuther-core check 校验。 源码 |
password | 字符串 | 必填 | pass | 无 | 敏感认证材料；不要写入公开仓库、日志或截图。 源码 |
EbpfInboundOptions¶
Aya eBPF inbound. The cgroup programs select local TCP and UDP sockets by UID and destination, TC ingress selects hotspot and forwarded-device traffic. Socket assignment prefers sk_lookup and automatically falls back to loopback TC ingress on Android kernels that reject netns BPF links. Neither path requires iptables, nftables, TPROXY, or destination NAT.
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
tag | 字符串 | 可选；默认 ebpf-in | 无 | 无 | 用于显示、日志和其它配置项引用的稳定名称。 源码 |
enabled | 布尔值 | 可选；默认 true | 无 | 无 | 控制该配置块是否启用；关闭时保留配置但不启动对应运行时能力。 源码 |
redirect_address | 字符串 列表 | 可选；默认 vec!["127.128.0.0/9".into(), "2001:db8:2030::/64".into()] | 无 | 无 | EbpfInboundOptions 的 redirect_address 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
bypass_rule_set | 字符串 列表 | 可选；默认空 | 无 | 无 | EbpfInboundOptions 的 bypass_rule_set 参数。解析类型为 字符串 列表；组合约束由 wuther-core check 校验。 源码 |
include_uid | 非负整数 列表 | 可选；默认空 | 无 | 无 | 包含/排除过滤条件；与同配置块其它过滤器的组合规则见对应语义手册。 源码 |
include_uid_range | 字符串 列表 | 可选；默认空 | 无 | 无 | 包含/排除过滤条件；与同配置块其它过滤器的组合规则见对应语义手册。 源码 |
exclude_uid | 非负整数 列表 | 可选；默认空 | 无 | 无 | 包含/排除过滤条件；与同配置块其它过滤器的组合规则见对应语义手册。 源码 |
exclude_uid_range | 字符串 列表 | 可选；默认空 | 无 | 无 | 包含/排除过滤条件；与同配置块其它过滤器的组合规则见对应语义手册。 源码 |
cgroup_path | PathBuf | 可选；默认 PathBuf::from("/sys/fs/cgroup") | 无 | 无 | 文件或 URL 路径；相对路径按运行进程的工作目录解析。 源码 |
route_table | 非负整数 | 可选；由 default_ebpf_route_table() 决定 | 无 | 无 | EbpfInboundOptions 的 route_table 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
rule_priority | 非负整数 | 可选；由 default_ebpf_rule_priority() 决定 | 无 | 无 | EbpfInboundOptions 的 rule_priority 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
mark | 非负整数 | 可选；由 default_ebpf_mark() 决定 | 无 | 无 | EbpfInboundOptions 的 mark 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
map_capacity | 非负整数 | 可选；由 default_ebpf_map_capacity() 决定 | 无 | 无 | EbpfInboundOptions 的 map_capacity 参数。解析类型为 非负整数；组合约束由 wuther-core check 校验。 源码 |
capabilities | EbpfCapabilityOptions | 可选；使用类型默认值 | 无 | 无 | Linux capability handling for the eBPF data plane. 源码 |
shared_network | EbpfSharedNetworkOptions | 可选；使用类型默认值 | shared-networkhotspottethering | 无 | Optional hotspot, tethering, bridge, and router-forwarding data path. 源码 |
dns_mode | CaptureResolver | 可选；默认 hijack | dns-mode | 无 | EbpfInboundOptions 的 dns_mode 参数。解析类型为 CaptureResolver；组合约束由 wuther-core check 校验。 源码 |
EbpfCapabilityOptions¶
Capability policy used while loading and maintaining the eBPF inbound. Linux capabilities are thread-local. The runtime therefore checks every privileged attach/reconcile path instead of assuming that uid 0 implies a complete capability set.
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
auto_raise | 布尔值 | 可选；默认 true | auto-raise | 无 | Promote a required capability from the permitted set into the effective set on the current worker thread before a privileged operation. 源码 |
allow_sys_admin_fallback | 布尔值 | 可选；默认 true | allow-sys-admin-fallback | 无 | Accept CAP_SYS_ADMIN as the kernel-compatible BPF authority when CAP_BPF is unavailable. Required by kernels predating CAP_BPF and some Android vendor backports. 源码 |
EbpfSharedNetworkOptions¶
Forwarded-device capture for Linux routers and Android hotspot/tethering. The TC ingress program is attached only to interfaces matched by include_interface and not matched by exclude_interface. Source filters are evaluated before a packet receives the eBPF inbound mark.
| YAML / JSON 字段 | 类型 | 必填与默认 | 兼容别名 | 取值 / 形态 | 解析与用途 |
|---|---|---|---|---|---|
enabled | 布尔值 | 可选；默认 false | 无 | 无 | Enable TC ingress capture for forwarded devices. 源码 |
include_interface | 字符串 列表 | 可选；默认 [ "ap*", "swlan*", "wlan*", "rndis*", "usb*", "bt-pan*", "bnep*", "br*", "eth*", "en*", ] .into_iter() .map(str::to_owned) .collect() | 无 | 无 | Interface-name glob patterns eligible for dynamic TC attachment. 源码 |
exclude_interface | 字符串 列表 | 可选；默认 [ "lo", "tun*", "tap*", "wg*", "rpktun*", "docker*", "veth*", "rmnet*", "ccmni*", "wwan*", ] .into_iter() .map(str::to_owned) .collect() | 无 | 无 | Interface-name glob patterns removed from the eligible set. 源码 |
include_source_address | 字符串 列表 | 可选；默认 vec!["0.0.0.0/0".into(), "::/0".into()] | 无 | 无 | Source CIDRs accepted from selected downstream interfaces. An empty list accepts every source address. 源码 |
exclude_source_address | 字符串 列表 | 可选；默认 空 | 无 | 无 | Source CIDRs bypassed before the include set is evaluated. 源码 |
interface_refresh_interval | 时长 | 可选；由 default_ebpf_interface_refresh_interval() 决定 | 无 | 无 | Polling interval used to attach newly created hotspot interfaces and detach interfaces removed by Android or Linux network management. 源码 |
packet_stats | 布尔值 | 可选；默认 false | 无 | 无 | Collect per-packet TC diagnostics for shared-network traffic. Disabled by default because updating a BPF counter for every forwarded packet adds measurable CPU cost on mobile hotspots. Flow-level lookup and local socket counters remain available when this is disabled. 源码 |
tc_priority | 0-65535 整数 | 可选；由 default_ebpf_tc_priority() 决定 | 无 | 无 | Legacy clsact filter priority. Lower values run before tethering offload. 源码 |
本分类枚举¶
ShadowsocksListenSet¶
ShadowsocksListenSet 的可接受配置形态。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
One(ShadowsocksListen) | 无 | 映射到 Rust 变体 ShadowsocksListenSet::One。 |
Many(Vec<ShadowsocksListen>) | 无 | 映射到 Rust 变体 ShadowsocksListenSet::Many。 |
GrpcListenSecurity¶
完整的 Xray gRPC 服务端监听配置。 grpcSettings 沿用 Xray 字段名；本地资源上限单独注册，所有未知字段 均拒绝，避免拼写错误导致无界队列或静默使用默认值。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
none（默认） | 无 | 映射到 Rust 变体 GrpcListenSecurity::None。 |
tls | 无 | 映射到 Rust 变体 GrpcListenSecurity::Tls。 |
reality | 无 | 映射到 Rust 变体 GrpcListenSecurity::Reality。 |
RealityTarget¶
RealityTarget 的可接受配置形态。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
Port(u16) | 无 | 映射到 Rust 变体 RealityTarget::Port。 |
Address(String) | 无 | 映射到 Rust 变体 RealityTarget::Address。 |
ListenLocal¶
listen.local 支持端口写法 / 完整对象。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
Port(u16) | 无 | 映射到 Rust 变体 ListenLocal::Port。 |
Detail(ListenLocalDetail) | 无 | 映射到 Rust 变体 ListenLocal::Detail。 |
PanelBind¶
PanelBind 的可接受配置形态。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
Off(bool) | 无 | 映射到 Rust 变体 PanelBind::Off。 |
Port(u16) | 无 | 映射到 Rust 变体 PanelBind::Port。 |
Address(String) | 无 | 映射到 Rust 变体 PanelBind::Address。 |
Share¶
Share 的可接受配置形态。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
false | 无 | 映射到 Rust 变体 Share::False。 |
home | 无 | 映射到 Rust 变体 Share::Home。 |
all | 无 | 映射到 Rust 变体 Share::All。 |
ShareValue¶
ShareValue 的可接受配置形态。 源码
| 写法 | 兼容别名 | 含义 |
|---|---|---|
Bool(bool) | 无 | 映射到 Rust 变体 ShareValue::Bool。 |
Tag(Share) | 无 | 映射到 Rust 变体 ShareValue::Tag。 |