Files
order-notification-automation/docs/deployment.md
T

47 lines
5.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 部署与维护
## 安装启动
1. 准备常驻 Windows 机器、Node.js 22.13+(建议 24)及 Chrome,确认可访问新版 BPM、SSO 和公司邮箱。
2. 本轮更新源码位于本地工作区 `C:/Users/ABS/.codex/worktrees/modular-refactor/Order Notification Automation`,分支 `codex/modular-refactor` 尚未推送;使用此工作区进入项目执行 `npm ci`。新克隆目前无法取得该分支;需使用仓库中已发布的分支,并按对应版本说明安装。后续若此分支已发布,才可在克隆后切换到它。后续开发见 [交接说明](HANDOFF.md)。
3. 按需复制 `config.example.json` 为 `config.json`,调整监听端口、PDF 输出目录与代理设置。实际配置不提交 Git。
4. 执行 `npm start` 或双击 `启动工具.cmd`。浏览器访问 `http://127.0.0.1:18766/`,首次自行创建管理员,无默认密码。
5. 管理员创建团队账号,配置 BPM 连接及邮箱。账号密码在 Web 中录入,不写源码、命令行或文档。
`npm start` 通过独立守护后台启动,网页及启动窗口可以关闭;重复启动复用实例。业务进程退出或持续无响应时按退避/冷却恢复,不结束未知端口的占用进程。通过 `npm run service:status` 查看状态,`service:restart` 重启,`service:stop` 显式停止。
`npm run service:install` 安装当前 Windows 用户登录自启,移除用 `service:uninstall`。是否已启用以 `service:status` 为准;本轮保留原自启设置。登录后沿用该账号的 DPAPI 和 SMB 权限,不是未登录运行的系统服务。移动项目或更换 Node 路径后重新安装自启。健康面板 `/#health` 展示守护与历史模块状态,不触发外部检查。
## 多人访问与 HTTPS
Web 默认监听 `0.0.0.0:18766`,PDF 扩展桥接仅监听 `127.0.0.1:18765`。局域网访问需部署环境允许相应路由及防火墙。
敏感设置和远程 BPM 登录,部署机可用回环 HTTP;其他电脑使用 HTTPS。优先使用公司反向代理,参考 [Caddy 示例](../deploy/bpm-login.Caddyfile)。代理应在部署机回环连接后端,保留公开 Host,设置 `X-Forwarded-Proto: https`,并在实际配置启用 `dashboard.trustedProxy`。仅本机代理获得信任,不能把该配置当作允许任意远端伪造代理头。
上线需在另一台电脑验收登录、远程画面点击与中文输入、会话保存、权限及长时间运行。反向代理、证书和公司邮箱连通性依部署环境确认。
## 数据与备份
状态目录:`%LOCALAPPDATA%\OrderNotificationAutomation`,由实际运行账号决定。数据库清单见 [设计要求](design-requirements.md)。PDF 输出默认在项目 `output/pdf`,若需跨版本保存建议在 config.json 配置独立输出目录。
工作台账号、设置及 PDF 记录当前保存在 `dashboard/state.sqlite`,登录会话位于 `dashboard/auth.sqlite`。旧版 `dashboard/state.json` 首次导入后原样保留,仅作为迁移时快照,不再持续更新;备份与恢复以 SQLite 为准,不应直接回退使用旧 JSON。
备份先停止服务,再备份整个状态目录及业务输出目录;SQLite 的 WAL 文件与数据库必须保持一致。备份包含敏感数据,需限制访问及加密保存。密钥由 Windows DPAPI 绑定运行身份,单独复制 SQLite 或加密文件无法保证跨机器恢复;迁移前验证恢复条件,必要时重新登录及录入渠道凭据。
升级前备份,安装锁定依赖后再启动。Git 仓库不含运行数据库、凭据、Cookie、日志或业务输出,克隆源码不会同步这些数据,也不会恢复已有登录状态。演示启动脚本与免登录入口已移除,正式启动使用 `npm start`。
## 开发与发布检查
- `npm ci`:安装 package-lock.json 锁定版本。
- `npm test`:运行回归,包含真实本地浏览器与 SQLite/DPAPI 夹具,需要 Chrome 和可用 Windows 运行环境。
- 新提交先检查 `git status` 和暂存文件,禁止加入 config.json、extension/local-config.js、output、状态库及密钥。
- 使用 HTTPS 与 Git Credential Manager 访问私有仓库,不把密码或令牌写进远端 URL。
最新扫描验证范围及历史测试结果见 [扫描验证](bpm-scan-verification-2026-10-16.md) 和 [验证历史](verification.md)。
## 工作台密码维护
所有角色均可使用右上角“修改密码”入口,输入当前密码、新密码和确认密码。新密码需12–128位且与原密码不同。管理员在“团队账号”选择其他成员的“重置密码”,以管理员当前密码验证身份;管理员自己的密码使用个人入口修改。连续10次当前密码验证失败将限制15分钟。
成功改密会在同一次状态提交中保存加盐密码哈希、递增密码版本并记录审计,随后清理该账号的登录会话和临时BPM登录窗口。每次认证均核对会话密码版本,即使清理记录失败或服务重启,旧会话也不能继续使用。原会话表会自动补充版本字段,未改密的已有登录继续有效。操作记录与接口响应不含密码或密码哈希。