ChatbotX

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Docker 与 Docker Compose 环境（README 推荐的自托管方式）
• 能拉取 ghcr.io 预构建镜像的网络环境
• Node.js 与 pnpm（仅在从源码运行 monorepo 时需要）
• 各渠道（WhatsApp、Telegram、Email 等）的官方开发者凭据，用于接入消息渠道

安装与启动步骤

1. 1克隆自托管仓库

   README 推荐非开发用户使用独立仓库 chatbotx-docker-compose，里面用预构建的 ghcr.io 镜像。

   git clone https://github.com/ChatbotXIO/chatbotx-docker-compose.git

   复制

2. 2进入仓库目录

   后续 docker compose 命令都在该目录下执行，先确认目录中的 compose 文件与环境变量示例。

   cd chatbotx-docker-compose

   复制

3. 3按示例填写配置

   README 未列出具体变量名与端口，请对照仓库内的 env 示例文件和官网文档逐项填写后再启动。

4. 4启动容器

   使用 docker compose 拉起预构建镜像；首次执行会自动拉取镜像，耗时取决于网络。

   docker compose up -d

   复制

5. 5确认访问地址

   查看 compose 输出的端口映射，在浏览器打开对应地址进入 ChatbotX 控制台。

   docker compose ps

   复制

6. 6源码方式克隆主仓库

   如需二次开发，克隆主 monorepo，README 说明应用通过 pnpm dev 从源码运行。

   git clone https://github.com/ChatbotXIO/ChatbotX.git

   复制

7. 7安装依赖并启动

   在主仓库目录安装依赖后运行 pnpm dev；本地基础设施由仓库内 compose 文件提供。

   pnpm install
   pnpm dev

   复制

如何确认成功

执行 docker compose ps 看到服务为 running，且浏览器打开端口映射的地址能显示 ChatbotX 控制台页面。

常见问题

注意事项

• README 只提供了文档链接与 docker compose / pnpm dev 两种运行方式，未给出具体端口、环境变量和服务清单。
• 主仓库的 compose 文件仅用于提供本地依赖服务，不要误当作完整应用部署文件。
• 多渠道接入需要在各平台侧完成开发者应用创建与授权，README 未展开这部分步骤。