4.11.2 dev

.github/workflows/docs-deploy.yml

@@ -15,6 +15,43 @@ permissions:
   pull-requests: write
 
 jobs:
+  sync-images:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout current repository
+        uses: actions/checkout@v4
+
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+        with:
+          repository: labring/fastgpt-docs-img
+          token: ${{ secrets.DOCS_IMGS_SYNC_TOKEN }}
+          path: fastgpt-docs-imgs
+
+      - name: Sync images
+        run: |
+          # Create imgs directory if it doesn't exist
+          mkdir -p fastgpt-docs-imgs/imgs
+
+          # Copy all images from document/public/imgs to the target repository
+          cp -r document/public/imgs/* fastgpt-docs-imgs/
+
+          # Navigate to target repository
+          cd fastgpt-docs-imgs
+
+          # Configure git
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Add, commit and push changes
+          git add .
+          if ! git diff --cached --quiet; then
+            git commit -m "Sync images from FastGPT document at $(date)"
+            git push
+            echo "Images synced successfully"
+          else
+            echo "No changes to sync"
+          fi
   # Add a new job to generate unified timestamp
   generate-timestamp:
     runs-on: ubuntu-latest

.prettierignore

@@ -4,6 +4,7 @@ dist
 node_modules
 document/
 *.md
+*.mdx
 
 pnpm-lock.yaml
 cl100l_base.ts

.vscode/settings.json

@@ -25,7 +25,12 @@
     "[typescript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
+    "mdx.server.enable": true,
+    "markdown.copyFiles.overwriteBehavior": "nameIncrementally",
     "markdown.copyFiles.destination": {
-        "/document/content/**/*": "${documentWorkspaceFolder}/document/public/"
+        "/document/content/docs/**/*": "${documentWorkspaceFolder}/document/public/imgs/"
+    },
+    "files.associations": {
+        "*.mdx": "markdown"
     }
 }

LICENSE

@@ -7,7 +7,7 @@ The FastGPT is licensed under the Apache License 2.0, with the following additio
 a. Multi-tenant SaaS service: Unless explicitly authorized by FastGPT in writing, you may not use the FastGPT.AI source code to operate a multi-tenant SaaS service that is similar to the FastGPT.
 b. LOGO and copyright information: In the process of using FastGPT, you may not remove or modify the LOGO or copyright information in the FastGPT console.
 
-Please contact yujinlong@sealos.io by email to inquire about licensing matters.
+Please contact dennis@sealos.io by email to inquire about licensing matters.
 
 2. As a contributor, you should agree that your contributed code:
 

README.md

