# OpenClaw Deploy

**Repository Path**: csbcsb/openclaw-deployment

## Basic Information

- **Project Name**: OpenClaw Deploy
- **Description**: OpenClaw Deploy是一个专注于自动化部署的开源项目，提供简洁高效的部署工具，支持多种环境和应用，旨在简化开发者的部署流程。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 24
- **Forks**: 8
- **Created**: 2026-03-08
- **Last Updated**: 2026-03-23

## Categories & Tags

**Categories**: lamp

**Tags**: None

## README

# OpenClaw Deploy

一个给普通用户用的 **OpenClaw 安装 / 配置 / 修复 / 验收工具包**。

支持：
- macOS
- Linux
- WSL
- Windows PowerShell

适合：
- 第一次部署 OpenClaw 的用户
- 想把 OpenClaw 交付给普通用户的人
- 不想手动改一堆配置文件的人

---

## 快速开始

### macOS / Linux / WSL

```bash
chmod +x install.sh tests/test.sh
./install.sh
```

### Windows PowerShell

**最简单：双击 `run.bat`**

或者命令行：

```powershell
powershell -ExecutionPolicy Bypass -File .\install.ps1
```

如果本机执行策略比较严格，也可以先执行：

```powershell
Set-ExecutionPolicy -Scope Process Bypass
.\install.ps1
```

---

## 你只需要按这 5 步走

### 1. 一键安装
先在主菜单选：

- `1. 一键安装`

### 2. 配置 AI Provider
然后选：

- `2. 配置 AI Provider`

可以添加多个 Provider，设置默认模型，并做连通性测试。

### 3. 配置消息渠道
再选：

- `3. 配置消息渠道`

脚本内置配置向导支持：
- Telegram
- Discord
- 飞书 / Lark

OpenClaw 官方支持 20+ 渠道（含 WhatsApp、Signal、Slack、iMessage、Matrix、Mattermost、LINE 等），其他渠道可通过 `openclaw plugins install` 安装对应插件后手动配置。

### 4. 启动并配对
去：

- `4. 服务 / 配对管理`

你可以：
- 启动 Gateway
- 查看日志
- 审批配对码（子菜单 `8. 配对管理`）

### 5. 确认运行状态
最后跑：

- `7. 运行状态`

---

## 主菜单一眼看懂

### 1. 一键安装
第一次部署时用。

### 2. 配置 AI Provider
管理模型服务商：
- 添加
- 查看
- 删除
- 设置默认模型
- 测试连通性

### 3. 配置消息渠道
管理：
- Telegram
- Discord
- 飞书 / Lark

支持新增、查看、删除。

### 4. 服务 / 配对管理
管理：
- 启动 / 停止 / 重启 Gateway
- 查看状态
- 查看日志
- 启用 / 禁用开机自启
- 审批配对码

### 5. 更新 OpenClaw
更新到最新版本。

### 6. 系统诊断
适合排查问题。

会帮你做：
- 状态检查
- 深度诊断（`openclaw doctor`）
- 常见错误翻译
- 分渠道健康检查
- 联通性检查

### 7. 运行状态
查看：
- OpenClaw 是否安装
- Node.js 是否存在
- 配置文件是否存在
- Gateway 端口是否监听
- Provider 是否已配置
- 渠道是否已启用

### 8. 一键修复
适合遇到这些情况时使用：
- `openclaw` 命令不可用
- Gateway 起不来
- 端口不监听
- 飞书插件异常
- PATH / 配置 / 服务注册有问题

会先调用 `openclaw doctor --repair` 运行官方修复，再执行项目内修复逻辑。

### 9. 卸载 OpenClaw
完全卸载 OpenClaw。

---

## 最常见的使用场景

### 我只是想先跑起来
按这个顺序走：

1. 一键安装
2. 配置 AI Provider
3. 配置消息渠道
4. 启动 Gateway
5. 审批配对码
6. 查看运行状态（菜单 7）

### 我已经装了，但不工作
优先试：

1. `7. 运行状态`
2. `6. 系统诊断`
3. `8. 一键修复`

### 我想把它交付给别人用
建议你至少让对方完成：

