ChatGPT/FastGPT
1
0
Fork 0
mirror of https://github.com/labring/FastGPT.git synced 2026-02-27 01:02:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc (#6419)

Browse Source
This commit is contained in:
Archer
2026-02-12 18:02:02 +08:00
committed by GitHub
parent 76d6234de6
commit 0ac8bca17c
44 changed files with 871 additions and 456 deletions
Download Patch File Download Diff File Expand all files Collapse all files

167
document/content/docs/introduction/development/docker.mdx
View File

@@ -1,5 +1,5 @@
---
title: Docker Compose 快速部署
title: Docker 快速部署
description: 使用 Docker Compose 快速部署 FastGPT
---
@@ -9,8 +9,6 @@ import { Alert } from '@/components/docs/Alert';
1. 基础的网络知识：端口，防火墙……
2. Docker 和 Docker Compose 基础知识
3. 大模型相关接口和参数
4. RAG 相关知识：向量模型，向量数据库，向量检索
## 部署架构图
@@ -119,149 +117,68 @@ brew install orbstack
## 开始部署
### 1. 获取 `docker-compose.yml` 和 `config.json` 配置文件
### 1. 获取配置文件
#### 方法一：使用脚本部署
#### 方法一：使用交互式脚本部署
<Tabs items={['PgVector版本','Oceanbase版本','Milvus版本','Zilliz版本','SeekDB版本']}>
<Tab value="PgVector版本">
国内镜像(阿里云)
需要在 Linux/MacOS/Windows WSL 环境下执行，引导用户选择部署环境、向量库版本，IP地址等。
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=pg
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh)
```
非国内镜像(dockhub, ghcr)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --vector=pg
```
需要在 Linux/MacOS/Windows WSL 环境下执行
</Tab>
<Tab value="Oceanbase版本">
国内镜像(阿里云)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=oceanbase
```
非国内镜像(dockhub, ghcr)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --vector=oceanbase
```
需要在 Linux/MacOS/Windows WSL 环境下执行
</Tab>
<Tab value="Milvus版本">
国内镜像(阿里云)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=milvus
```
非国内镜像(dockhub, ghcr)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --vector=milvus
```
需要在 Linux/MacOS/Windows WSL 环境下执行
</Tab>
<Tab value="Zilliz版本">
国内镜像(阿里云)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=zilliz
```
非国内镜像(dockhub, ghcr)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --vector=zilliz
```
需要在 Linux/MacOS/Windows WSL 环境下执行
zilliz 还需要获取密钥，参考 [部署 Zilliz 版本获取账号和密钥](#部署-zilliz-版本获取账号和密钥)
</Tab>
<Tab value="SeekDB版本">
国内镜像(阿里云)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=seekdb
```
非国内镜像(dockhub, ghcr)
```bash
bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --vector=seekdb
```
需要在 Linux/MacOS/Windows WSL 环境下执行
<Alert icon="🤖" context="success">
SeekDB 使用 MySQL 协议，兼容 OceanBase 的所有特性：
- 端口：3306（默认）
- 连接字符串格式：`mysql://root%40tenantname:password@host:3306/database`
- 环境变量：`SEEKDB_URL`
</Alert>
</Tab>
</Tabs>
#### 方法二：手动下载部署
如果部署环境为非 *nix 环境或无法访问外网，需要手动下载 `docker-compose.yml` 进行部署
选择并下载您的 `docker-compose.yml` 文件
- Pgvector
1. 下载 `docker-compose.yml` 文件：
<details>
<summary>点击展开查看不同数据库的 docker-compose 配置文件下载地址</summary>
- **Pgvector**
- 中国大陆地区镜像源(阿里云)：[docker-compose.pg.yml](https://doc.fastgpt.cn/deploy/docker/cn/docker-compose.pg.yml)
- 全球镜像源(dockerhub, ghcr)：[docker-compose.pg.yml](https://doc.fastgpt.cn/deploy/docker/global/docker-compose.pg.yml)
- Oceanbase
- **Oceanbase**
- 中国大陆地区镜像源(阿里云)：[docker-compose.ob.yml](https://doc.fastgpt.cn/deploy/docker/cn/docker-compose.ob.yml)
- 全球镜像源(dockerhub, ghcr)：[docker-compose.ob.yml](https://doc.fastgpt.cn/deploy/docker/global/docker-compose.ob.yml)
- Milvus
- **Milvus**
- 中国大陆地区镜像源(阿里云)：[docker-compose.milvus.yml](https://doc.fastgpt.cn/deploy/docker/cn/docker-compose.milvus.yml)
- 全球镜像源(dockerhub, ghcr)：[docker-compose.milvus.yml](https://doc.fastgpt.cn/deploy/docker/global/docker-compose.milvus.yml)
- Zilliz
- **Zilliz**
- 中国大陆地区镜像源(阿里云)：[docker-compose.zilliz.yml](https://doc.fastgpt.cn/deploy/docker/cn/docker-compose.zilliz.yml)
- 全球镜像源(dockerhub, ghcr)：[docker-compose.zilliz.yml](https://doc.fastgpt.cn/deploy/docker/global/docker-compose.zilliz.yml)
- SeekDB
- **SeekDB**
- 中国大陆地区镜像源(阿里云)：[docker-compose.seekdb.yml](https://doc.fastgpt.cn/deploy/docker/cn/docker-compose.seekdb.yml)
- 全球镜像源(dockerhub, ghcr)：[docker-compose.seekdb.yml](https://doc.fastgpt.cn/deploy/docker/global/docker-compose.seekdb.yml)
2. 下载 `config.json` 文件：
- [config.json](https://doc.fastgpt.cn/deploy/config/config.json)
</details>
下载 config.json 文件
- [config.json](https://doc.fastgpt.cn/deploy/config/config.json)
<Alert icon="🤖" context="success">
### 2. 修改环境变量
所有 `docker-compose.yml` 配置文件中 `MongoDB` 为 5.x，需要用到AVX指令集，部分 CPU 不支持，需手动更改其镜像版本为 4.4.24\*\*（需要自己在docker hub下载，阿里云镜像没做备份）
1. 按照您的需求自行修改环境变量，建议在生产环境修改账号密码等。
2. 对于 Zilliz 版本 还需要获取密钥，参考 [部署 Zilliz 版本获取账号和密钥](#部署-zilliz-版本获取账号和密钥)
</Alert>
### 2. 开放外网端口/配置域名
以下两个端口必须被访问到：
1. 指向 3000 端口（FastGPT 主服务）
2. 指向 9000 端口（S3 服务）
### 3. 修改环境变量
1. 修改`STORAGE_EXTERNAL_ENDPOINT`变量，改成客户端和FastGPT 服务均可访问的地址。
**重要：**
> 填入的地址不可为`127.0.0.1`或者`localhost`等本地回环地址，可填 Docker 部署时的宿主机本地IP，但是需要把宿主机固定为静态 IP；或者统一为一个固定域名；目的是为了避免对象存储签名 URL 时，签发与上传的 URL 不一致导致的 403 错误。
>
> 具体查看 [对象存储配置及常见问题](/docs/introduction/development/object-storage)
2. 按照您的需求自行修改环境变量，建议在生产环境修改账号密码等。
3. 对于 Zilliz 版本 还需要获取密钥，参考 [部署 Zilliz 版本获取账号和密钥](#部署-zilliz-版本获取账号和密钥)
### 4. 修改 config.json 配置文件
### 3. 修改 config.json 配置文件
修改`config.json`文件中的`mcpServerProxyEndpoint`值，设置成`mcp server`的公网可访问地址，yml 文件中默认给出了映射到 3005 端口，如通过 IP 访问，则可能是：`120.172.2.10:3005`。
### 5. 启动容器
### 3. 开放外网端口/配置域名
以下端口必须被访问到：
1. 3000 端口（FastGPT 主服务）
2. 9000 端口（S3 服务）
1. 3005 端口（FastGPT SSE MCP server 服务）
### 6. 启动容器
在 docker-compose.yml 同级目录下执行。请确保`docker-compose`版本最好在2.17以上，否则可能无法执行自动化命令。
@@ -270,19 +187,19 @@ bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --ve
docker-compose up -d
```
### 6. 访问 FastGPT
### 7. 访问 FastGPT
可通过第二步开放的端口/域名访问 FastGPT。
登录用户名为 `root`，密码为`docker-compose.yml`环境变量里设置的 `DEFAULT_ROOT_PSW`。
每次重启容器，都会自动初始化 root 用户，密码为 `1234`（与环境变量中的`DEFAULT_ROOT_PSW`一致）。
### 7. 配置模型
### 8. 配置模型
- 首次登录FastGPT后，系统会提示未配置`语言模型`和`索引模型`，并自动跳转模型配置页面。系统必须至少有这两类模型才能正常使用。
- 如果系统未正常跳转，可以在`账号-模型提供商`页面，进行模型配置。[点击查看相关教程](/docs/introduction/development/modelConfig/ai-proxy)
- 目前已知可能问题：首次进入系统后，整个浏览器 tab 无法响应。此时需要删除该tab，重新打开一次即可。
### 8. 安装系统插件
### 9. 安装系统插件
从 V4.14.0 版本开始，fastgpt-plugin 镜像仅提供运行环境，不再预装系统插件，所有 FastGPT 系统需手动安装系统插件。
@@ -302,6 +219,16 @@ docker-compose up -d
| 0.5.x | >= 4.14.6 |
| < 0.5.0 | < 4.14.5 |
### S3 无法正常连接
检查`STORAGE_EXTERNAL_ENDPOINT`变量，需设置成客户端和 FastGPT 服务均可访问的地址。
**重要：**
> 填入的地址不可为`127.0.0.1`或者`localhost`等本地回环地址，可填 Docker 部署时的宿主机本地IP，但是需要把宿主机固定为静态 IP；或者统一为一个固定域名；目的是为了避免对象存储签名 URL 时，签发与上传的 URL 不一致导致的 403 错误。
>
> 具体查看 [对象存储配置及常见问题](/docs/introduction/development/object-storage)
### 登录系统后，浏览器无法响应

2
document/content/docs/introduction/development/intro.mdx
View File

@@ -1,5 +1,5 @@
---
title: 快速开始本地开发
title: 开始本地开发
description: 对 FastGPT 进行开发调试
---

4
document/content/docs/introduction/development/meta.json
View File

@@ -5,11 +5,11 @@
"pages": [
"quick-start",
"sealos",
"intro",
"docker",
"faq",
"intro",
"configuration",
"object-storage",
"faq",
"signoz",
"modelConfig",
"custom-models",

68
document/content/docs/introduction/index.en.mdx
View File

@@ -1,68 +0,0 @@
---
title: 快速了解 FastGPT
description: FastGPT 的能力与优势
---
import { Alert } from '@/components/docs/Alert';
FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，将智能对话与可视化编排完美结合，让 AI 应用开发变得简单自然。无论您是开发者还是业务人员，都能轻松打造专属的 AI 应用。
<Alert icon="🤖" context="success">
快速开始体验
- 海外版：[https://fastgpt.io](https://fastgpt.io)
- 国内版：[https://fastgpt.cn](https://fastgpt.cn)
</Alert>
| | |
| --------------------- | --------------------------------- |
| ![](/imgs/intro/image1.png) | ![](/imgs/intro/image2.png) |
# FastGPT 的优势
## 1. 简单灵活，像搭积木一样简单 🧱
像搭乐高一样简单有趣，FastGPT 提供丰富的功能模块，通过简单拖拽就能搭建出个性化的 AI 应用，零代码也能实现复杂的业务流程。
## 2. 让数据更智能 🧠
FastGPT 提供完整的数据智能化解决方案，从数据导入、预处理到知识匹配，再到智能问答，全流程自动化。配合可视化的工作流设计，轻松打造专业级 AI 应用。
## 3. 开源开放，易于集成 🔗
FastGPT 基于 Apache 2.0 协议开源，支持二次开发。通过标准 API 即可快速接入，无需修改源码。支持 ChatGPT、Claude、DeepSeek 和文心一言等主流模型，持续迭代优化，始终保持产品活力。
---
# FastGPT 能做什么
## 1. 全能知识库
可轻松导入各式各样的文档及数据，能自动对其开展知识结构化处理工作。同时，具备支持多轮上下文理解的智能问答功能，还可为用户带来持续优化的知识库管理体验。
![](/imgs/intro/image3.png)
## 2. 可视化工作流
FastGPT直观的拖拽式界面设计，可零代码搭建复杂业务流程。还拥有丰富的功能节点组件，能应对多种业务需求，有着灵活的流程编排能力，按需定制业务流程。
![](/imgs/intro/image4.png)
## 3. 数据智能解析
FastGPT知识库系统对导入数据的处理极为灵活，可以智能处理PDF文档的复杂结构，保留图片、表格和LaTeX公式，自动识别扫描文件，并将内容结构化为清晰的Markdown格式。同时支持图片自动标注和索引，让视觉内容可被理解和检索，确保知识在AI问答中能被完整、准确地呈现和应用。
![](/imgs/intro/image5.png)
## 4. 工作流编排
基于 Flow 模块的工作流编排，可以帮助你设计更加复杂的问答流程。例如查询数据库、查询库存、预约实验室等。
![](/imgs/intro/image6.png)
## 5. 强大的 API 集成
FastGPT 完全对齐 OpenAI 官方接口，支持一键接入企业微信、公众号、飞书、钉钉等平台，让 AI 能力轻松融入您的业务场景。
![](/imgs/intro/image7.png)
---
# 核心特性
- 开箱即用的知识库系统
- 可视化的低代码工作流编排
- 支持主流大模型
- 简单易用的 API 接口
- 灵活的数据处理能力
---
# 知识库核心流程图
![](/imgs/intro/image8.png)

4
document/content/docs/introduction/meta.json
View File

@@ -7,9 +7,9 @@
"cloud",
"commercial",
"development",
"openapi",
"---功能介绍---",
"...guide"
"...guide",
"openapi"
],
"order": 1
}

2
document/content/docs/introduction/openapi/share.mdx
View File

@@ -148,7 +148,7 @@ curl --location --request POST '{{host}}/shareAuth/start' \
该接口无规定返回值。
响应值与[chat 接口格式相同](/docs/introduction/development/openapi/intro/#响应)，仅多了一个`token`。
响应值与[chat 接口格式相同](/docs/introduction/openapi/intro/#响应)，仅多了一个`token`。
重点关注：`totalPoints`(总消耗AI积分)，`token`(Token消耗总数)