文档

从第一次连接到理解协议，找到使用 Umbra 所需的一切。

为什么选择 Umbra

了解真实站点掩护、TCP 与 QUIC 分流、现有客户端接入，以及何时适合选择 Umbra。

安装

选择适合平台的发布产物，或从 Rust 源码构建。

快速开始

生成身份材料，连接第一组客户端与服务端。

配置服务端

配置真实目标站点并启动服务端。

接入应用与 Clash 类客户端

用本地 SOCKS5 接入已有应用和规则客户端，并为 TCP 与 UDP 分别选择传输。

部署与运维

将服务端作为服务运行并管理资源。

升级 Umbra

为当前 alpha 版本安排兼容的两端升级。

服务端配置

服务端必填字段、默认值与校验规则。

客户端配置

选择传输、身份材料和本地代理地址。

配置示例

TCP mux、Vision 与 QUIC UDP 的起步模板。

架构

了解 Rust crate 如何分担连接生命周期。

如何选择 TCP、Vision 与 QUIC

按网络条件与应用流量选择模式，在一个 SOCKS5 入口中分别承载 TCP 和 UDP。

安全模型

理解认证、密钥管理和保护边界。

CLI 命令参考

server、client、keygen 子命令及其选项。

性能与策略参考

内存预算、自适应 mux、填充和拥塞控制。

Umbra 与主流代理方案对比

从真实站点掩护、证书维护、TCP/UDP 路径和客户端接入，对比 Xray、VMess、Trojan、Shadowsocks 与 Hysteria 2。

故障排查

定位配置、连接和传输问题。

参与贡献

通过规格、评审和有效测试参与项目。