1. 安装
2. Provider 配置
3. 渠道配置
4. 配对成功
5. 运行状态正常（菜单 7）

---

## 飞书用户必看

飞书最容易卡在平台配置。

请确认：

- 已创建飞书应用
- 已开启**机器人能力**
- 已开启 **WebSocket / 长连接事件订阅**
- 已添加事件：`im.message.receive_v1`
- 应用已发布
- 本地 Gateway 已启动
- 飞书插件没有报错
- 已收到并审批配对码

如果飞书不通，优先跑：

- `6. 系统诊断`
- `8. 一键修复`

---

## 常见问题

### 安装完后 `openclaw` 命令不能用
去跑：
- `8. 一键修复`

或手动执行：
```bash
npm install -g openclaw@latest
```

### Gateway 显示 running，但端口没监听
去看：
- `7. 运行状态`
- `6. 系统诊断`

也可直接跑官方诊断：
```bash
openclaw doctor
```

### 飞书机器人没反应
优先检查：
- 飞书应用是否发布
- 是否已开启机器人能力
- 是否已开启长连接事件订阅
- 是否已安装并加载飞书插件
- 是否已经审批配对码

### Windows PowerShell 报参数错误 / JSON 相关错误
请先拉最新版本。

项目已经专门兼容：
- Windows PowerShell 5.1

---

## 反馈问题 / 提 Issue

这是一个开源项目，欢迎提 Issue。

### 可以反馈什么

- Bug / 报错
- 安装失败
- 渠道接入问题
- 文档问题
- 功能建议

### 提 Issue 前，建议先做

先在脚本里跑：

- `6. 系统诊断`
- `7. 运行状态`
- `8. 一键修复`

### 提 Issue 时建议附带

- 操作系统
- 使用的是 `install.sh` 还是 `install.ps1`
- OpenClaw 版本（`openclaw --version`）
- 报错全文
- 报错截图
- 最近日志
- 运行状态输出
- 诊断输出（`openclaw doctor`）

### 如果是渠道问题
请说明你用的是：
- Telegram
- Discord
- 飞书 / Lark
- 其他渠道

### 如果是飞书问题
最好补充：
- 是否开启机器人能力
- 是否开启 WebSocket / 长连接事件订阅
- 是否添加 `im.message.receive_v1`
- 是否发布应用
- 是否审批配对码

---

## 配置文件位置

默认在当前用户目录下：

```text
~/.openclaw/openclaw.json
~/.openclaw/secrets.json
~/.openclaw/logs/gateway.out.log
~/.openclaw/deploy.log
```

简单理解：
- `openclaw.json`：公开配置（JSON 格式）
- `secrets.json`：敏感凭据（JSON 格式）
- `gateway.out.log`：运行日志
- `deploy.log`：安装器日志

---

## 推荐中转站（国内用户）

如果你直连官方接口不稳定，可以考虑用 **虎三 AI（HusanAI）**：

- 注册地址：<https://husanai.com/register?aff=CYpx>
- 常见 Base URL：`https://husanai.com/v1`

拿到 API Key 后，在"配置 AI Provider"菜单里填进去即可。

---

## 依赖要求

### Windows
- Windows PowerShell 5.1+
- Node.js 22+
- npm
- `winget` / `choco` / `nvm-windows`（可选）

### macOS / Linux / WSL
- Bash
- Node.js 22+
- npm
- Python 3

---

## 测试

```bash
./tests/test.sh
```

用于基础冒烟检查，例如：
- 文件是否存在
- Bash 语法是否正常
- 关键结构是否存在
- 已修复问题是否回归

---

## 适合谁

适合：
- 想快速部署 OpenClaw 的用户
- 想把 OpenClaw 交付给普通用户的人
- 想要"安装 + 修复 + 验收"一体化流程的人

不太适合：
- 严格离线部署场景
- 极度复杂的企业级批量部署
- 有特殊代理 / 系统策略限制的环境

---

## 后续可以继续做什么

如果你准备继续扩展这个项目，比较自然的方向有：

1. 增加静默安装模式
2. 增加导出排障报告
3. 增加配置回滚 / 恢复
4. 增加更完整的跨平台自动测试