Bläddra i källkod

Add deployment preflight and OpenClaw deploy message docs

zhaozhi 2 veckor sedan
förälder
incheckning
e87c1c017e
2 ändrade filer med 113 tillägg och 0 borttagningar
  1. 81 0
      docs/deployment-preflight-checklist.md
  2. 32 0
      docs/openclaw-deploy-message.md

+ 81 - 0
docs/deployment-preflight-checklist.md

@@ -0,0 +1,81 @@
+# 部署前总验收清单
+
+这份清单用于在把网站正式交给 OpenClaw / ops 部署到局域网 MacBook 之前,做最后一轮上线前确认。
+
+## 1. 代码与构建
+
+1. Git 仓库可访问。
+2. `npm install` 可以成功完成。
+3. `npm run build` 成功通过。
+4. `npm run start -- --hostname 0.0.0.0 --port 3000` 可以正常启动。
+
+## 2. 页面访问
+
+至少确认下面页面都可正常打开:
+
+1. `/`
+2. `/chat`
+3. `/library`
+4. `/reader/lan-archive`
+5. `/agents`
+
+## 3. 聊天室
+
+1. 文字消息可以发送。
+2. 图片可以上传、发送、查看。
+3. 文件可以上传、显示、点击下载 / 打开。
+4. 清空聊天记录功能可用,并会写入系统清理消息。
+5. 服务重启后,聊天记录仍然保留。
+6. 当前在线设备数会根据真实在线状态变化。
+7. PC 端消息区可滚动,输入区固定。
+8. 手机端消息区可滚动,输入区固定。
+
+## 4. 小说阅读
+
+1. 书架页可以进入阅读页。
+2. 目录可打开。
+3. 上一章 / 下一章切换正常。
+4. 字号 / 主题 / 版心切换正常。
+5. 桌面端版心切换时,左右悬浮按钮会跟随正文一起移动。
+6. 手机端顶部和底部操作区正常。
+
+## 5. Agent 页面
+
+1. `/agents` 可以返回数据。
+2. 没有真实数据时,会回退到 demo 数据。
+3. 有真实数据文件时,会优先显示真实数据。
+4. PC 端总览页一行显示 4 个 agent 卡片。
+5. agent 详情页可打开。
+
+## 6. 本地存储
+
+下面目录 / 文件应存在并可写:
+
+1. `storage/chat.sqlite`
+2. `storage/chat-uploads/`
+3. `storage/agents/openclaw-agents.json`
+
+## 7. 缓存与局域网访问
+
+1. 页面 HTML 返回 `Cache-Control: no-store, no-cache, must-revalidate, proxy-revalidate`
+2. 局域网内其他设备可以通过 `http://MacBook局域网IP:3000` 访问
+3. 若出现旧页面 / 无样式页面,先关闭旧标签页,再重新打开新标签页验证
+
+## 8. 开机自启
+
+1. `com.lan-reader-chat.web.plist` 已安装
+2. `com.lan-reader-chat.agentfeed.plist` 已安装
+3. 开机后服务自动启动
+4. OpenClaw agent feed 定时同步可执行
+
+## 9. 运维交接
+
+交给 OpenClaw 时至少附带:
+
+1. Git 仓库地址
+2. `docs/macbook-deployment.md`
+3. `docs/openclaw-ops-runbook.md`
+4. `docs/openclaw-agent-feed.md`
+5. `docs/openclaw-agent-feed.example.json`
+6. `docs/openclaw-handoff.md`
+

+ 32 - 0
docs/openclaw-deploy-message.md

@@ -0,0 +1,32 @@
+# 发给 OpenClaw 的最终执行消息
+
+你可以把下面这段直接发给 OpenClaw:
+
+```text
+请接管这个局域网网站的部署与日常运维。
+
+项目仓库:
+http://git.uxianqi.com/wszz0218/lan-reader-chat.git
+
+部署目标:
+- 部署到一台局域网内的 MacBook
+- 给公司内网用户访问
+- 默认端口 3000
+- 你作为 ops 运维专员负责后续维护
+
+请按以下顺序执行:
+1. 克隆仓库并阅读 docs/macbook-deployment.md
+2. 阅读 docs/openclaw-ops-runbook.md,按其中的 ops 职责接管运维
+3. 配置 launchd 开机自启
+4. 配置 OpenClaw agent 状态 JSON 同步
+5. 验证首页、聊天室、书架、阅读页、Agent 观察页都可访问
+6. 验证聊天室可发送文字、图片、文件,且服务重启后消息仍保留
+7. 验证 /agents 优先读取真实 JSON 数据源,而不是 demo 数据
+8. 按 docs/deployment-preflight-checklist.md 完成部署前总验收
+
+补充说明:
+- 聊天消息使用 SQLite 持久化
+- 上传文件保存在本地 storage/chat-uploads/
+- Agent 页面优先读取 storage/agents/openclaw-agents.json
+- 如页面看起来像旧版本或无样式,请关闭旧标签页后重新打开,再检查页面缓存头是否为 no-store
+```