Skip to content

入站总览 ​

inbounds 是从名字到入站映射的表。每个入站必须把 type 写在第一项。

yaml
inbounds:
  local:
    type: mixed
    listen: 127.0.0.1:7890

dns:
  servers:
    default: {type: udp, address: 127.0.0.1:53}
  final: default

类型 ​

type页面平台
taptapLinux
tuntunLinux
capturecaptureLinux
dnsdns
shadowsocksshadowsocks
sockssocks
httphttp
mixedmixed
anytlsanytlsLinux
kasumikasumi
kyoukaikyoukai
miragemirageLinux
iminaiminaLinux
naivenaiveLinux
directdirect

公共监听字段 ​

除 tap、tun、capture 外,其余入站都监听一个 socket,并接受以下字段。

type ​

  • 类型:字符串枚举。
  • 必填:是,且必须写在入站映射的第一项。
  • 取值:本页类型表中的 15 个值。

listen ​

  • 类型:SocketAddr。
  • 必填:是,但具体页面若把它放进自身字段仍遵守此处语义。
  • 取值:IP:port;不做主机名解析。

interface ​

  • 类型:接口名。
  • 必填:可选。
  • 默认:不限定。

tcp_keep_alive ​

  • 类型:时长。
  • 必填:可选。
  • 默认:不主动设置。

tcp_keep_alive_interval ​

  • 类型:时长。
  • 必填:可选。
  • 默认:不主动设置。

tcp_multi_path ​

  • 类型:布尔值。
  • 默认:false。

tcp_congestion ​

  • 类型:字符串。
  • 默认:系统 TCP 拥塞控制。

proxy_protocol ​

  • 类型:布尔值。
  • 默认:false。
  • 行为:每个 TCP 连接先读 PROXY v1 或 v2 头,以头里的客户端为准。

公共承载字段 ​

network ​

  • 类型:字符串枚举。
  • 默认:同时接受 TCP 与 UDP。
  • 取值:tcp、udp。
  • 限制:udp 只允许 Shadowsocks;其他入站只能在流中承载 UDP。

udp_timeout ​

  • 类型:时长。
  • 默认:5m。
  • 限制:dns、direct 不接受。

full_cone ​

  • 类型:布尔值。
  • 默认:false。
  • 限制:dns、direct 不接受。打开后同一客户端、同一路径的 UDP 对外共用一个映射。

公共嵌套块 ​

fallback ​

见 fallback 占位页。只有 Anytls、Kyoukai、Naive、Imina、HTTP、Mixed,或前面套了 stream transport 的代理能使用。

transport ​

见 transport 占位页。只允许 Shadowsocks、SOCKS、HTTP、Mixed、AnyTLS、Kasumi、Kyoukai、Mirage;Naive/Imina 自带 HTTP,不能另套。

users ​

见 users 占位页。不同协议对名称和密码的解释不同,以各入站页面为准。

tls ​

见 TLS 服务端占位页。是否必填取决于入站类型。

说明 ​

公共字段与入站自身字段写在同一个映射里。解析器先剥出 listen、carry、fallback、transport 和监听选项,再把剩余字段交给具体类型;任何一边都不认识的字段都会报错。type 后置、重复键和值为 null 的必填项都会被拒绝。

相关 ​

页面历史

开发者设计、代码地图和验证记录保留在仓库 manual/。