Skip to content

docs: 重写部署步骤,补齐本机常驻、私有服务器和升级卸载说明 - #40

Merged
lazyalex616 merged 2 commits into
allocnode:mainfrom
lazyalex616:docs/deploy-steps
Nov 2, 2026
Merged

lazyalex616 merged 2 commits into
allocnode:mainfrom
lazyalex616:docs/deploy-steps

Conversation

@lazyalex616

Copy link
Copy Markdown
Collaborator

README 的部署部分按「先选用法、再照步骤做」重新组织:

  • 快速开始新增「选一种用法」:按需启动 / 本机常驻 / 私有服务器 / 网页版四选一,每种写明适合谁、登录码怎么处理、去哪一节装。
  • 方式一的说明改为:已发布到 npm,不用下载仓库也不用自己编译,npx 自动运行最新版。
  • 本机常驻改成分步说明:全局安装 → 运行安装脚本 → 替换客户端配置 → 重启,并说明怎么用 /healthz 确认服务在运行。
  • 新增私有服务器(Docker)的分步说明:下载仓库、填 .env 三个必填项、启动、各电脑填地址和访问密码、只需登录一次。
  • 新增「升级与卸载」表格,覆盖三种部署方式;网页版补充更新方法,并说明网页版需要下载仓库(npm 上只有 MCP Server)。
  • 常见问题新增「AI Agent 里看不到 / 连接失败」和「连不上网关」。
  • 安装截图更新为 0.1.1 和新的 Windows 安装命令。

修复:deploy/install-local.ps1 原来是无 BOM 的 UTF-8,Windows 自带的 PowerShell 5.1 会按系统代码页读取,中文注释被读乱后整个脚本解析失败。改为带 BOM 的 UTF-8(PowerShell 5.1 和 7 都已验证解析通过),文档里的 Windows 命令也从 pwsh 改为系统自带的 powershell -ExecutionPolicy Bypass -File ...,不装 PowerShell 7 也能用,且只对这一次运行放开脚本限制。

deploy/README.md 同步:补充 npx 不带版本号会自动更新、Docker 部署先 git clone 和升级方法、Windows 命令说明。

@lazyalex616

Copy link
Copy Markdown
Collaborator Author

追加修改(第二个提交):

  • 用户相关的值一律改成占位符:让 AI Agent 帮装的提示词、MCP 配置、安装命令、.env 示例、连接网关的对话示例里,不再出现具体的网关 IP、服务器 IP、访问密码、API Key 和登录码,改为 http://<网关 IP>、<服务器 IP>、<访问密码>、<登录码>。只在说明文字里保留"例如 192.168.0.5"。给 AI Agent 的提示词里加了一句:遇到没替换的占位符先问用户,不要自己编。
  • 两个 .env.example 的必填项留空:原来的示例值(192.168.0.5、change-me-to-a-long-random-string、192.168.0.10,nas.local)复制后不改也能"启动成功",却连着别人的网络或用着公开的弱密码。现在留空,Docker 部署漏填访问密码或允许地址时 compose 直接报错拒绝启动。
  • Skill 安装改为 -g:实测 npx skills add 不加 -g 只装进当前文件夹,换个项目就读不到;加 -g 装到用户目录。给 AI Agent 的提示词改为 -g -y 并要求用 -a 只装给它自己(实测不指定时会一次装给本机全部检测到的 Agent)。
  • Skill 的升级和卸载:原来写"重新 add 一次",改为实测可用的 npx skills update mijia-automation -g 和 npx skills remove mijia-automation -g。
  • 私有服务器:补充需要 Git 和 Docker Compose、首次构建要几分钟、用 /healthz 验证、Bearer 后面的空格;deploy/README 补 OpenCode 的 HTTP 写法和 Docker 日志查看方法。
  • 网页版:补充 npm run build + npm start 的长期运行方式;表格里登录码说明改准确(网页服务每次启动后输一次)。
  • 徽章:用 npm 版本徽章替换 Next.js 徽章。
  • AGENTS.md:文档分工按现状更新,并写明"可复制内容里不得出现具体的用户值"这条规则。

@lazyalex616
lazyalex616 merged commit 8c50ed3 into allocnode:main Nov 2, 2026
11 checks passed
@lazyalex616
lazyalex616 deleted the docs/deploy-steps branch November 2, 2026 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant