im0o/mihomo-patchbay
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

README 精简

Browse Source 
修正验证脚本的数量说法（是三个不是两个），改成指向文件头的用法说明，
以后加脚本不再过时。删掉指向仓库外 docs/adr 的引用：克隆者拿到的是
断链，工作区内有 AGENTS.md 指路。开发一节只留命令和「访问 5173 不是
7580」这个坑。
This commit is contained in:
im0o
2026-08-12 13:43:39 +08:00
parent 57690a159c
commit 9c302b2a33
1 changed files with 11 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -24
View File
@@ -2,11 +2,9 @@
一个跑在服务器上的网页，用来编辑那台机器上 mihomo 的 `config.yaml` 并让改动生效。 一个跑在服务器上的网页，用来编辑那台机器上 mihomo 的 `config.yaml` 并让改动生效。
核心动作是把某一路入站接到某一个出站上——名字取自录音棚的插线板。典型用途是给每个容器开一个端口，各自指定走哪条线路。 核心动作是把某一路入站接到某一个出站上，名字取自录音棚的插线板。典型用途是给每个容器开一个端口，各自指定走哪条线路。
聚合订阅不在范围内（那是 Sub-Store 的活），安装升级内核也不在（那是 `mihomo-up.sh` 的活）。 聚合订阅不在范围内（那是 Sub-Store 的活），安装升级内核也不在（那是 `mihomo-up.sh` 的活）。术语以 [CONTEXT.md](./CONTEXT.md) 为准。
术语以 [CONTEXT.md](./CONTEXT.md) 为准。为什么这么设计记在仓库外面的 `docs/adr/`。
## 跑起来 ## 跑起来
@@ -18,31 +16,18 @@ cp .env.example .env # 按里面的注释填
bun run start # 打包前端并启动，默认 http://127.0.0.1:7580 bun run start # 打包前端并启动，默认 http://127.0.0.1:7580
``` ```
首次启动会生成一个访问令牌，打印在控制台上，同时存到配置文件旁边的 `.patchbay-token`。 首次启动会生成访问令牌，打印在控制台上，也存在配置文件旁边的 `.patchbay-token`。
**内核不在线也能用**，只是看不到订阅里有哪些线路、也没法让改动立刻生效。这是有意的——配置写坏导致内核起不来的时候，正是最需要这个界面的时候。 内核不在线也能用，只是看不到订阅里有哪些线路，改动也要等内核启动才生效。这是有意的：配置写坏导致内核起不来的时候，正是最需要这个界面的时候。
## 开发 ## 开发
改代码的时候用这个，前后端都不用重启：
```bash ```bash
bun run dev:kernel # 终端 1：本地测试内核，开着不用管 bun run dev:kernel # 终端 1：本地测试内核，开着不用管
bun run dev:all # 终端 2：后端 + 前端，改了自动生效 bun run dev:all # 终端 2：后端 + 前端，改了自动生效
``` ```
然后访问 **http://localhost:5173**（不是 7580）。后端代码改动由 Bun 的 `--hot` 重载， 然后访问 http://localhost:5173（不是 7580）。第一次先运行 `bun run dev:reset` 生成测试配置：模板在 `dev/config.yaml`，订阅地址从 `.env` 取。
界面改动由 Vite 直接更新浏览器。
`bun run start` 不具备这个能力——它把前端打成静态文件再由后端提供，代码一改就得重新
打包重启。那种方式适合最终验证和部署。
本地测试内核的配置由模板生成（`dev/config.yaml` 进 git，订阅地址从 `.env` 取，
生成的 `dev/home/config.yaml` 不进 git）：
```bash
bun run dev:reset # 第一次，或想把测试配置恢复成模板时
```
## 检查 ## 检查
@@ -52,15 +37,15 @@ bun run smoke # 接口冒烟测试，需要内核和后端都在跑
bun run typecheck bun run typecheck
``` ```
另有两个一次性脚本：`scripts/roundtrip.ts` 验证改一处配置之后 diff 里只出现那一处，`scripts/safety-net.ts` 验证配置写坏时能不能把用户救回来。 `scripts/` 里另有几个手动验证脚本（写回保真、落盘保护链路、链式代理的生成产物），用法写在各文件头部。
## 目录 ## 目录
``` ```
server/ 后端。config-store.ts 是核心，那条保护链路在里面 server/ 后端。config-store.ts 是核心，落盘保护链路在里面
web/ 前端。styles/tokens.css 顶部写着设计基调的三条规则 web/ 前端。styles/tokens.css 顶部写着设计基调
shared/ 两边共用的领域逻辑，纯函数，带测试 shared/ 两边共用的领域逻辑，纯函数，带测试
vendor/ 从别的项目复制来的代码，来源和本地改动记在各自的 ORIGIN.md vendor/ 从别的项目复制来的代码，来源和本地改动记在各自的 ORIGIN.md
scripts/ 验证用的脚本，不参与打包 scripts/ 验证脚本，不参与打包
dev/ 本地测试内核的配置 dev/ 本地测试内核的配置
``` ```