perf: deploy docs; docker-compose (#5722)

* docs: https://localhost => http://localhost * chore: docker compose; deploy/dev docs * chore: quick-start page * chore: add comment & remove leading space of vector config * chore: remove redundant install.sh scripts * chore: adjust milvus and ob, image dyanmic config; readme.md * chore: update pnpm-lock.yaml
2025-10-16 08:01:18 +00:00 · 2025-09-29 11:34:11 +08:00
parent 5a2ba5a340
commit 32a3b9216b
49 changed files with 6230 additions and 1043 deletions
--- a/document/content/docs/introduction/development/community.mdx
+++ b/document/content/docs/introduction/development/community.mdx
@@ -1,16 +0,0 @@
---
-title: 加入社区
-description: ' 加入 FastGPT 开发者社区和我们一起成长'
---
-
-FastGPT 是一个由用户和贡献者参与推动的开源项目，如果您对产品使用存在疑问和建议，可尝试以下方式寻求支持。我们的团队与社区会竭尽所能为您提供帮助。
-
- 📱 扫码加入飞书交流群👇
-
-  <img
-    width="400px"
-    src="https://oss.laf.run/otnvvf-imgs/fastgpt-feishu1.png"
-    className="medium-zoom-image"
-  />
-
- 🐞 请将任何 FastGPT 的 Bug、问题和需求提交到 [GitHub Issue](https://github.com/labring/fastgpt/issues/new/choose)。
--- a/document/content/docs/introduction/development/docker.mdx
+++ b/document/content/docs/introduction/development/docker.mdx
@@ -19,8 +19,8 @@ import { Alert } from '@/components/docs/Alert';
 <Alert icon="🤖" context="success">

 - MongoDB：用于存储除了向量外的各类数据
- PostgreSQL/Milvus：存储向量数据
- OneAPI: 聚合各类 AI API，支持多模型调用 （任何模型问题，先自行通过 OneAPI 测试校验）
+- PostgreSQL/Milvus/Oceanbase：存储向量数据
+- AIProxy: 聚合各类 AI API，支持多模型调用 （任何模型问题，先自行通过 OneAPI 测试校验）

 </Alert>

@@ -99,12 +99,91 @@ brew install orbstack

 ## 开始部署

-### 1. 下载 docker-compose.yml
+### 1. 获取 `docker-compose.yml` 和 `config.json` 配置文件

-非 Linux 环境或无法访问外网环境，可手动创建一个目录，并下载配置文件和对应版本的`docker-compose.yml`，在这个文件夹中依据下载的配置文件运行docker，若作为本地开发使用推荐`docker-compose-pgvector`版本，并且自行拉取并运行`sandbox`和`fastgpt`，并在docker配置文件中注释掉`sandbox`和`fastgpt`的部分
+#### 方法一：使用脚本部署

- [config.json](https://raw.githubusercontent.com/labring/FastGPT/refs/heads/main/projects/app/data/config.json)
- [docker-compose.yml](https://github.com/labring/FastGPT/blob/main/deploy/docker) (注意，不同向量库版本的文件不一样)
+<Tabs items={['PgVector版本','Oceanbase版本','Milvus版本','Zilliz版本']}>
+  <Tab value="PgVector版本">
+国内镜像(阿里云)
+
+```bash
+bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=pg
+```
+
+非国内镜像(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>
+</Tabs>
+
+#### 方法二：手动下载部署
+如果部署环境为非 *nix 环境或无法访问外网，需要手动下载 `docker-compose.yml` 进行部署
+
+选择并下载您的 `docker-compose.yml` 文件
+- 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
+  - 中国大陆地区镜像源(阿里云)：[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
+  - 中国大陆地区镜像源(阿里云)：[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
+  - 中国大陆地区镜像源(阿里云)：[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)
+
+下载 config.json 文件
+- [config.json](https://doc.fastgpt.cn/deploy/config/config.json)

 <Alert icon="🤖" context="success">

@@ -112,50 +191,9 @@ brew install orbstack

 </Alert>

-**Linux 快速脚本**
-
-```bash
-mkdir fastgpt
-cd fastgpt
-curl -O https://raw.githubusercontent.com/labring/FastGPT/main/projects/app/data/config.json
-
-# pgvector 版本(测试推荐，简单快捷)
-curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-pgvector.yml
-# oceanbase 版本（需要将init.sql和docker-compose.yml放在同一个文件夹，方便挂载）
-# curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-oceanbase/docker-compose.yml
-# curl -o init.sql https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-oceanbase/init.sql
-# milvus 版本
-# curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-milvus.yml
-# zilliz 版本
-# curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-zilliz.yml
-```
-
 ### 2. 修改环境变量
-
-找到 yml 文件中，fastgpt 容器的环境变量进行下面操作：
-
-<Tabs items={['PgVector版本','Oceanbase版本','Milvus版本','Zilliz版本']}>
-  <Tab value="PgVector版本">
-无需操作
-  </Tab>
-  <Tab value="Oceanbase版本">
-无需操作
-  </Tab>
-  <Tab value="Milvus版本">
-无需操作
-  </Tab>
-  <Tab value="Zilliz版本">
-打开 [Zilliz Cloud](https://zilliz.com.cn/), 创建实例并获取相关秘钥。
-
-![zilliz_key](/imgs/zilliz_key.png)
-
-<Alert icon="🤖" context="success">
-
-1. 修改`MILVUS_ADDRESS`和`MILVUS_TOKEN`链接参数，分别对应 `zilliz` 的 `Public Endpoint` 和 `Api key`，记得把自己ip加入白名单。
-
-</Alert>
-  </Tab>
-</Tabs>
+按照您的需求自行修改环境变量，建议在生产环境修改账号密码等。
+对于 Zilliz 版本 还需要获取密钥，参考 [部署 Zilliz 版本获取账号和密钥](#部署-zilliz-版本获取账号和密钥)

 ### 3. 修改 config.json 配置文件

@@ -360,3 +398,14 @@ mongo连接失败，查看mongo的运行状态**对应日志**。
 ### 如何修改密码

 修改`docker-compose.yml`文件中`DEFAULT_ROOT_PSW`并重启即可，密码会自动更新。
+
+### 部署 Zilliz 版本，获取账号和密钥
+打开 [Zilliz Cloud](https://zilliz.com.cn/), 创建实例并获取相关秘钥。
+
+![zilliz_key](/imgs/zilliz_key.png)
+
+<Alert icon="🤖" context="success">
+
+1. 修改`MILVUS_ADDRESS`和`MILVUS_TOKEN`链接参数，分别对应 `zilliz` 的 `Public Endpoint` 和 `Api key`，记得把自己ip加入白名单。
+
+</Alert>
--- a/document/content/docs/introduction/development/intro.mdx
+++ b/document/content/docs/introduction/development/intro.mdx
@@ -8,49 +8,46 @@ import FastGPTLink from '@/components/docs/linkFastGPT';

 本文档介绍了如何设置开发环境以构建和测试 <FastGPTLink>FastGPT</FastGPTLink>。

-## 前置依赖项
+## 前置开发环境

 您需要在计算机上安装和配置以下依赖项才能构建 <FastGPTLink>FastGPT</FastGPTLink>：

- [Git](http://git-scm.com/)
- [Docker](https://www.docker.com/)（构建镜像）
- [Node.js v20.14.0](http://nodejs.org)（版本尽量一样，可以使用nvm管理node版本）
+- [Git](https://git-scm.com/)
+- [Docker](https://www.docker.com/)
+- [Node.js v20.14.0](https://nodejs.org)（版本尽量一样，可以使用 [nvm](https://github.com/nvm-sh/nvm) 管理 node 版本）
 - [pnpm](https://pnpm.io/) 推荐版本 9.4.0 (目前官方的开发环境)
- make命令: 根据不同平台，百度安装 (官方是GNU Make 4.3)
+
+建议在 *nix 环境进行开发 (Linux, MacOS, Windows WSL)

 ## 开始本地开发

-<Alert  context="success">
+### 1. Fork FastGPT 存储库

-1. 用户默认的时区为 `Asia/Shanghai`,非 linux 环境时候，获取系统时间会异常，本地开发时候，可以将用户的时区调整成 UTC（+0）。
-2. 建议先服务器装好**数据库**，再进行本地开发。
-
-</Alert>
-
-### 1. Fork 存储库
-
-您需要 Fork [存储库](https://github.com/labring/FastGPT)。
+您需要 Fork [FastGPT 存储库](https://github.com/labring/FastGPT)。

 ### 2. 克隆存储库

 克隆您在 GitHub 上 Fork 的存储库：

 ```
-git clone git@github.com:<github_username>/FastGPT.git
+git clone git@github.com:<your_github_username>/FastGPT.git
 ```

-**目录简要说明**

-1. `projects` 目录下为 FastGPT 应用代码。其中 `app` 为 FastGPT 核心应用。（后续可能会引入其他应用）
-2. NextJS 框架前后端放在一起，API 服务位于 `src/pages/api` 目录内。
-3. `packages` 目录为共用代码，通过 workspace 被注入到 `projects` 中，已配置 monorepo 自动注入，无需额外打包。
+### 3. 通过 docker 启动开发环境

-### 3. 安装数据库
+若您本地已经通过 docker 启动了 FastGPT，则需要先关闭，否则会有端口冲突。

-第一次开发，需要先部署数据库，建议本地开发可以随便找一台 2C2G 的轻量小数据库实践，或者新建文件夹并配置相关文件用以运行docker。数据库部署教程：[Docker 快速部署](/docs/introduction/development/docker/)。部署完了，可以本地访问其数据库。
+切换到 `FastGPT/deploy/dev` 目录，执行 `docker compose up -d` 运行 FastGPT 的各种依赖。
+
+```bash
+cd FastGPT/deploy/dev
+docker compose up -d
+```

 <Alert context="warning">
-  Mongo 数据库需要注意，需要注意在连接地址中增加 `directConnection=true`
+    1. 如果无法获取镜像，可以选择国内镜像版本的 docker-compose.yml 文件：`docker compose -f docker-compose.cn.yml up -d`
+    2. Mongo 数据库需要注意，需要注意在连接地址中增加 `directConnection=true`
  参数，才能连接上副本集的数据库。
 </Alert>

@@ -58,15 +55,29 @@ git clone git@github.com:<github_username>/FastGPT.git

 以下文件均在 `projects/app` 路径下。

+```bash
+# 确保你现在在 projects/app 下
+pwd
+# 应当输出 /xxxx/xxxx/xxx/FastGPT/projects/app
+```
+
 **1. 环境变量**

-复制`.env.template`文件，在同级目录下生成一个`.env.local` 文件，修改`.env.local` 里内容才是有效的变量。变量说明见 .env.template，主要需要修改`API_KEY`和数据库的地址与端口以及数据库账号的用户名和密码，具体配置需要和docker配置文件相同，其中用户名和密码如需修改需要修改docker配置文件、数据库和`.env.local`文件，不能只改一处。
+复制 `.env.template` 文件，在同级目录下生成一个`.env.local` 文件，修改`.env.local` 里内容才是有效的变量。
+变量说明见 `.env.template`
+如果没有修改 docker-compose.yaml 中的变量，`.env.template` 中的默认值就可以，不需要进行修改，否则需要和 `yml` 中的变量一致。

-**2. config 配置文件**
+```bash
+cp .env.template .env.local
+```
+
+**2. config.json 配置文件**

 复制 `data/config.json` 文件，生成一个 `data/config.local.json` 配置文件，具体配置参数说明，可参考 [config 配置说明](/docs/introduction/development/configuration)

-**注意：json 配置文件不能包含注释，介绍中为了方便看才加入的注释**
+```bash
+cp data/config.json data/config.local.json
+```

 这个文件大部分时候不需要修改。只需要关注 `systemEnv` 里的参数：

@@ -82,28 +93,22 @@ git clone git@github.com:<github_username>/FastGPT.git
 ```bash
 # 代码根目录下执行，会安装根 package、projects 和 packages 内所有依赖
 # 如果提示 isolate-vm 安装失败，可以参考：https://github.com/laverdet/isolated-vm?tab=readme-ov-file#requirements
+pwd # 应该在代码的根目录
 pnpm i
-
-# 非 Make 运行
 cd projects/app
 pnpm dev
-
-# Make 运行
-make dev name=app
 ```

-### 6. 部署打包
+默认 next 将运行在 3000 端口，访问 http://localhost:3000

+### 6. 打包
+
+建议直接使用 Docker 进行打包。
 ```bash
-# Docker cmd: Build image, not proxy
-docker build -f ./projects/app/Dockerfile -t registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1 . --build-arg name=app
-# Make cmd: Build image, not proxy
-make build name=app image=registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1
-
-# Docker cmd: Build image with proxy
-docker build -f ./projects/app/Dockerfile -t registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1 . --build-arg name=app --build-arg proxy=taobao
-# Make cmd: Build image with proxy
-make build name=app image=registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1 proxy=taobao
+# 没有 Proxy
+docker build -f ./projects/app/Dockerfile -t fastgpt . --build-arg name=app
+# Taobao Proxy
+docker build -f ./projects/app/Dockerfile -t fastgpt. --build-arg name=app --build-arg proxy=taobao
 ```

 如果不使用 `docker` 打包，需要手动把 `Dockerfile` 里 run 阶段的内容全部手动执行一遍（非常不推荐）。
@@ -118,6 +123,10 @@ make build name=app image=registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8

 ## QA

+### 获取系统时间异常
+
+如果用户默认的时区为 `Asia/Shanghai`, 非 linux 环境时，获取系统时间会异常，本地开发时，可以将用户的时区调整成 UTC（+0）。
+
 ### 本地数据库无法连接

 1. 如果你是连接远程的数据库，先检查对应的端口是否开放。
@@ -178,9 +187,9 @@ FastGPT 采用 pnpm workspace 方式构建 monorepo 项目，主要分为两个

 FastGPT 在代码模块划分时，按DDD的思想进行划分，主要分为以下几个领域：

-core - 核心功能（知识库，工作流，应用，对话）
-support - 支撑功能（用户体系，计费，鉴权等）
-common - 基础功能（日志管理，文件读写等）
+- core - 核心功能（知识库，工作流，应用，对话）
+- support - 支撑功能（用户体系，计费，鉴权等）
+- common - 基础功能（日志管理，文件读写等）

 <details>
 <summary>代码结构说明</summary>
--- a/document/content/docs/introduction/development/meta.json
+++ b/document/content/docs/introduction/development/meta.json
@@ -3,11 +3,11 @@
  "description": "FastGPT 社区版",
  "icon": "🔧",
  "pages": [
-    "community",
-    "intro",
+    "quick-start",
    "sealos",
-    "configuration",
+    "intro",
    "docker",
+    "configuration",
    "faq",
    "signoz",
    "modelConfig",
--- a/document/content/docs/introduction/development/openapi/chat.mdx
+++ b/document/content/docs/introduction/development/openapi/chat.mdx
@@ -382,7 +382,7 @@ event取值：
 对于用户选择，你只需要直接传递一个选择的结果给 messages 即可。

 ```bash
-curl --location --request POST 'https://localhost:3000/api/v1/chat/completions' \
+curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
@@ -404,7 +404,7 @@ curl --location --request POST 'https://localhost:3000/api/v1/chat/completions'
 表单输入稍微麻烦一点，需要将输入的内容，以对象形式并序列化成字符串，作为`messages`的值。对象的 key 对应表单的 key，value 为用户输入的值。务必确保`chatId`是一致的。

 ```bash
-curl --location --request POST 'https://localhost:3000/api/v1/chat/completions' \
+curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
@@ -847,7 +847,7 @@ curl --location --request DELETE 'http://localhost:3000/api/core/chat/clearHisto
  <Tab value="参数说明" >

 <div>
- appId - 应用 Id  
+- appId - 应用 Id
 - chatId - 历史记录 Id
 </div>

--- a/document/content/docs/introduction/development/openapi/dataset.mdx
+++ b/document/content/docs/introduction/development/openapi/dataset.mdx
@@ -939,7 +939,7 @@ curl --location --request POST 'http://localhost:3000/api/core/dataset/collectio
  <Tab value="请求示例" >

 ```bash
-curl --location --request POST 'https://localhost:3000/api/core/dataset/data/pushData' \
+curl --location --request POST 'http://localhost:3000/api/core/dataset/data/pushData' \
 --header 'Authorization: Bearer apikey' \
 --header 'Content-Type: application/json' \
 --data-raw '{
@@ -1242,7 +1242,7 @@ curl --location --request DELETE 'http://localhost:3000/api/core/dataset/data/de
  <Tab value="请求示例" >

 ```bash
-curl --location --request POST 'https://localhost:3000/api/core/dataset/searchTest' \
+curl --location --request POST 'http://localhost:3000/api/core/dataset/searchTest' \
 --header 'Authorization: Bearer fastgpt-xxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
--- a/document/content/docs/introduction/development/openapi/intro.mdx
+++ b/document/content/docs/introduction/development/openapi/intro.mdx
@@ -29,7 +29,7 @@ FastGPT 的 API Key **有 2 类**，一类是全局通用的 key (无法直接
 OpenAPI 中，所有的接口都通过 Header.Authorization 进行鉴权。

 ```
-baseUrl: "https://localhost:3000/api"
+baseUrl: "http://localhost:3000/api"
 headers: {
    Authorization: "Bearer {{apikey}}"
 }
@@ -38,7 +38,7 @@ headers: {
 **发起应用对话示例**

 ```sh
-curl --location --request POST 'https://localhost:3000/api/v1/chat/completions' \
+curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
@@ -59,7 +59,7 @@ curl --location --request POST 'https://localhost:3000/api/v1/chat/completions'
 `v4.8.13`后支持传入自定义的用户 ID, 并且存入历史记录中。

 ```sh
-curl --location --request POST 'https://localhost:3000/api/v1/chat/completions' \
+curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
--- a/document/content/docs/introduction/development/quick-start.mdx
+++ b/document/content/docs/introduction/development/quick-start.mdx
@@ -0,0 +1,100 @@
+---
+title: 快速开始
+description: 一键启动 FastGPT，进行本地体验
+---
+
+import { Alert } from '@/components/docs/Alert';
+import FastGPTLink from '@/components/docs/linkFastGPT';
+
+## 本地 Docker 快速体验
+
+快速体验将默认使用 PostgreSQL Vector 向量库。
+
+### 1. 准备 Docker 环境
+
+<Tabs items={['Linux','MacOS','Windows']}>
+  <Tab value="Linux">
+  参考：https://www.docker.com
+```bash
+# 安装 Docker
+curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
+systemctl enable --now docker
+# 安装 docker-compose
+curl -L https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
+chmod +x /usr/local/bin/docker-compose
+# 验证安装
+docker -v
+docker-compose -v
+# 如失效，自行百度~
+```
+  </Tab>
+  <Tab value="MacOS">
+推荐直接使用 [Orbstack](https://orbstack.dev/)。可直接通过 Homebrew 来安装：
+
+```bash
+brew install orbstack
+```
+
+或者直接[下载安装包](https://orbstack.dev/download)进行安装。
+
+  </Tab>
+  <Tab value="Windows">
+我们建议将源代码和其他数据绑定到 Linux 容器中时，将其存储在 Linux 文件系统中，而不是 Windows 文件系统中。
+
+可以选择直接[使用 WSL 2 后端在 Windows 中安装 Docker Desktop](https://docs.docker.com/desktop/wsl/)。
+
+也可以直接[在 WSL 2 中安装命令行版本的 Docker](https://nickjanetakis.com/blog/install-docker-in-wsl-2-without-docker-desktop)。
+
+  </Tab>
+</Tabs>
+
+### 2. 获取部署文件
+
+<Tabs items={['使用 bash 脚本一键安装','手动安装']}>
+<Tab value="使用 bash 脚本一键安装">
+根据您的网络环境选择：
+
+国内镜像(阿里云)
+```bash
+bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=cn --vector=pg
+```
+非国内镜像(dockhub, ghcr)
+```bash
+bash <(curl -fsSL https://doc.fastgpt.cn/deploy/install.sh) --region=global --vector=pg
+```
+上述脚本需要在 bash 环境下使用（Windows 用户请使用 Windows WSL，或者使用手动安装）
+</Tab>
+<Tab value="手动安装">
+在你有权限的目录下创建一个目录，在目录内下载如下两个文件：
+
+根据您的网络环境选择下载：
+- [国内镜像版本的 docker-compose.yml](https://doc.fastgpt.cn/deploy/docker/cn/docker-compose.pg.yml)
+- [非国内镜像版本的 docker-compose.yml](https://doc.fastgpt.cn/deploy/docker/global/docker-compose.pg.yml)
+
+下载 config.json
+- [config.json](https://doc.fastgpt.cn/deploy/config.json)
+
+</Tab>
+</Tabs>
+
+### 3. 启动
+
+```bash
+docker compose -f docker-compose.pg.yml up -d
+```
+
+等待服务启动，通过 http://localhost:3000 进行访问
+默认用户为 `root`，密码为 `1234`
+
+### Sealos 一键部署
+本地部署起不来？试试 [Sealos 一键部署](sealos)。
+
+## 进阶使用
+
+### 进行本地开发
+
+如果要改代码或者给 FastGPT 贡献代码，请参考：[进行本地开发](intro)
+
+### 生产环境部署
+
+如果要在生产环境进行部署，使用其他的向量库，配置相关的环境变量，请参考：[生产环境部署](docker)
--- a/document/content/docs/introduction/index.mdx
+++ b/document/content/docs/introduction/index.mdx
@@ -66,3 +66,17 @@ FastGPT 完全对齐 OpenAI 官方接口，支持一键接入企业微信、公
 # 知识库核心流程图

 ![](/imgs/intro/image8.png)
+
+---
+
+FastGPT 是一个由用户和贡献者参与推动的开源项目，如果您对产品使用存在疑问和建议，可尝试以下方式寻求支持。我们的团队与社区会竭尽所能为您提供帮助。
+
+- 📱 扫码加入飞书交流群👇
+
+  <img
+    width="400px"
+    src="https://oss.laf.run/otnvvf-imgs/fastgpt-feishu1.png"
+    className="medium-zoom-image"
+  />
+
+- 🐞 请将任何 FastGPT 的 Bug、问题和需求提交到 [GitHub Issue](https://github.com/labring/fastgpt/issues/new/choose)。
--- a/document/content/docs/toc.mdx
+++ b/document/content/docs/toc.mdx
@@ -12,7 +12,6 @@ description: FastGPT 文档目录
 - [/docs/faq/points_consumption](/docs/faq/points_consumption)
 - [/docs/introduction/cloud](/docs/introduction/cloud)
 - [/docs/introduction/commercial](/docs/introduction/commercial)
- [/docs/introduction/development/community](/docs/introduction/development/community)
 - [/docs/introduction/development/configuration](/docs/introduction/development/configuration)
 - [/docs/introduction/development/custom-models/bge-rerank](/docs/introduction/development/custom-models/bge-rerank)
 - [/docs/introduction/development/custom-models/chatglm2](/docs/introduction/development/custom-models/chatglm2)
@@ -42,6 +41,7 @@ description: FastGPT 文档目录
 - [/docs/introduction/development/proxy/cloudflare](/docs/introduction/development/proxy/cloudflare)
 - [/docs/introduction/development/proxy/http_proxy](/docs/introduction/development/proxy/http_proxy)
 - [/docs/introduction/development/proxy/nginx](/docs/introduction/development/proxy/nginx)
+- [/docs/introduction/development/quick-start](/docs/introduction/development/quick-start)
 - [/docs/introduction/development/sealos](/docs/introduction/development/sealos)
 - [/docs/introduction/development/signoz](/docs/introduction/development/signoz)
 - [/docs/introduction/guide/DialogBoxes/htmlRendering](/docs/introduction/guide/DialogBoxes/htmlRendering)
--- a/document/content/docs/use-cases/external-integration/openapi.mdx
+++ b/document/content/docs/use-cases/external-integration/openapi.mdx
@@ -24,7 +24,7 @@ import { Alert } from '@/components/docs/Alert';
 ## 替换三方应用的变量

 ```bash
-OPENAI_API_BASE_URL: https://localhost:3000/api (改成自己部署的域名)
+OPENAI_API_BASE_URL: http://localhost:3000/api (改成自己部署的域名)
 OPENAI_API_KEY = 上一步获取到的密钥
 ```