Skip to main content
ClaudeWave
Skill29.5k repo starsupdated 3d ago

fastgpt-docker-deploy

FastGPT Docker Compose self-hosting deployment workflow. Use when a user asks an AI agent to deploy FastGPT with Docker by referencing /deploy/SKILL.md, including creating an empty fastgpt directory, running the install script in non-interactive mode, starting Docker Compose, monitoring service health, troubleshooting compose issues, and returning the access URL plus root credentials and next steps.

Install in Claude Code
Copy
git clone --depth 1 https://github.com/labring/FastGPT /tmp/fastgpt-docker-deploy && cp -r /tmp/fastgpt-docker-deploy/document/public/deploy ~/.claude/skills/fastgpt-docker-deploy
Then start a new Claude Code session; the skill loads automatically.

SKILL.md

# FastGPT Docker 部署

## 目标

在一台已有终端访问权限的 Linux、macOS 或 Windows WSL 服务器上,通过 FastGPT 官方交互式脚本生成 Docker Compose 配置,启动服务,确认 FastGPT 可访问,最后把访问地址、账号、密码和下一步动作交给用户。

## 工作边界

- 优先使用官方脚本:`https://doc.fastgpt.cn/deploy/install.sh`。
- 默认使用脚本非交互模式:国内镜像源、自动随机密钥、检测到的第一个主 IP、`PostgreSQL + pgvector` 向量库。
- 不要覆盖用户已有的 `docker-compose.yml` 或数据卷,除非用户明确同意。
- 不要在公开输出里泄露除 `root` 初始登录密码外的服务 Token、数据库密码或应用密钥。
- 如果宿主机已有反向代理、域名或云厂商防火墙,先完成本机部署验证,再提醒用户开放或映射 `3000`、`3003`。仅旧版外部 S3 下载链路还需要开放 `9000`。

## 部署流程

1. 检查运行环境:

   ```bash
   docker -v
   docker compose version
   curl --version
   ```

   如果 Docker 或 Compose 不存在,先向用户说明缺失项。只有在用户授权安装系统软件时,才安装 Docker。

2. 创建空的 `fastgpt` 部署目录:

   ```bash
   mkdir -p ~/fastgpt
   cd ~/fastgpt
   if [ -n "$(ls -A .)" ]; then
     echo "当前目录非空,请先确认是否继续或改用新的空目录。"
     exit 1
   fi
   ```

   如果目录非空,先读取文件和 `docker compose ps` 判断是否已有部署,不要直接覆盖。让用户确认继续使用当前目录、备份旧文件,或改用新的空目录。

3. 下载并运行官方脚本:

   ```bash
   curl -fsSL https://doc.fastgpt.cn/deploy/install.sh -o install.sh
   FASTGPT_NON_INTERACTIVE=true bash install.sh
   ```

   非交互模式会默认选择最新稳定版本、国内镜像源、`PostgreSQL + pgvector`、自动随机密钥,并把 MCP 地址设置为检测到的第一个主 IP。当前版本的默认 `short-proxy` 下载模式不需要配置外部 S3 地址。

   如果用户明确给了 MCP 公网域名或固定 IP,用环境变量覆盖 endpoint:

   ```bash
   FASTGPT_NON_INTERACTIVE=true \
   FASTGPT_MCP_ENDPOINT=https://mcp.example.com:3003 \
   bash install.sh
   ```

   `FASTGPT_S3_ENDPOINT` 仅用于仍包含 `STORAGE_EXTERNAL_ENDPOINT` 的 v4.14 或本地旧版 Compose。

   可选覆盖项:
   - `FASTGPT_DEPLOY_VERSION`:部署版本,例如 `v4.15` 或 `main`。
   - `FASTGPT_REGION`:镜像源,`cn` 或 `global`。
   - `FASTGPT_VECTOR`:向量库,`pg`、`milvus`、`zilliz`、`oceanbase` 或 `seekdb`。
   - `FASTGPT_AUTO_GENERATE_CREDENTIALS`:是否自动随机密钥,默认 `true`。
   - `FASTGPT_LOCAL_COMPOSE_PATH`:使用本地 `docker-compose.yml`。

   记录脚本最终输出中的 `root` 登录密码和提示的访问地址。

4. 启动服务:

   ```bash
   docker compose up -d
   ```

   如果脚本提示需要先预热 OpenSandbox 镜像,先执行脚本输出的 `docker compose --profile prepull pull ...` 命令,再启动服务。