@@ -107,7 +107,7 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 * [部署 FastGPT](https://doc.fastgpt.io/docs/introduction/development/sealos/)
 * [系统配置文件说明](https://doc.fastgpt.io/docs/introduction/development/configuration/)
 * [多模型配置方案](https://doc.fastgpt.io/docs/introduction/development/modelConfig/one-api/)
-* [版本更新/升级介绍](https://doc.fastgpt.io/docs/introduction/development/upgrading/intro)
+* [版本更新/升级介绍](https://doc.fastgpt.io/docs/introduction/development/upgrading/index)
 * [OpenAPI API 文档](https://doc.fastgpt.io/docs/introduction/development/openapi/)
 * [知识库结构详解](https://doc.fastgpt.io/docs/introduction/guide/knowledge_base/RAG/)
 
@@ -216,4 +216,4 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 1. 允许作为后台服务直接商用，但不允许提供 SaaS 服务。
 2. 未经商业授权，任何形式的商用服务均需保留相关版权信息。
 3. 完整请查看 [FastGPT Open Source License](./LICENSE)
-4. 联系方式：[email protected]，[点击查看商业版定价策略](https://doc.fastgpt.io/docs/introduction/shopping_cart/intro/)
+4. 联系方式：[email protected]，[点击查看商业版定价策略](https://doc.fastgpt.io/docs/introduction/commercial/)

README_en.md

@@ -80,7 +80,7 @@ Project tech stack: NextJs + TS + ChakraUI + MongoDB + PostgreSQL (PG Vector plu
 - [Deploying FastGPT](https://doc.fastgpt.io/docs/introduction/development/docker)
 - [Guide on System Configs](https://doc.fastgpt.io/docs/introduction/development/configuration)
 - [Configuring Multiple Models](https://doc.fastgpt.io/docs//introduction/development/modelConfig/intro)
-- [Version Updates & Upgrades](https://doc.fastgpt.io/docs/introduction/development/upgrading/intro)
+- [Version Updates & Upgrades](https://doc.fastgpt.io/docs/introduction/development/upgrading/index)
 
 <a href="#FastGPT">
     <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
@@ -185,7 +185,7 @@ This repository complies with the [FastGPT Open Source License](./LICENSE) open
 1. Direct commercial use as a backend service is allowed, but provision of SaaS services is not allowed.
 2. Without commercial authorization, any form of commercial service must retain relevant copyright information.
 3. For full details, please see [FastGPT Open Source License](./LICENSE)
-4. Contact: [email protected] , [click to view commercial version pricing strategy](https://doc.fastgpt.io/docs/introduction/shopping_cart/intro/)
+4. Contact: [email protected] , [click to view commercial version pricing strategy](https://doc.fastgpt.io/docs/introduction/commercial/)
 
 <a href="#FastGPT">
     <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">

README_ja.md

@@ -102,7 +102,7 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 - [FastGPT のデプロイ](https://doc.fastgpt.io/docs/introduction/development/docker)
 - [システム 設定 ガイド](https://doc.fastgpt.io/docs/introduction/development/configuration)
 - [複数 モデルの 設定](https://doc.fastgpt.io/docs/introduction/development/modelConfig/ai-proxy)
-- [バージョン 更新 とアップグレード](https://doc.fastgpt.io/docs/introduction/development/upgrading/intro)
+- [バージョン 更新 とアップグレード](https://doc.fastgpt.io/docs/introduction/development/upgrading/index)
 
 <!-- ## :point_right: ロードマップ
 - [FastGPT ロードマップ](https://kjqvjse66l.feishu.cn/docx/RVUxdqE2WolDYyxEKATcM0XXnte) -->

SECURITY.md

@@ -5,7 +5,7 @@
 如果您发现了 FastGPT 的安全漏洞，请按照以下步骤进行报告：
 
 1. **报告方式**
-   发送邮件至：yujinlong@sealos.io
+   发送邮件至：dennis@sealos.io
    请备注版本以及您的 GitHub 账号
 
 3. **响应时间**

deploy/docker/yml.js

@@ -95,8 +95,8 @@ services:
 
   fastgpt:
     container_name: fastgpt
-    image: ghcr.io/labring/fastgpt:v4.11.0 # git
-    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.11.0 # 阿里云
+    image: ghcr.io/labring/fastgpt:v4.11.1 # git
+    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.11.1 # 阿里云
     ports:
       - 3000:3000
     networks:
@@ -152,15 +152,15 @@ services:
       - ./config.json:/app/data/config.json
   sandbox:
     container_name: sandbox
-    image: ghcr.io/labring/fastgpt-sandbox:v4.10.1 # git
-    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-sandbox:v4.10.1 # 阿里云
+    image: ghcr.io/labring/fastgpt-sandbox:v4.11.1 # git
+    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-sandbox:v4.11.1 # 阿里云
     networks:
       - fastgpt
     restart: always
   fastgpt-mcp-server:
     container_name: fastgpt-mcp-server
-    image: ghcr.io/labring/fastgpt-mcp_server:v4.10.1 # git
-    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-mcp_server:v4.10.1 # 阿里云
+    image: ghcr.io/labring/fastgpt-mcp_server:v4.11.1 # git
+    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-mcp_server:v4.11.1 # 阿里云
     ports:
       - 3005:3000
     networks:
@@ -169,8 +169,8 @@ services:
     environment:
       - FASTGPT_ENDPOINT=http://fastgpt:3000
   fastgpt-plugin:
-    image: ghcr.io/labring/fastgpt-plugin:v0.1.5 # git
-    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-plugin:v0.1.5 # 阿里云
+    image: ghcr.io/labring/fastgpt-plugin:v0.1.7 # git
+    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-plugin:v0.1.7 # 阿里云
     container_name: fastgpt-plugin
     restart: always
     networks:

document/README.md

@@ -1,8 +1,8 @@
-# fast
+# FastGPT 文档
 
 这是FastGPT的官方文档，采用fumadoc框架。
 
-# 获取搜索应用
+## 配置文档搜索
 
 点击[Algolia](https://dashboard.algolia.com/account/overview),进行注册账号，注册成功后需要点击页面的搜索,然后查看应用，默认会有一个应用。
 
@@ -16,7 +16,7 @@
 
 ![](./public/readme/algolia3.png)
 
-# 运行项目
+## 运行项目
 
 要运行文档，首先需要进行环境变量配置，在文档的根目录下创建`.env.local`文件，填写以下环境变量:
 
@@ -35,7 +35,7 @@ npm run dev
 ```
 项目会默认跑在`http:localhost:3000`端口
 
-# 书写文档
+## 书写文档
 
 文档采用`mdx`格式，大体和`md`一致，但是现在文档的元数据只支持`title` `description`和`icon`三个字段，参考以下示例代码：
 
@@ -81,14 +81,12 @@ import FastGPTLink from '@/components/docs/linkFastGPT'; #FastGPT跳转链接组
 }
 ```
 
-# i18n
+## i18n
 
 在`content/docs`下的所有`.mdx`文件为默认语言文件(当前默认语言中文)，`.en.mdx`文件为`i18n`支持的英文文件，例如，你可以将`hello.mdx`文档翻译后，写一个`hello.en.mdx`,同时，在对应目录的`meta.en.json`的`"pages"`字段写下对应的文件名来支持英文文档。
 
-# ps
+## 特殊配置
 
-`meta.json`的`"pages"`中的`"[Handshake][联系我们](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc)"`这个字段是目录的链接形式，表现效果为，点击后跳转到对应的url。
+### 增加顶层导航栏
 
-![](./public/readme/link.png)
-
-最后，如果依然有问题，可以进入`https://fumadocs.dev/docs/ui`官网，询问官网提供的ai来了解文档框架的使用。
+1. 在 `FastGPT/document/app/[lang]/docs/layout.tsx` 文件中新增导航。

document/app/[lang]/docs/layout.tsx

@@ -30,9 +30,17 @@ export default async function Layout({
       title: t('common:use-cases', lang),
       url: lang === 'zh-CN' ? '/docs/use-cases' : '/en/docs/use-cases'
     },
+    {
+      title: t('common:faq', lang),
+      url: lang === 'zh-CN' ? '/docs/faq' : '/en/docs/faq'
+    },
     {
       title: t('common:protocol', lang),
       url: lang === 'zh-CN' ? '/docs/protocol' : '/en/docs/protocol'
+    },
+    {
+      title: t('common:upgrading', lang),
+      url: lang === 'zh-CN' ? '/docs/upgrading' : '/en/docs/upgrading'
     }
   ];
 
@@ -41,7 +49,7 @@ export default async function Layout({
       {...baseOptions(lang)}
       nav={{
         title: (
-          <div className="flex flex-row items-center gap-2 h-14 ml-10">
+          <div className="flex flex-row items-center gap-2 h-14 ml-1">
             <div className="block dark:hidden">
               <LogoLight className="w-48 h-auto" />
             </div>

document/app/layout.config.tsx

@@ -20,15 +20,14 @@ export const baseOptions = (locale: string): BaseLayoutProps => {
           <div className="flex flex-row items-center gap-2">
             <img src="/FastGPT-full.svg" alt="FastGPT" width={49} height={48} />
           </div>
-          <div className="relative flex flex-row items-center gap-2 h-10 top-14"> 12321</div>
         </div>
       )
     },
-    i18n: {
-      languages: ['zh-CN', 'en'],
-      defaultLanguage: 'zh-CN',
-      hideLocale: 'always'
-    },
+    // i18n: {
+    //   languages: ['zh-CN', 'en'],
+    //   defaultLanguage: 'zh-CN',
+    //   hideLocale: 'always'
+    // },
     searchToggle: {
       enabled: true
     }

document/components/docs/not-found.tsx

@@ -9,12 +9,14 @@ const exactMap: Record<string, string> = {
   '/docs/guide/admin/sso_dingtalk':
     '/docs/introduction/guide/admin/sso#/docs/introduction/guide/admin/sso#钉钉',
   '/docs/guide/knowledge_base/rag': '/docs/introduction/guide/knowledge_base/RAG',
-  '/docs/commercial/intro/': '/docs/introduction'
+  '/docs/commercial/intro/': '/docs/introduction',
+  '/docs/upgrading/intro/': '/docs/upgrading',
+  '/docs/introduction/shopping_cart/intro/': '/docs/introduction/commercial'
 };
 
 const prefixMap: Record<string, string> = {
   '/docs/development': '/docs/introduction/development',
-  '/docs/FAQ': '/docs/introduction/FAQ',
+  '/docs/FAQ': '/docs/faq',
   '/docs/guide': '/docs/introduction/guide',
   '/docs/shopping_cart': '/docs/introduction/shopping_cart',
   '/docs/agreement': '/docs/protocol'

document/content/docs/faq/index.mdx

@@ -0,0 +1,8 @@
+---
+title: 使用案例
+description: FastGPT 使用案例
+---
+
+import { Redirect } from '@/components/docs/Redirect';
+
+<Redirect to="/docs/faq/app" />

document/content/docs/faq/meta.json

@@ -0,0 +1,14 @@
+{
+  "root": true,
+  "title": "FAQ",
+  "description": "FastGPT 常见问题",
+  "pages": [
+    "app",
+    "chat",
+    "dataset",
+    "external_channel_integration",
+    "error",
+    "points_consumption",
+    "other"
+  ]
+}

document/content/docs/introduction/cloud.mdx

@@ -0,0 +1,11 @@
+---
+title: FastGPT 云服务
+description: FastGPT 云服务
+---
+
+## 服务地址
+
+- [国内版: https://fastgpt.cn](https://fastgpt.cn)
+- [国际版: https://fastgpt.io](https://fastgpt.io)
+
+请按需注册，两个版本账号不互通。