-
-
Notifications
You must be signed in to change notification settings - Fork 5
Documentation Index
川意 · MiChongs edited this page Jul 22, 2026
·
1 revision
这里收录 README 之外需要长期维护的说明。第一次使用时,从配置指南开始;准备修改代码时,先看架构和贡献指南。
| 文档 | 解决的问题 |
|---|---|
| 功能矩阵 | 当前有哪些能力,哪些行为依赖平台或服务端 |
| 配置指南 | 如何选择 Profile、组织配置、校验与迁移 |
| Linux TUN auto_redirect | 本机 TCP REDIRECT + UDP TUN 的前置条件、安全边界和回滚 |
| 管理 API | 如何鉴权、查询状态和控制运行时 |
| 排错手册 | TUN、DNS、订阅、权限和连接失败如何定位 |
| 示例配置 | Desktop、Router、Android、Feed 与手动节点模板 |
| 文档 | 内容 |
|---|---|
| 架构说明 | workspace 边界、连接数据流与主要扩展点 |
| 组网后端基础设施 | 后端能力、系统资源仲裁、进程所有权与事务生命周期 |
| 内核设计文档 | 完整设计背景和实现细节 |
| 构建性能 | Cargo profile、缓存与编译性能 |
| 构建脚本 | 多平台构建方式和产物 |
| 发版指南 | Pre-release / Release 规则、标签、产物与校验 |
| 参与贡献 | 开发环境、提交要求和 Review 标准 |
| 项目治理 | 合并门禁、角色和紧急处置 |
| 路线图 | 1.0 前的工程重点和完成标准 |
- 命令默认从仓库根目录执行。
- 配置片段使用当前
version: 1格式。 - “已实现”表示仓库中存在可执行代码路径和测试,不表示与所有第三方服务端组合均已验证。
- 平台相关功能必须同时说明操作系统、权限、流量接管方式和回滚路径。
- 示例中的域名、订阅地址、密码、UUID 和密钥都是占位符,不应直接用于生产环境。
WutherCore · Releases · Issues · Discussions · MIT License