跳转到内容

用户指南

本指南面向部署和运维这套软件的人,介绍共用同一个代理内核的两个程序。

一个 Xray 风格的独立代理,由一份 TOML 文件驱动。

  • 入站(inbound)接受客户端连接:SOCKS 4/4a/5、HTTP、Shadowsocks(AEAD 与 2022)、Trojan、VLESS、VMess、Hysteria 2,以及 TUN 设备。
  • 出站(outbound)把连接继续转发出去:直连(freedom)、blackhole、以客户端身份使用的上述各种代理协议,以及 WireGuard。
  • 路由用 first-match 规则为每个流选择出站,可以按域名、IP 段、端口、网络类型、来源地址和入站 tag 匹配。UDP 按包路由。
  • 配置是严格的:未知的键和未知的取值都会报错,写错一个字会让代理拒绝启动,而不是悄悄改变行为。etemenanki-app --test -c config.toml 可以只检查文件、不启动任何服务。

一个与 XrayR 兼容的代理面板节点 agent。

  • 通过 UniProxy API 对接 Xboard / V2board,或者通过 mod_mu 对接 SSPanel。
  • 节点的协议(VMess、VLESS、Trojan、Shadowsocks 或 Hysteria 2)、端口、传输层以及用户都由面板决定。katana 自己的配置文件只写怎么连接面板,以及所有本地的东西:证书、出站、路由和限制。
  • 它执行按用户的限速,拒绝命中审计规则的目标地址,并把每个用户的流量上报给面板。
  • 一个进程可以同时服务多个节点,每个节点有自己的面板连接。
你想要…… 运行
用一份配置文件运行自己的代理服务端或客户端 etemenanki-app
为用户和设置都在面板里管理的节点提供服务 katana
在不动生产节点的前提下,检查某个上游(比如一个 WireGuard 端点)是否真的能通 etemenanki-app,作为临时的本地 SOCKS 代理
  • 配置片段都是 TOML,键名与程序要求的拼写完全一致。
  • 示例中的地址、密钥、密码和 UUID 都是占位值:example.com、192.0.2.0/24、2001:db8::/32 以及明显是假的密钥。请替换成你自己的值。
  • 完整的示例文件在发布前都会用程序的 --test 模式检查过。