docs: document Sense package environment loading (#46)

2026-08-13 10:38:26 +08:00
parent 5a178986e5
commit 6bbaa07962
3 changed files with 11 additions and 11 deletions
@@ -2,8 +2,8 @@
 generated: true (请先修改 Gitea Wiki，禁止直接编辑本文件)
 wiki_page: Local-Development-and-Verification
 wiki_url: https://git.ilapage.cn/ila/yovision/wiki/Local-Development-and-Verification.-
-wiki_revision: 3bf0987ec9d7ddf543602e465faa088aead46531
-synchronized_at: 2026-08-12T10:22:02Z
+wiki_revision: 4f3e1f218d29e17a3f8fabd43316d1a562c69d07
+synchronized_at: 2026-08-13T02:35:03Z
 <!-- gitea-wiki-mirror:end -->

 # 本地开发与验证
@@ -167,7 +167,7 @@ cmd /c .\Sense\scripts\package-windows.bat
 Get-FileHash .\Sense\dist\sense-windows-amd64.zip -Algorithm SHA256
 ```

-脚本精确校验 Node 22.22.1 和 pnpm 9.15.1，冻结安装并构建前端，以 Windows amd64/CGO 关闭方式编译后端，然后生成被 Git 忽略的 `Sense\dist\sense-windows-amd64\` 和 ZIP。可重复运行只会覆盖这两个固定产物。
+脚本精确校验 Node 22.22.1 和 pnpm 9.15.1，冻结安装并构建前端，以 Windows amd64/CGO 关闭方式编译后端，然后生成被 Git 忽略的 `Sense\dist\sense-windows-amd64\` 和 ZIP。同一运行目录重新打包时会保留已有 `config\sense.env`，但该文件不会进入 ZIP。

-解压后运行 `start-sense.bat demo` 可做内存模式临时预览；生产运行 `start-sense.bat` 前必须从仓库和运行包外注入 PostgreSQL URL、签名密钥、引导令牌和摄像头凭据加密密钥。包内不含 PostgreSQL、MediaMTX、系统服务、客户数据或秘密。
+解压后运行 `start-sense.bat demo` 可做内存模式临时预览。生产配置可写入运行目录的 `config\sense.env`，也可通过 Windows 进程环境注入；非空进程环境变量优先，启动器只读取 `SENSE_*` 键且不打印配置值。运行 `start-sense.bat check` 可在不连接数据库、不启动服务的情况下检查必填配置，然后用 `start-sense.bat` 启动生产模式。包内不含 PostgreSQL、MediaMTX、系统服务、客户数据或秘密，真实 `sense.env` 不得提交或重新打入交付 ZIP。
 <!-- sense-windows-package:end -->
@@ -2,8 +2,8 @@
 generated: true (请先修改 Gitea Wiki，禁止直接编辑本文件)
 wiki_page: Troubleshooting
 wiki_url: https://git.ilapage.cn/ila/yovision/wiki/Troubleshooting
-wiki_revision: b8e778ae4255ba3fc36a1cd6bcb735e29bd19eee
-synchronized_at: 2026-08-13T01:26:22Z
+wiki_revision: 84d5d336475613d77030a7c722ea9c4d18b307fe
+synchronized_at: 2026-08-13T02:35:08Z
 <!-- gitea-wiki-mirror:end -->

 # 故障排查
@@ -66,7 +66,7 @@ synchronized_at: 2026-08-13T01:26:22Z
 | 现象 | 检查与处理 |
 |---|---|
 | 打包提示 Go/Node/pnpm 版本不符 | 对照根 `goadmin-baseline.json` 安装精确版本，并把 Go 1.26.5 放到 `PATH` 首位；不要修改脚本绕过版本检查。 |
-| 生产启动提示缺少环境变量 | 在运行包外设置 `SENSE_DATABASE_URL`、`SENSE_IDENTITY_SIGNING_KEY`、`SENSE_BOOTSTRAP_TOKEN`、`SENSE_CREDENTIAL_KEY`；启动脚本不会读取示例文件。 |
+| 生产启动提示缺少环境变量 | 确认运行目录中存在 `config\sense.env`（不是只保留 `sense.env.example`），并填写 `SENSE_DATABASE_URL`、`SENSE_IDENTITY_SIGNING_KEY`、`SENSE_BOOTSTRAP_TOKEN`、`SENSE_CREDENTIAL_KEY`；也可在进程环境中设置，非空进程环境变量优先。运行 `start-sense.bat check` 定位缺失的变量名，脚本不会打印变量值。 |
 | 本机健康检查被代理返回空响应 | localhost 可能被 `HTTP_PROXY` 接管；测试工具应对 `127.0.0.1` 使用 no-proxy，再检查 `SENSE_HTTP_ADDRESS` 端口占用。 |
 | 页面可打开但视频不可用 | Windows 运行包不包含 MediaMTX；按包内说明配置独立 MediaMTX 二进制、配置和 Control API。 |

@@ -2,8 +2,8 @@
 generated: true (请先修改 Gitea Wiki，禁止直接编辑本文件)
 wiki_page: Delivery-Documentation-Guide
 wiki_url: https://git.ilapage.cn/ila/yovision/wiki/Delivery-Documentation-Guide.-
-wiki_revision: 04d9a7f0916262c3578e7934a2e98327dae55c7a
-synchronized_at: 2026-08-13T01:15:15Z
+wiki_revision: d4f2bfcef46493361ba019839b36957ed9947003
+synchronized_at: 2026-08-13T02:35:26Z
 <!-- gitea-wiki-mirror:end -->

 # 交付文档指南
@@ -98,7 +98,7 @@ Sense 面向网管、实施人员和非技术现场人员，菜单按日常任
 交付对象为实施和运维人员。`sense-windows-amd64.zip` 包含后端程序、已构建前端、空值示例配置、上游许可证、启动脚本与包内说明；不包含 PostgreSQL、MediaMTX、Windows 服务、生产数据或秘密。

 - 临时查看必须显式运行 `start-sense.bat demo`，其内存数据在进程结束后丢失，不能当作生产部署。
- 生产启动前由运维在运行包外安全注入数据库、身份签名、初始化令牌和凭据加密配置，再运行 `start-sense.bat`。
+- 生产配置可由运维写入解压目录的 `config\sense.env`，或通过 Windows 进程环境安全注入；进程环境优先。先运行 `start-sense.bat check` 检查必填项，再运行 `start-sense.bat`。
 - 交付时记录 ZIP SHA-256，并至少验证 `/healthz` 与首页；真实 PostgreSQL、MediaMTX、摄像机和目标浏览器仍需在获准环境验收。
- 包内 `README-WINDOWS.md` 是现场操作入口；不得把真实连接串、密码或令牌回填进示例文件后重新分发。
+- 包内 `README-WINDOWS.md` 是现场操作入口；真实 `config\sense.env` 只留在具体部署目录，不得提交 Git 或重新打入交付 ZIP，交付 ZIP 只保留 `sense.env.example`。
 <!-- sense-windows-package:end -->