5. 监听运行状态:

   ```bash
   docker compose ps
   docker compose logs --tail=120 fastgpt-app
   ```

   等待核心服务变为 running 或 healthy。重点检查:
   - `fastgpt-app`
   - `fastgpt-mongo`
   - `fastgpt-redis`
   - `fastgpt-vector`
   - `fastgpt-minio`
   - `fastgpt-plugin`
   - `fastgpt-aiproxy`

6. 验证访问:

   ```bash
   curl -I http://localhost:3000
   ```

   如果用户提供了公网 IP 或域名,也验证对应地址。浏览器访问地址通常是 `http://<服务器地址>:3000`。

## 常见问题处理

- 端口冲突:用 `docker compose ps` 和 `docker compose logs` 确认冲突端口,修改 `docker-compose.yml` 左侧宿主机端口,例如 `3001:3000`,再运行 `docker compose up -d`。
- 旧版 S3 地址错误:仅 v4.14 或自定义旧版 Compose 需要检查 `STORAGE_EXTERNAL_ENDPOINT`;该地址必须同时可被客户端和 FastGPT 容器访问,不能是 `127.0.0.1` 或 `localhost`。
- Mongo 启动失败且日志出现 `Illegal instruction`:CPU 可能不支持 AVX,把 Mongo 镜像切换为 4.x 版本后重建相关容器。
- 数据库或向量库未就绪:先看对应容器日志,不要删除数据卷;只有确认是首次失败且没有有效数据时,才建议用户清理数据卷重试。
- 配置文件改动后:运行 `docker compose up -d` 让 Compose 应用变更;必要时只重启相关服务。

## 最终回复

使用用户的语言习惯回复。如果用户使用中文提问,用中文返回;如果用户使用英文提问,用英文返回;如果用户混合使用多种语言,优先使用用户主要使用的语言。

完全成功后,返回:

- FastGPT 访问地址,例如 `http://<服务器地址>:3000`。
- 登录账号:`root`。
- 登录密码:脚本输出的随机密码,或 `docker-compose.yml` 中的 `DEFAULT_ROOT_PSW`。
- 已开放或需要开放的端口:`3000`、`3003`;仅旧版外部 S3 下载链路还需要 `9000`。
- 下一步动作:登录后到 `管理员-模型提供商` 配置语言模型和索引模型;如需使用系统插件,到插件市场安装;如需公网 HTTPS,配置域名和反向代理。

如果未完全成功,返回当前卡住的容器、关键日志、已尝试的修复动作和下一步需要用户确认的事项。
prompt-optimizeSkill

Expert prompt engineering skill that transforms Claude into "Alpha-Prompt" - a master prompt engineer who collaboratively crafts high-quality prompts through flexible dialogue. Activates when user asks to "optimize prompt", "improve system instruction", "enhance AI instruction", or mentions prompt engineering tasks.

deprecate-workflow-nodeSkill

当用户需要弃用一个工作流节点(保留向后兼容、隐藏出模板面板)时触发该 skill。FastGPT 工作流节点的弃用流程标准化封装,覆盖模板、Dispatcher、UI 引用等所有需要改动的位置。

doc-i18nSkill

将 FastGPT 文档从中文翻译为面向北美用户的英文。当用户提到翻译文档、i18n、国际化、translate docs、新增/修改了中文文档需要同步英文版时,使用此 skill。也适用于用户要求检查文档翻译缺失、批量翻译、或对比中英文文档差异的场景。

add-permissionSkill

为 FastGPT 新资源接入权限管理。当用户需要为新资源(如 AgentSkill、Plugin 等)添加权限支持时触发。

api-developmentSkill

FastGPT API 开发规范。重点强调使用 zod schema 定义入参和出参,在 API 文档中声明路由信息,编写对应的 OpenAPI 文档,以及在 API 路由中使用 schema.parse 进行验证。

pr-reviewSkill

仅当用户明确手动指定使用 pr-review skill 时触发;不要因为用户传入 PR 链接、要求 review 或要求代码审查而自动触发。

test-caseSkill

当用户需要编写一个单元测试时,触发该 skill,编写单元测试。

pr-change-analysisSkill

手动触发的 FastGPT PR 或本地分支变更梳理技能。仅当用户显式调用 $pr-change-analysis 时使用;用于 reviewer 分析一个 GitHub PR 或当前本地分支相对 upstream/main 的需求变更、影响范围、代码质量与代码风格,不用于自动审查触发。