dsh-foreman-node 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,7 +1,68 @@
-# Changelog
+## 0.2.0 — 2026-11-07
 
-本包是 [`dsh-foreman`](https://www.npmjs.com/package/dsh-foreman) 的设备侧，单独发版，
-但**协议与 hub 版本绑定**：两侧协议版本不一致时，握手就拒绝并给出可读原因。
+### 新增：配置页，设备绑定不用再碰命令行
+
+以前绑定一台设备要动四样东西，全是手写：在服务器上跑注册脚本拿 token、改服务器的
+`cordis.patch.yml`、改设备自己的 `cordis.patch.yml`、再手动开一条
+`ssh -L 8790:127.0.0.1:8790` 隧道。最后那一步最要命——插件连不上时只表现为「离线」，
+真正的原因是一条没人开的隧道。
+
+现在这条隧道由设备自己开，配置也由设备自己的页面填：
+
+- **「设置 › 插件 › dsh-foreman-node」多了一个配置页**：从这台机器 `~/.ssh` 里
+  **列出密钥让你挑**、填主机/用户/端口、点「测试连接」看认证通不通、填项目路径，
+  保存后重启 DSH 生效。
+- **隧道由插件自己拉起**：`ssh -N -L`，断了按 1s→60s 退避重连。就绪判定是
+  TCP 连本机端口，不看 ssh 的措辞。
+- **两种失败会翻译成人话**：钥匙有口令（`Permission denied (publickey)`）会说
+  「请改用 ssh-agent 或换一把无口令的钥匙」；本地端口被占会说
+  「local port 8790 已经有人占了」，而不是把 ssh 原文丢给你。
+- **配置页在没有配置时也能打开**：路由注册排在「缺配置就返回」之前。否则新装的
+  设备打不开配置页，等于装完就卡死。
+- **没有 Web 界面的 DSH 照常接单**：`webServer` 是可选注入，不是硬依赖。headless
+  或 CLI 里的设备只是没有配置页，干活不受影响。
+
+### 新增配置
+
+`ssh` 一整块，全部有默认值，所以**旧的手写配置不会因为缺这一块而变 invalid**：
+
+```yaml
+ssh:
+  enabled: false
+  host: ''
+  port: 22
+  user: ''
+  keyPath: ''
+  remotePort: 8790
+  localPort: 8790
+```
+
+`enabled: true` 时，`url` **不再参与连接**：设备拨的是 `ws://127.0.0.1:<localPort>`，
+也就是隧道自己那一头。页面会把地址置灰并显示真正会用的那个。
+
+### 不支持
+
+- 密码登录：Windows 没有 `sshpass`，而且自动重连的前提是 `BatchMode=yes`。
+- 带口令的私钥：请放进 ssh-agent。
+
+## 0.1.1 — 2026-11-07
+
+### 修复：装上去就把整个 profile 弄成「异常」
+
+设备包一进 profile 的 `bundles`，它的 patch 就会插入 `dsh-foreman-node` 这一行，
+而这一行**还没有任何 config**——`0.1.0` 的 schema 把 `url` / `deviceId` / `token` 都写成 `.required()`，
+于是激活直接失败：
+
+```
+invalid config:
+  - $.url missing required value (at url)
+```
+
+整个 profile 因此显示为异常，而不是「这个设备还没配好」。
+
+现在这三项都有空字符串默认值，`apply` 在缺值时**干净地不激活**，只记一行说明缺哪几项、
+去哪儿填，profile 保持健康。值填齐后才开始拨号。
+只有空白的值也算缺——否则设备会一直拨一个空地址，看起来只是离线。
 
 ## 0.1.0 — 2026-11-07
 

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 DeepSeek Harness Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 DeepSeek Harness Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -25,6 +25,35 @@
      └───────────────────────────────┘
 ```
 
+## 配置
+
+装进 profile 后会多出「设置 › 插件 › dsh-foreman-node」一个配置页：从这台机器的 `~/.ssh` 里
+挑一把密钥、填枢纽机器与用户、点「测试连接」、把枢纽上登记设备时给出的 `deviceId` 和 `token` 填进来，
+再填项目名到本机路径的对应关系。保存后重启 DSH 生效。
+
+隧道由插件自己拉起（`ssh -N -L`，断了自动重连），不需要再手开 `ssh -L`。
+
+也可以直接写 profile 的 `cordis.patch.yml`：
+
+```yaml
+- id: dsh-foreman-node
+  config:
+    url: wss://foreman.example.com   # 隧道开着时不参与连接
+    deviceId: laptop
+    token: <枢纽登记设备时给出的令牌>
+    roots:
+      - project: shop
+        path: 'D:\工作\shop'
+    ssh:
+      enabled: true
+      host: 203.0.113.10
+      port: 22
+      user: ubuntu
+      keyPath: /home/me/.ssh/id_ed25519
+```
+
+不支持密码登录（自动重连的前提是 `BatchMode=yes`），也不支持带口令的私钥——请放进 ssh-agent。
+
 ## 状态
 
 **早期开发中。** 协议、连接、接单与回报工具都已落地并有测试（14 项）。