Skip to content

赵月辉 / fastgpt-migrated

Go to a project
Commit 87b0bca3 by Archer Committed by GitHub
Options

Doc (#6493) 

* cloud doc

* doc refactor

* doc move

* seo

* remove doc

* yml

* doc

* fix: tsconfig

* fix: tsconfig
parent 6b613595
Showing with 452 additions and 623 deletions
README.md
...@@ -24,7 +24,7 @@ FastGPT 是一个 AI Agent 构建平台，提供开箱即用的数据处理、 ...@@ -24,7 +24,7 @@ FastGPT 是一个 AI Agent 构建平台，提供开箱即用的数据处理、
<a href="https://doc.fastgpt.io/docs/introduction"> <a href="https://doc.fastgpt.io/docs/introduction">
<img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document"> <img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document">
</a> </a>
<a href="https://doc.fastgpt.io/docs/introduction/development/intro"> <a href="https://doc.fastgpt.io/docs/self-host/dev">
<img height="21" src="https://img.shields.io/badge/本地开发-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> <img height="21" src="https://img.shields.io/badge/本地开发-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a> </a>
<a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE"> <a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
...@@ -47,7 +47,7 @@ docker compose up -d ...@@ -47,7 +47,7 @@ docker compose up -d
完全启动后，可通过`http://localhost:3000`访问 FastGPT，默认账号为`root`，密码为`1234`。 完全启动后，可通过`http://localhost:3000`访问 FastGPT，默认账号为`root`，密码为`1234`。
如果你遇到问题，可以[查看完整 Docker 部署教程](https://doc.fastgpt.io/docs/introduction/development/docker) 如果你遇到问题，可以[查看完整 Docker 部署教程](https://doc.fastgpt.io/docs/self-host/deploy/docker)
## 🛸 使用方式 ## 🛸 使用方式
...@@ -55,7 +55,7 @@ docker compose up -d ...@@ -55,7 +55,7 @@ docker compose up -d
如果你不需要私有化部署，可以直接使用我们提供的云服务版本，地址为：[fastgpt.io](https://fastgpt.io/) 如果你不需要私有化部署，可以直接使用我们提供的云服务版本，地址为：[fastgpt.io](https://fastgpt.io/)
- **社区自托管版本** - **社区自托管版本**
可以使用[Docker](https://doc.fastgpt.io/docs/introduction/development/docker)快速部署，也可以使用[Sealos Cloud](https://doc.fastgpt.io/docs/introduction/development/sealos) 来一键部署FastGPT。 可以使用[Docker](https://doc.fastgpt.io/docs/self-host/deploy/docker)快速部署，也可以使用[Sealos Cloud](https://doc.fastgpt.io/docs/self-host/deploy/sealos) 来一键部署FastGPT。
- **商业版** - **商业版**
如果你需要更完整的功能，或深度的服务支持，可以选择我们的[商业版](https://doc.fastgpt.io/docs/introduction/commercial)。我们除了提供完整的软件外，还提供相应的场景落地辅导，具体可提交[商业咨询](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc) 如果你需要更完整的功能，或深度的服务支持，可以选择我们的[商业版](https://doc.fastgpt.io/docs/introduction/commercial)。我们除了提供完整的软件外，还提供相应的场景落地辅导，具体可提交[商业咨询](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc)
...@@ -115,7 +115,7 @@ docker compose up -d ...@@ -115,7 +115,7 @@ docker compose up -d
## 💪 我们的项目 & 链接 ## 💪 我们的项目 & 链接
- [快速开始本地开发](https://doc.fastgpt.io/docs/introduction/development/intro/) - [快速开始本地开发](https://doc.fastgpt.io/docs/self-host/dev/)
- [OpenAPI 文档](https://doc.fastgpt.io/docs/openapi/intro) - [OpenAPI 文档](https://doc.fastgpt.io/docs/openapi/intro)
- [FastGPT-plugin](https://github.com/labring/fastgpt-plugin) - [FastGPT-plugin](https://github.com/labring/fastgpt-plugin)
- [AI Proxy: 模型聚合负载均衡服务](https://github.com/labring/aiproxy) - [AI Proxy: 模型聚合负载均衡服务](https://github.com/labring/aiproxy)
......
README_en.md
...@@ -24,7 +24,7 @@ FastGPT is an AI Agent building platform that provides out-of-the-box capabiliti ...@@ -24,7 +24,7 @@ FastGPT is an AI Agent building platform that provides out-of-the-box capabiliti
<a href="https://doc.fastgpt.io/docs/introduction"> <a href="https://doc.fastgpt.io/docs/introduction">
<img height="21" src="https://img.shields.io/badge/Documentation-7d09f1?style=flat-square" alt="document"> <img height="21" src="https://img.shields.io/badge/Documentation-7d09f1?style=flat-square" alt="document">
</a> </a>
<a href="https://doc.fastgpt.io/docs/introduction/development/intro"> <a href="https://doc.fastgpt.io/docs/self-host/dev">
<img height="21" src="https://img.shields.io/badge/Local_Development-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> <img height="21" src="https://img.shields.io/badge/Local_Development-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a> </a>
<a href="#-our-projects--links"> <a href="#-our-projects--links">
...@@ -47,7 +47,7 @@ docker compose up -d ...@@ -47,7 +47,7 @@ docker compose up -d
After fully started, you can access FastGPT at `http://localhost:3000`. The default account is `root` and the password is `1234`. After fully started, you can access FastGPT at `http://localhost:3000`. The default account is `root` and the password is `1234`.
If you encounter any issues, you can [view the complete Docker deployment tutorial](https://doc.fastgpt.io/docs/introduction/development/docker) If you encounter any issues, you can [view the complete Docker deployment tutorial](https://doc.fastgpt.io/docs/self-host/deploy/docker)
## 🛸 Usage ## 🛸 Usage
...@@ -55,7 +55,7 @@ If you encounter any issues, you can [view the complete Docker deployment tutori ...@@ -55,7 +55,7 @@ If you encounter any issues, you can [view the complete Docker deployment tutori
If you don't need private deployment, you can directly use our cloud service at: [fastgpt.io](https://fastgpt.io/) If you don't need private deployment, you can directly use our cloud service at: [fastgpt.io](https://fastgpt.io/)
- **Community Self-Hosted Version** - **Community Self-Hosted Version**
You can quickly deploy using [Docker](https://doc.fastgpt.io/docs/introduction/development/docker) or use [Sealos Cloud](https://doc.fastgpt.io/docs/introduction/development/sealos) to deploy FastGPT with one click. You can quickly deploy using [Docker](https://doc.fastgpt.io/docs/self-host/deploy/docker) or use [Sealos Cloud](https://doc.fastgpt.io/docs/self-host/deploy/sealos) to deploy FastGPT with one click.
- **Commercial Version** - **Commercial Version**
If you need more complete features or in-depth service support, you can choose our [Commercial Version](https://doc.fastgpt.io/docs/introduction/commercial). In addition to providing complete software, we also offer implementation guidance for specific scenarios. You can submit a [commercial consultation](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc). If you need more complete features or in-depth service support, you can choose our [Commercial Version](https://doc.fastgpt.io/docs/introduction/commercial). In addition to providing complete software, we also offer implementation guidance for specific scenarios. You can submit a [commercial consultation](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc).
...@@ -115,7 +115,7 @@ If you encounter any issues, you can [view the complete Docker deployment tutori ...@@ -115,7 +115,7 @@ If you encounter any issues, you can [view the complete Docker deployment tutori
## 💪 Our Projects & Links ## 💪 Our Projects & Links
- [Quick Start Local Development](https://doc.fastgpt.io/docs/introduction/development/intro/) - [Quick Start Local Development](https://doc.fastgpt.io/docs/self-host/dev/)
- [OpenAPI Documentation](https://doc.fastgpt.io/docs/openapi/intro) - [OpenAPI Documentation](https://doc.fastgpt.io/docs/openapi/intro)
- [FastGPT-plugin](https://github.com/labring/fastgpt-plugin) - [FastGPT-plugin](https://github.com/labring/fastgpt-plugin)
- [AI Proxy: Model Aggregation Load Balancing Service](https://github.com/labring/aiproxy) - [AI Proxy: Model Aggregation Load Balancing Service](https://github.com/labring/aiproxy)
......
README_id.md
...@@ -24,7 +24,7 @@ FastGPT adalah platform pembangunan AI Agent yang menyediakan kemampuan siap pak ...@@ -24,7 +24,7 @@ FastGPT adalah platform pembangunan AI Agent yang menyediakan kemampuan siap pak
<a href="https://doc.fastgpt.io/docs/introduction"> <a href="https://doc.fastgpt.io/docs/introduction">
<img height="21" src="https://img.shields.io/badge/Dokumentasi-7d09f1?style=flat-square" alt="document"> <img height="21" src="https://img.shields.io/badge/Dokumentasi-7d09f1?style=flat-square" alt="document">
</a> </a>
<a href="https://doc.fastgpt.io/docs/introduction/development/intro"> <a href="https://doc.fastgpt.io/docs/self-host/dev">
<img height="21" src="https://img.shields.io/badge/Pengembangan_Lokal-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> <img height="21" src="https://img.shields.io/badge/Pengembangan_Lokal-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a> </a>
<a href="#-proyek--tautan-kami"> <a href="#-proyek--tautan-kami">
...@@ -47,7 +47,7 @@ docker compose up -d ...@@ -47,7 +47,7 @@ docker compose up -d
Setelah sepenuhnya aktif, Anda dapat mengakses FastGPT di `http://localhost:3000`. Akun default adalah `root` dan kata sandinya adalah `1234`. Setelah sepenuhnya aktif, Anda dapat mengakses FastGPT di `http://localhost:3000`. Akun default adalah `root` dan kata sandinya adalah `1234`.
Jika Anda menghadapi masalah, Anda dapat [melihat tutorial penyebaran Docker lengkap](https://doc.fastgpt.io/docs/introduction/development/docker) Jika Anda menghadapi masalah, Anda dapat [melihat tutorial penyebaran Docker lengkap](https://doc.fastgpt.io/docs/self-host/deploy/docker)
## 🛸 Cara Penggunaan ## 🛸 Cara Penggunaan
...@@ -55,7 +55,7 @@ Jika Anda menghadapi masalah, Anda dapat [melihat tutorial penyebaran Docker len ...@@ -55,7 +55,7 @@ Jika Anda menghadapi masalah, Anda dapat [melihat tutorial penyebaran Docker len
Jika Anda tidak memerlukan penyebaran privat, Anda dapat langsung menggunakan layanan cloud kami di: [fastgpt.io](https://fastgpt.io/) Jika Anda tidak memerlukan penyebaran privat, Anda dapat langsung menggunakan layanan cloud kami di: [fastgpt.io](https://fastgpt.io/)
- **Versi Self-Hosted Komunitas** - **Versi Self-Hosted Komunitas**
Anda dapat menyebarkan dengan cepat menggunakan [Docker](https://doc.fastgpt.io/docs/introduction/development/docker) atau menggunakan [Sealos Cloud](https://doc.fastgpt.io/docs/introduction/development/sealos) untuk menyebarkan FastGPT dengan satu klik. Anda dapat menyebarkan dengan cepat menggunakan [Docker](https://doc.fastgpt.io/docs/self-host/deploy/docker) atau menggunakan [Sealos Cloud](https://doc.fastgpt.io/docs/self-host/deploy/sealos) untuk menyebarkan FastGPT dengan satu klik.
- **Versi Komersial** - **Versi Komersial**
Jika Anda membutuhkan fitur yang lebih lengkap atau dukungan layanan mendalam, Anda dapat memilih [Versi Komersial](https://doc.fastgpt.io/docs/introduction/commercial). Selain menyediakan perangkat lunak lengkap, kami juga menyediakan panduan implementasi untuk skenario tertentu. Anda dapat mengirimkan [konsultasi komersial](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc). Jika Anda membutuhkan fitur yang lebih lengkap atau dukungan layanan mendalam, Anda dapat memilih [Versi Komersial](https://doc.fastgpt.io/docs/introduction/commercial). Selain menyediakan perangkat lunak lengkap, kami juga menyediakan panduan implementasi untuk skenario tertentu. Anda dapat mengirimkan [konsultasi komersial](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc).
...@@ -115,7 +115,7 @@ Jika Anda menghadapi masalah, Anda dapat [melihat tutorial penyebaran Docker len ...@@ -115,7 +115,7 @@ Jika Anda menghadapi masalah, Anda dapat [melihat tutorial penyebaran Docker len
## 💪 Proyek & Tautan Kami ## 💪 Proyek & Tautan Kami
- [Mulai Cepat Pengembangan Lokal](https://doc.fastgpt.io/docs/introduction/development/intro/) - [Mulai Cepat Pengembangan Lokal](https://doc.fastgpt.io/docs/self-host/dev/)
- [Dokumentasi OpenAPI](https://doc.fastgpt.io/docs/openapi/intro) - [Dokumentasi OpenAPI](https://doc.fastgpt.io/docs/openapi/intro)
- [FastGPT-plugin](https://github.com/labring/fastgpt-plugin) - [FastGPT-plugin](https://github.com/labring/fastgpt-plugin)
- [AI Proxy: Layanan Load Balancing Agregasi Model](https://github.com/labring/aiproxy) - [AI Proxy: Layanan Load Balancing Agregasi Model](https://github.com/labring/aiproxy)
......
README_ja.md
...@@ -24,7 +24,7 @@ FastGPT 縺ｯ AI Agent 讒狗ｯ峨繝ｩ繝ヨ繝輔か繝ｼ繝縺ｧ縺ゅｊ縲√☆縺舌↓菴ｿ縺医 ...@@ -24,7 +24,7 @@ FastGPT 縺ｯ AI Agent 讒狗ｯ峨繝ｩ繝ヨ繝輔か繝ｼ繝縺ｧ縺ゅｊ縲√☆縺舌↓菴ｿ縺医
<a href="https://doc.fastgpt.io/docs/introduction"> <a href="https://doc.fastgpt.io/docs/introduction">
<img height="21" src="https://img.shields.io/badge/ドキュメント-7d09f1?style=flat-square" alt="document"> <img height="21" src="https://img.shields.io/badge/ドキュメント-7d09f1?style=flat-square" alt="document">
</a> </a>
<a href="https://doc.fastgpt.io/docs/introduction/development/intro"> <a href="https://doc.fastgpt.io/docs/self-host/dev">
<img height="21" src="https://img.shields.io/badge/ローカル開発-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> <img height="21" src="https://img.shields.io/badge/ローカル開発-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a> </a>
<a href="#-プロジェクトとリンク"> <a href="#-プロジェクトとリンク">
...@@ -47,7 +47,7 @@ docker compose up -d ...@@ -47,7 +47,7 @@ docker compose up -d
完全に起動した後、`http://localhost:3000` で FastGPT にアクセスできます。デフォルトのアカウントは `root`、パスワードは `1234` です。 完全に起動した後、`http://localhost:3000` で FastGPT にアクセスできます。デフォルトのアカウントは `root`、パスワードは `1234` です。
問題が発生した場合は、[Docker デプロイの完全チュートリアル](https://doc.fastgpt.io/docs/introduction/development/docker)をご覧ください。 問題が発生した場合は、[Docker デプロイの完全チュートリアル](https://doc.fastgpt.io/docs/self-host/deploy/docker)をご覧ください。
## 🛸 利用方法 ## 🛸 利用方法
...@@ -55,7 +55,7 @@ docker compose up -d ...@@ -55,7 +55,7 @@ docker compose up -d
プライベートデプロイが不要な場合は、クラウドサービスを直接ご利用いただけます：[fastgpt.io](https://fastgpt.io/) プライベートデプロイが不要な場合は、クラウドサービスを直接ご利用いただけます：[fastgpt.io](https://fastgpt.io/)
- **コミュニティセルフホスト版** - **コミュニティセルフホスト版**
[Docker](https://doc.fastgpt.io/docs/introduction/development/docker) で素早くデプロイするか、[Sealos Cloud](https://doc.fastgpt.io/docs/introduction/development/sealos) でワンクリックデプロイが可能です。 [Docker](https://doc.fastgpt.io/docs/self-host/deploy/docker) で素早くデプロイするか、[Sealos Cloud](https://doc.fastgpt.io/docs/self-host/deploy/sealos) でワンクリックデプロイが可能です。
- **商用版** - **商用版**
より完全な機能や深いサービスサポートが必要な場合は、[商用版](https://doc.fastgpt.io/docs/introduction/commercial)をお選びいただけます。完全なソフトウェアの提供に加え、シナリオに応じた導入ガイダンスも提供しています。[商用相談](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc)からお問い合わせください。 より完全な機能や深いサービスサポートが必要な場合は、[商用版](https://doc.fastgpt.io/docs/introduction/commercial)をお選びいただけます。完全なソフトウェアの提供に加え、シナリオに応じた導入ガイダンスも提供しています。[商用相談](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc)からお問い合わせください。
...@@ -115,7 +115,7 @@ docker compose up -d ...@@ -115,7 +115,7 @@ docker compose up -d
## 💪 プロジェクトとリンク ## 💪 プロジェクトとリンク
- [クイックスタート ローカル開発](https://doc.fastgpt.io/docs/introduction/development/intro/) - [クイックスタート ローカル開発](https://doc.fastgpt.io/docs/self-host/dev/)
- [OpenAPI ドキュメント](https://doc.fastgpt.io/docs/openapi/intro) - [OpenAPI ドキュメント](https://doc.fastgpt.io/docs/openapi/intro)
- [FastGPT-plugin](https://github.com/labring/fastgpt-plugin) - [FastGPT-plugin](https://github.com/labring/fastgpt-plugin)
- [AI Proxy: モデル集約ロードバランシングサービス](https://github.com/labring/aiproxy) - [AI Proxy: モデル集約ロードバランシングサービス](https://github.com/labring/aiproxy)
......
README_th.md
...@@ -24,7 +24,7 @@ FastGPT เป็นแพลตฟอร์มสำหรับสร้าง ...@@ -24,7 +24,7 @@ FastGPT เป็นแพลตฟอร์มสำหรับสร้าง
<a href="https://doc.fastgpt.io/docs/introduction"> <a href="https://doc.fastgpt.io/docs/introduction">
<img height="21" src="https://img.shields.io/badge/เอกสาร-7d09f1?style=flat-square" alt="document"> <img height="21" src="https://img.shields.io/badge/เอกสาร-7d09f1?style=flat-square" alt="document">
</a> </a>
<a href="https://doc.fastgpt.io/docs/introduction/development/intro"> <a href="https://doc.fastgpt.io/docs/self-host/dev">
<img height="21" src="https://img.shields.io/badge/พัฒนาในเครื่อง-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> <img height="21" src="https://img.shields.io/badge/พัฒนาในเครื่อง-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a> </a>
<a href="#-โปรเจกต์และลิงก์ของเรา"> <a href="#-โปรเจกต์และลิงก์ของเรา">
...@@ -47,7 +47,7 @@ docker compose up -d ...@@ -47,7 +47,7 @@ docker compose up -d
เมื่อเริ่มต้นสมบูรณ์แล้ว คุณสามารถเข้าถึง FastGPT ที่ `http://localhost:3000` บัญชีเริ่มต้นคือ `root` และรหัสผ่านคือ `1234` เมื่อเริ่มต้นสมบูรณ์แล้ว คุณสามารถเข้าถึง FastGPT ที่ `http://localhost:3000` บัญชีเริ่มต้นคือ `root` และรหัสผ่านคือ `1234`
หากคุณพบปัญหา คุณสามารถ [ดูบทแนะนำการติดตั้ง Docker ฉบับสมบูรณ์](https://doc.fastgpt.io/docs/introduction/development/docker) หากคุณพบปัญหา คุณสามารถ [ดูบทแนะนำการติดตั้ง Docker ฉบับสมบูรณ์](https://doc.fastgpt.io/docs/self-host/deploy/docker)
## 🛸 วิธีการใช้งาน ## 🛸 วิธีการใช้งาน
...@@ -55,7 +55,7 @@ docker compose up -d ...@@ -55,7 +55,7 @@ docker compose up -d
หากคุณไม่ต้องการติดตั้งแบบส่วนตัว คุณสามารถใช้บริการคลาวด์ของเราได้โดยตรงที่: [fastgpt.io](https://fastgpt.io/) หากคุณไม่ต้องการติดตั้งแบบส่วนตัว คุณสามารถใช้บริการคลาวด์ของเราได้โดยตรงที่: [fastgpt.io](https://fastgpt.io/)
- **เวอร์ชันโฮสต์ตัวเองของชุมชน** - **เวอร์ชันโฮสต์ตัวเองของชุมชน**
คุณสามารถติดตั้งได้อย่างรวดเร็วโดยใช้ [Docker](https://doc.fastgpt.io/docs/introduction/development/docker) หรือใช้ [Sealos Cloud](https://doc.fastgpt.io/docs/introduction/development/sealos) เพื่อติดตั้ง FastGPT ด้วยคลิกเดียว คุณสามารถติดตั้งได้อย่างรวดเร็วโดยใช้ [Docker](https://doc.fastgpt.io/docs/self-host/deploy/docker) หรือใช้ [Sealos Cloud](https://doc.fastgpt.io/docs/self-host/deploy/sealos) เพื่อติดตั้ง FastGPT ด้วยคลิกเดียว
- **เวอร์ชันพาณิชย์** - **เวอร์ชันพาณิชย์**
หากคุณต้องการคุณสมบัติที่สมบูรณ์มากขึ้นหรือการสนับสนุนบริการเชิงลึก คุณสามารถเลือก [เวอร์ชันพาณิชย์](https://doc.fastgpt.io/docs/introduction/commercial) นอกจากการให้ซอฟต์แวร์ที่สมบูรณ์ เรายังให้คำแนะนำการนำไปใช้สำหรับสถานการณ์เฉพาะ คุณสามารถส่ง[ปรึกษาธุรกิจ](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc) หากคุณต้องการคุณสมบัติที่สมบูรณ์มากขึ้นหรือการสนับสนุนบริการเชิงลึก คุณสามารถเลือก [เวอร์ชันพาณิชย์](https://doc.fastgpt.io/docs/introduction/commercial) นอกจากการให้ซอฟต์แวร์ที่สมบูรณ์ เรายังให้คำแนะนำการนำไปใช้สำหรับสถานการณ์เฉพาะ คุณสามารถส่ง[ปรึกษาธุรกิจ](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc)
...@@ -115,7 +115,7 @@ docker compose up -d ...@@ -115,7 +115,7 @@ docker compose up -d
## 💪 โปรเจกต์และลิงก์ของเรา ## 💪 โปรเจกต์และลิงก์ของเรา
- [เริ่มต้นพัฒนาในเครื่อง](https://doc.fastgpt.io/docs/introduction/development/intro/) - [เริ่มต้นพัฒนาในเครื่อง](https://doc.fastgpt.io/docs/self-host/dev/)
- [เอกสาร OpenAPI](https://doc.fastgpt.io/docs/openapi/intro) - [เอกสาร OpenAPI](https://doc.fastgpt.io/docs/openapi/intro)
- [FastGPT-plugin](https://github.com/labring/fastgpt-plugin) - [FastGPT-plugin](https://github.com/labring/fastgpt-plugin)
- [AI Proxy: บริการ Load Balancing การรวมโมเดล](https://github.com/labring/aiproxy) - [AI Proxy: บริการ Load Balancing การรวมโมเดล](https://github.com/labring/aiproxy)
......
README_vi.md
...@@ -24,7 +24,7 @@ FastGPT là nền tảng xây dựng AI Agent cung cấp khả năng sẵn sàng ...@@ -24,7 +24,7 @@ FastGPT là nền tảng xây dựng AI Agent cung cấp khả năng sẵn sàng
<a href="https://doc.fastgpt.io/docs/introduction"> <a href="https://doc.fastgpt.io/docs/introduction">
<img height="21" src="https://img.shields.io/badge/Tài_Liệu-7d09f1?style=flat-square" alt="document"> <img height="21" src="https://img.shields.io/badge/Tài_Liệu-7d09f1?style=flat-square" alt="document">
</a> </a>
<a href="https://doc.fastgpt.io/docs/introduction/development/intro"> <a href="https://doc.fastgpt.io/docs/self-host/dev">
<img height="21" src="https://img.shields.io/badge/Phát_Triển_Local-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> <img height="21" src="https://img.shields.io/badge/Phát_Triển_Local-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a> </a>
<a href="#-dự-án--liên-kết-của-chúng-tôi"> <a href="#-dự-án--liên-kết-của-chúng-tôi">
...@@ -47,7 +47,7 @@ docker compose up -d ...@@ -47,7 +47,7 @@ docker compose up -d
Sau khi khởi động hoàn tất, bạn có thể truy cập FastGPT tại `http://localhost:3000`. Tài khoản mặc định là `root` và mật khẩu là `1234`. Sau khi khởi động hoàn tất, bạn có thể truy cập FastGPT tại `http://localhost:3000`. Tài khoản mặc định là `root` và mật khẩu là `1234`.
Nếu bạn gặp vấn đề, bạn có thể [xem hướng dẫn triển khai Docker đầy đủ](https://doc.fastgpt.io/docs/introduction/development/docker) Nếu bạn gặp vấn đề, bạn có thể [xem hướng dẫn triển khai Docker đầy đủ](https://doc.fastgpt.io/docs/self-host/deploy/docker)
## 🛸 Cách Sử Dụng ## 🛸 Cách Sử Dụng
...@@ -55,7 +55,7 @@ Nếu bạn gặp vấn đề, bạn có thể [xem hướng dẫn triển khai ...@@ -55,7 +55,7 @@ Nếu bạn gặp vấn đề, bạn có thể [xem hướng dẫn triển khai
Nếu bạn không cần triển khai riêng, bạn có thể sử dụng trực tiếp dịch vụ đám mây của chúng tôi tại: [fastgpt.io](https://fastgpt.io/) Nếu bạn không cần triển khai riêng, bạn có thể sử dụng trực tiếp dịch vụ đám mây của chúng tôi tại: [fastgpt.io](https://fastgpt.io/)
- **Phiên Bản Tự Host Cộng Đồng** - **Phiên Bản Tự Host Cộng Đồng**
Bạn có thể triển khai nhanh chóng bằng [Docker](https://doc.fastgpt.io/docs/introduction/development/docker) hoặc sử dụng [Sealos Cloud](https://doc.fastgpt.io/docs/introduction/development/sealos) để triển khai FastGPT bằng một cú nhấp chuột. Bạn có thể triển khai nhanh chóng bằng [Docker](https://doc.fastgpt.io/docs/self-host/deploy/docker) hoặc sử dụng [Sealos Cloud](https://doc.fastgpt.io/docs/self-host/deploy/sealos) để triển khai FastGPT bằng một cú nhấp chuột.
- **Phiên Bản Thương Mại** - **Phiên Bản Thương Mại**
Nếu bạn cần các tính năng đầy đủ hơn hoặc hỗ trợ dịch vụ chuyên sâu, bạn có thể chọn [Phiên Bản Thương Mại](https://doc.fastgpt.io/docs/introduction/commercial). Ngoài việc cung cấp phần mềm đầy đủ, chúng tôi còn cung cấp hướng dẫn triển khai cho các kịch bản cụ thể. Bạn có thể gửi [tư vấn thương mại](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc). Nếu bạn cần các tính năng đầy đủ hơn hoặc hỗ trợ dịch vụ chuyên sâu, bạn có thể chọn [Phiên Bản Thương Mại](https://doc.fastgpt.io/docs/introduction/commercial). Ngoài việc cung cấp phần mềm đầy đủ, chúng tôi còn cung cấp hướng dẫn triển khai cho các kịch bản cụ thể. Bạn có thể gửi [tư vấn thương mại](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc).
...@@ -115,7 +115,7 @@ Nếu bạn gặp vấn đề, bạn có thể [xem hướng dẫn triển khai ...@@ -115,7 +115,7 @@ Nếu bạn gặp vấn đề, bạn có thể [xem hướng dẫn triển khai
## 💪 Dự Án & Liên Kết Của Chúng Tôi ## 💪 Dự Án & Liên Kết Của Chúng Tôi
- [Bắt Đầu Phát Triển Địa Phương](https://doc.fastgpt.io/docs/introduction/development/intro/) - [Bắt Đầu Phát Triển Địa Phương](https://doc.fastgpt.io/docs/self-host/dev/)
- [Tài Liệu OpenAPI](https://doc.fastgpt.io/docs/openapi/intro) - [Tài Liệu OpenAPI](https://doc.fastgpt.io/docs/openapi/intro)
- [FastGPT-plugin](https://github.com/labring/fastgpt-plugin) - [FastGPT-plugin](https://github.com/labring/fastgpt-plugin)
- [AI Proxy: Dịch Vụ Cân Bằng Tải Tổng Hợp Mô Hình](https://github.com/labring/aiproxy) - [AI Proxy: Dịch Vụ Cân Bằng Tải Tổng Hợp Mô Hình](https://github.com/labring/aiproxy)
......
deploy/dev/docker-compose.cn.yml
...@@ -162,7 +162,7 @@ services: ...@@ -162,7 +162,7 @@ services:
- fastgpt - fastgpt
environment: environment:
- AUTH_TOKEN=token - AUTH_TOKEN=token
# @see https://fastgpt.cn/docs/introduction/development/object-storage # @see https://fastgpt.cn/docs/self-host/config/object-storage
- STORAGE_VENDOR=minio # minio | aws-s3 | cos | oss - STORAGE_VENDOR=minio # minio | aws-s3 | cos | oss
- STORAGE_REGION=us-east-1 - STORAGE_REGION=us-east-1
- STORAGE_ACCESS_KEY_ID=minioadmin - STORAGE_ACCESS_KEY_ID=minioadmin
......
deploy/dev/docker-compose.yml
...@@ -162,7 +162,7 @@ services: ...@@ -162,7 +162,7 @@ services:
- fastgpt - fastgpt
environment: environment:
- AUTH_TOKEN=token - AUTH_TOKEN=token
# @see https://fastgpt.cn/docs/introduction/development/object-storage # @see https://fastgpt.cn/docs/self-host/config/object-storage
- STORAGE_VENDOR=minio # minio | aws-s3 | cos | oss - STORAGE_VENDOR=minio # minio | aws-s3 | cos | oss
- STORAGE_REGION=us-east-1 - STORAGE_REGION=us-east-1
- STORAGE_ACCESS_KEY_ID=minioadmin - STORAGE_ACCESS_KEY_ID=minioadmin
......
deploy/docker/cn/docker-compose.milvus.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/cn/docker-compose.oceanbase.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/cn/docker-compose.pg.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/cn/docker-compose.seekdb.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/cn/docker-compose.zilliz.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/global/docker-compose.milvus.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/global/docker-compose.oceanbase.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/global/docker-compose.pg.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/global/docker-compose.seekdb.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/docker/global/docker-compose.ziliiz.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
deploy/templates/docker-compose.dev.yml
...@@ -162,7 +162,7 @@ services: ...@@ -162,7 +162,7 @@ services:
- fastgpt - fastgpt
environment: environment:
- AUTH_TOKEN=token - AUTH_TOKEN=token
# @see https://fastgpt.cn/docs/introduction/development/object-storage # @see https://fastgpt.cn/docs/self-host/config/object-storage
- STORAGE_VENDOR=minio # minio | aws-s3 | cos | oss - STORAGE_VENDOR=minio # minio | aws-s3 | cos | oss
- STORAGE_REGION=us-east-1 - STORAGE_REGION=us-east-1
- STORAGE_ACCESS_KEY_ID=minioadmin - STORAGE_ACCESS_KEY_ID=minioadmin
......
deploy/templates/docker-compose.prod.yml
...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config ...@@ -12,7 +12,7 @@ x-share-db-config: &x-share-db-config
MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin MONGODB_URI: mongodb://myusername:mypassword@mongo:27017/fastgpt?authSource=admin
DB_MAX_LINK: 100 DB_MAX_LINK: 100
REDIS_URL: redis://default:mypassword@redis:6379 REDIS_URL: redis://default:mypassword@redis:6379
# @see https://doc.fastgpt.cn/docs/introduction/development/object-storage # @see https://doc.fastgpt.cn/docs/self-host/config/object-storage
STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss STORAGE_VENDOR: minio # minio | aws-s3 | cos | oss
STORAGE_REGION: us-east-1 STORAGE_REGION: us-east-1
STORAGE_ACCESS_KEY_ID: minioadmin STORAGE_ACCESS_KEY_ID: minioadmin
......
document/README.md
...@@ -38,7 +38,7 @@ import { Alert } from '@/components/docs/Alert'; #高亮块组件 ...@@ -38,7 +38,7 @@ import { Alert } from '@/components/docs/Alert'; #高亮块组件
import {Redirect} from '@/components/docs/Redirect' #重定向组件，如果你希望用户点击这个文件跳转到别的文件的话，详情参考 `FAQ`的`Docker 部署问题`文档。 import {Redirect} from '@/components/docs/Redirect' #重定向组件，如果你希望用户点击这个文件跳转到别的文件的话，详情参考 `FAQ`的`Docker 部署问题`文档。
<Redirect to="/docs/introduction/development/docker/#faq" /> <Redirect to="/docs/self-host/deploy/docker/#faq" />
<Tabs items={['Javascript', 'Rust']}> #tabs组件用法，渲染效果参考`introduction`下`development`的`faq`文档 <Tabs items={['Javascript', 'Rust']}> #tabs组件用法，渲染效果参考`introduction`下`development`的`faq`文档
<Tab value="Javascript">Javascript is weird</Tab> <Tab value="Javascript">Javascript is weird</Tab>
......
document/app/[lang]/docs/[[...slug]]/page.tsx
...@@ -5,6 +5,7 @@ import NotFound from '@/components/docs/not-found'; ...@@ -5,6 +5,7 @@ import NotFound from '@/components/docs/not-found';
import { createRelativeLink } from 'fumadocs-ui/mdx'; import { createRelativeLink } from 'fumadocs-ui/mdx';
import { getMDXComponents } from '@/mdx-components'; import { getMDXComponents } from '@/mdx-components';
import { i18n } from '@/lib/i18n'; import { i18n } from '@/lib/i18n';
import { generateArticleSchema, generateBreadcrumbSchema } from '@/lib/schema';
// 在构建时导入静态数据 // 在构建时导入静态数据
import docLastModifiedData from '@/data/doc-last-modified.json'; import docLastModifiedData from '@/data/doc-last-modified.json';
...@@ -36,7 +37,45 @@ export default async function Page({ ...@@ -36,7 +37,45 @@ export default async function Page({
// @ts-ignore // @ts-ignore
const lastModified = docLastModifiedData[filePath] || page.data.lastModified; const lastModified = docLastModifiedData[filePath] || page.data.lastModified;
const homeDomain = process.env.FASTGPT_HOME_DOMAIN ?? 'https://fastgpt.io';
const domain = homeDomain.replace('https://', 'https://doc.');
const url = `${domain}${page.url}`;
// 生成面包屑导航
const breadcrumbItems = [
{ name: 'FastGPT', url: domain },
{ name: 'Docs', url: `${domain}/${lang}/docs` }
];
if (slug && slug.length > 0) {
slug.forEach((segment, index) => {
const segmentUrl = `${domain}/${lang}/docs/${slug.slice(0, index + 1).join('/')}`;
breadcrumbItems.push({ name: segment, url: segmentUrl });
});
}
// 生成结构化数据
const articleSchema = generateArticleSchema({
title: page.data.title,
description: page.data.description || '',
url,
dateModified: lastModified ? new Date(lastModified) : undefined,
lang
});
const breadcrumbSchema = generateBreadcrumbSchema({
items: breadcrumbItems
});
return ( return (
<>
<script
type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify(articleSchema) }}
/>
<script
type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify(breadcrumbSchema) }}
/>
<DocsPage <DocsPage
toc={page.data.toc} toc={page.data.toc}
full={page.data.full} full={page.data.full}
...@@ -61,6 +100,7 @@ export default async function Page({ ...@@ -61,6 +100,7 @@ export default async function Page({
/> />
</DocsBody> </DocsBody>
</DocsPage> </DocsPage>
</>
); );
} }
...@@ -75,8 +115,33 @@ export async function generateMetadata(props: { ...@@ -75,8 +115,33 @@ export async function generateMetadata(props: {
const page = source.getPage(slug, lang); const page = source.getPage(slug, lang);
if (!page || !page.data) notFound(); if (!page || !page.data) notFound();
const homeDomain = process.env.FASTGPT_HOME_DOMAIN ?? 'https://fastgpt.io';
const domain = homeDomain.replace('https://', 'https://doc.');
const url = `${domain}${page.url}`;
// 构建多语言 alternates
const languages: Record<string, string> = {};
i18n.languages.forEach((locale) => {
const localePage = source.getPage(slug, locale);
if (localePage) {
languages[locale] = `${domain}/${locale}/docs/${slug?.join('/') || ''}`;
}
});
return { return {
title: `${page.data.title} | FastGPT`, title: `${page.data.title} | FastGPT`,
description: page.data.description description: page.data.description,
alternates: {
canonical: url,
languages
},
openGraph: {
title: `${page.data.title} | FastGPT`,
description: page.data.description,
url,
siteName: 'FastGPT',
locale: lang,
type: 'article'
}
}; };
} }
document/app/[lang]/docs/layout.tsx
...@@ -12,7 +12,7 @@ import FeishuLogoLight from '@/components/docs/feishuLogoLIght'; ...@@ -12,7 +12,7 @@ import FeishuLogoLight from '@/components/docs/feishuLogoLIght';
import FeishuLogoDark from '@/components/docs/feishuLogoDark'; import FeishuLogoDark from '@/components/docs/feishuLogoDark';
import GithubLogoLight from '@/components/docs/githubLogoLight'; import GithubLogoLight from '@/components/docs/githubLogoLight';
import GithubLogoDark from '@/components/docs/githubLogoDark'; import GithubLogoDark from '@/components/docs/githubLogoDark';
import { BookOpen, Code, Lightbulb, CircleHelp, Scale, History } from 'lucide-react'; import { BookOpen, Code, Lightbulb, CircleHelp, Scale, History, Server } from 'lucide-react';
export default async function Layout({ export default async function Layout({
params, params,
...@@ -31,29 +31,24 @@ export default async function Layout({ ...@@ -31,29 +31,24 @@ export default async function Layout({
url: getLocalizedPath('/docs/introduction', lang) url: getLocalizedPath('/docs/introduction', lang)
}, },
{ {
icon: <Code className={iconClass} />,
title: t('common:api_reference', lang),
url: getLocalizedPath('/docs/openapi', lang)
},
{
icon: <Lightbulb className={iconClass} />, icon: <Lightbulb className={iconClass} />,
title: t('common:use-cases', lang), title: t('common:use-cases', lang),
url: getLocalizedPath('/docs/use-cases', lang) url: getLocalizedPath('/docs/use-cases', lang)
}, },
{ {
icon: <CircleHelp className={iconClass} />, icon: <Server className={iconClass} />,
title: t('common:faq', lang), title: t('common:selfHost', lang),
url: getLocalizedPath('/docs/faq', lang) url: getLocalizedPath('/docs/self-host', lang)
}, },
{ {
icon: <Scale className={iconClass} />, icon: <Code className={iconClass} />,
title: t('common:protocol', lang), title: t('common:api_reference', lang),
url: getLocalizedPath('/docs/protocol', lang) url: getLocalizedPath('/docs/openapi', lang)
}, },
{ {
icon: <History className={iconClass} />, icon: <CircleHelp className={iconClass} />,
title: t('common:upgrading', lang), title: t('common:faq', lang),
url: getLocalizedPath('/docs/upgrading', lang) url: getLocalizedPath('/docs/faq', lang)
} }
]; ];
...@@ -116,7 +111,7 @@ export default async function Layout({ ...@@ -116,7 +111,7 @@ export default async function Layout({
collapsible: false, collapsible: false,
components: CustomSidebarComponents components: CustomSidebarComponents
}} }}
tabMode="navbar" tabMode="sidebar"
> >
<SidebarKeepOpen tabUrls={tabUrls} /> <SidebarKeepOpen tabUrls={tabUrls} />
{children} {children}
......
document/app/[lang]/layout.tsx
...@@ -5,6 +5,7 @@ import type { ReactNode } from 'react'; ...@@ -5,6 +5,7 @@ import type { ReactNode } from 'react';
import type { Translations } from 'fumadocs-ui/i18n'; import type { Translations } from 'fumadocs-ui/i18n';
import CustomSearchDialog from '@/components/CustomSearchDialog'; import CustomSearchDialog from '@/components/CustomSearchDialog';
import Script from 'next/script'; import Script from 'next/script';
import type { Metadata } from 'next';
const inter = Inter({ const inter = Inter({
subsets: ['latin'] subsets: ['latin']
...@@ -14,13 +15,24 @@ const zh_CN: Partial<Translations> = { ...@@ -14,13 +15,24 @@ const zh_CN: Partial<Translations> = {
search: '搜索', search: '搜索',
nextPage: '下一页', nextPage: '下一页',
previousPage: '上一页', previousPage: '上一页',
lastUpdate: '最后更新于', lastUpdate: '文件更新时间',
editOnGithub: '在 GitHub 上编辑', editOnGithub: '在 GitHub 上编辑',
searchNoResult: '没有找到相关内容', searchNoResult: '没有找到相关内容',
toc: '本页导航', toc: '本页导航',
tocNoHeadings: '本页没有导航', tocNoHeadings: '本页没有导航',
chooseLanguage: '选择语言' chooseLanguage: '选择语言'
}; };
const en: Partial<Translations> = {
search: 'Search',
nextPage: 'Next Page',
previousPage: 'Previous Page',
lastUpdate: 'File Updated',
editOnGithub: 'Edit on GitHub',
searchNoResult: 'No results found',
toc: 'On this page',
tocNoHeadings: 'No headings',
chooseLanguage: 'Choose Language'
};
const locales = [ const locales = [
{ {
...@@ -33,6 +45,84 @@ const locales = [ ...@@ -33,6 +45,84 @@ const locales = [
} }
]; ];
export async function generateMetadata({
params
}: {
params: Promise<{ lang: string }>;
}): Promise<Metadata> {
const { lang } = await params;
const homeDomain = process.env.FASTGPT_HOME_DOMAIN ?? 'https://fastgpt.io';
const domain = homeDomain.replace('https://', 'https://doc.');
const title = lang === 'zh-CN' ? 'FastGPT 文档' : 'FastGPT Documentation';
const description =
lang === 'zh-CN'
? 'FastGPT 是一个 AI Agent 构建平台，通过 Flow 提供开箱即用的数据处理、模型调用能力和可视化工作流编排。'
: 'FastGPT is an AI Agent building platform that provides out-of-the-box data processing, model invocation capabilities, and visual workflow orchestration through Flow.';
return {
title: {
default: title,
template: `%s | FastGPT`
},
description,
keywords: ['FastGPT', 'AI', 'Agent', 'LLM', 'RAG', 'Workflow', 'Documentation'],
authors: [{ name: 'Labring', url: 'https://github.com/labring' }],
creator: 'Labring',
publisher: 'Labring',
metadataBase: new URL(domain),
alternates: {
canonical: '/',
languages: {
en: '/en',
'zh-CN': '/zh-CN'
}
},
openGraph: {
type: 'website',
locale: lang,
url: domain,
title,
description,
siteName: 'FastGPT',
images: [
{
url: '/og-image.png',
width: 1200,
height: 630,
alt: 'FastGPT'
}
]
},
twitter: {
card: 'summary_large_image',
title,
description,
images: ['/twitter-image.png']
},
robots: {
index: true,
follow: true,
googleBot: {
index: true,
follow: true,
'max-video-preview': -1,
'max-image-preview': 'large',
'max-snippet': -1
}
},
icons: {
icon: [
{ url: '/favicon/favicon.ico' },
{ url: '/favicon/favicon.svg', type: 'image/svg+xml' },
{ url: '/favicon/favicon-96x96.png', sizes: '96x96', type: 'image/png' }
],
apple: [{ url: '/favicon/apple-touch-icon.png', sizes: '180x180', type: 'image/png' }]
},
manifest: '/favicon/site.webmanifest'
};
}
export default async function Layout({ export default async function Layout({
children, children,
params params
...@@ -50,12 +140,7 @@ export default async function Layout({ ...@@ -50,12 +140,7 @@ export default async function Layout({
<html lang={lang} className={inter.className} suppressHydrationWarning> <html lang={lang} className={inter.className} suppressHydrationWarning>
<body className="flex flex-col min-h-screen"> <body className="flex flex-col min-h-screen">
{trackSrc && siteId && ( {trackSrc && siteId && (
<Script <Script src={trackSrc} data-site-id={siteId} defer strategy="afterInteractive" />
src={trackSrc}
data-site-id={siteId}
defer
strategy="afterInteractive"
/>
)} )}
<RootProvider <RootProvider
i18n={{ i18n={{
...@@ -63,17 +148,7 @@ export default async function Layout({ ...@@ -63,17 +148,7 @@ export default async function Layout({
locales, locales,
translations: { translations: {
'zh-CN': zh_CN, 'zh-CN': zh_CN,
en: { en
search: 'Search',
nextPage: 'Next Page',
previousPage: 'Previous Page',
lastUpdate: 'Last Updated',
editOnGithub: 'Edit on GitHub',
searchNoResult: 'No results found',
toc: 'On this page',
tocNoHeadings: 'No headings',
chooseLanguage: 'Choose Language'
}
}[lang] }[lang]
}} }}
search={{ search={{
......
document/app/global.css
...@@ -438,6 +438,11 @@ div[data-rmiz-modal-overlay='visible'] { ...@@ -438,6 +438,11 @@ div[data-rmiz-modal-overlay='visible'] {
border-color: transparent; border-color: transparent;
} }
#nd-page > article,
#nd-toc {
padding-top: 2rem;
}
button[data-search-full] { button[data-search-full] {
background-color: var(--color-fd-background); background-color: var(--color-fd-background);
} }
...@@ -492,8 +497,18 @@ button[role='tab'] { ...@@ -492,8 +497,18 @@ button[role='tab'] {
/* 去掉 viewport 内部的顶部渐变遮罩 */ /* 去掉 viewport 内部的顶部渐变遮罩 */
#nd-sidebar-mobile [data-radix-scroll-area-viewport] > div { #nd-sidebar-mobile [data-radix-scroll-area-viewport] > div {
mask-image: linear-gradient(transparent, #fff 0px, #fff calc(100% - 12px), transparent) !important; mask-image: linear-gradient(
-webkit-mask-image: linear-gradient(transparent, #fff 0px, #fff calc(100% - 12px), transparent) !important; transparent,
#fff 0px,
#fff calc(100% - 12px),
transparent
) !important;
-webkit-mask-image: linear-gradient(
transparent,
#fff 0px,
#fff calc(100% - 12px),
transparent
) !important;
} }
} }
...@@ -512,6 +527,12 @@ button[role='tab'] { ...@@ -512,6 +527,12 @@ button[role='tab'] {
justify-content: center; justify-content: center;
} }
/* RootToggle sidebar tab selector: remove bottom margin */
#nd-sidebar .mb-2,
#nd-sidebar-mobile .mb-2 {
margin-bottom: 0 !important;
}
/* RootToggle 下拉菜单：增加两侧 padding + 选中项浅蓝背景 */ /* RootToggle 下拉菜单：增加两侧 padding + 选中项浅蓝背景 */
[data-radix-popper-content-wrapper] > div { [data-radix-popper-content-wrapper] > div {
padding: 6px 8px !important; padding: 6px 8px !important;
...@@ -528,12 +549,12 @@ button[role='tab'] { ...@@ -528,12 +549,12 @@ button[role='tab'] {
/* 移动端目录下拉框（TOC Popover Trigger）：文本溢出省略号 */ /* 移动端目录下拉框（TOC Popover Trigger）：文本溢出省略号 */
@media (max-width: 767px) { @media (max-width: 767px) {
button[class*="tocnav"] { button[class*='tocnav'] {
max-width: 100vw; max-width: 100vw;
overflow: hidden; overflow: hidden;
} }
button[class*="tocnav"] > span.grid { button[class*='tocnav'] > span.grid {
overflow: hidden; overflow: hidden;
min-width: 0; min-width: 0;
} }
......
document/app/robots.txt/route.ts 0 → 100644
import { NextResponse } from 'next/server';
export const dynamic = 'force-static';
export function GET() {
const homeDomain = process.env.FASTGPT_HOME_DOMAIN ?? 'https://fastgpt.io';
const domain = homeDomain.replace('https://', 'https://doc.');
const isCN = homeDomain.includes('.cn');
let content: string;
if (isCN) {
content = `User-Agent: Googlebot
Disallow: /
User-Agent: *
Allow: /
Host: ${domain}
Sitemap: ${domain}/sitemap.xml
`;
} else {
content = `User-Agent: bingbot
Disallow: /
User-Agent: *
Allow: /
Sitemap: ${domain}/sitemap.xml
`;
}
return new NextResponse(content, {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }
});
}
document/app/sitemap.xml/route.ts 0 → 100644
import { source } from '@/lib/source';
import { NextResponse } from 'next/server';
import docLastModifiedData from '@/data/doc-last-modified.json';
export const dynamic = 'force-static';
export function GET() {
const homeDomain = process.env.FASTGPT_HOME_DOMAIN ?? 'https://fastgpt.io';
const domain = homeDomain.replace('https://', 'https://doc.');
const pages = source.getPages();
const urlEntries = pages
.map((page) => {
const filePath = `document/content/docs/${page.file.path}`;
// @ts-ignore
const lastModified = docLastModifiedData[filePath] || page.data.lastModified;
return ` <url>
<loc>${domain}${page.url}</loc>${lastModified ? `
<lastmod>${lastModified}</lastmod>` : ''}
</url>`;
})
.join('\n');
const xml = `<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
${urlEntries}
</urlset>`;
return new NextResponse(xml, {
headers: { 'Content-Type': 'application/xml; charset=utf-8' }
});
}
document/components/sideBar.tsx
'use client'; 'use client';
import { usePathname } from 'next/navigation'; import { usePathname } from 'next/navigation';
import { useEffect, type FC, type ReactNode } from 'react'; import { createContext, useContext, useEffect, type FC, type ReactNode } from 'react';
import { import {
SidebarItem, SidebarItem,
SidebarFolder, SidebarFolder,
...@@ -11,6 +11,8 @@ import { ...@@ -11,6 +11,8 @@ import {
import { type SidebarComponents } from 'fumadocs-ui/components/layout/sidebar'; import { type SidebarComponents } from 'fumadocs-ui/components/layout/sidebar';
import { type PageTree } from 'fumadocs-core/server'; import { type PageTree } from 'fumadocs-core/server';
const NestingLevelContext = createContext(0);
const isInFolder = (folder: PageTree.Folder, pathname: string): boolean => { const isInFolder = (folder: PageTree.Folder, pathname: string): boolean => {
const check = (item: PageTree.Item | PageTree.Folder): boolean => { const check = (item: PageTree.Item | PageTree.Folder): boolean => {
if ('children' in item) { if ('children' in item) {
...@@ -61,18 +63,27 @@ const CustomFolder: FC<{ item: PageTree.Folder; level: number; children: ReactNo ...@@ -61,18 +63,27 @@ const CustomFolder: FC<{ item: PageTree.Folder; level: number; children: ReactNo
const shouldExpand = isInFolder(item, pathname); const shouldExpand = isInFolder(item, pathname);
return ( return (
<NestingLevelContext.Provider value={level + 1}>
<SidebarFolder defaultOpen={shouldExpand} className="bg-blue hover:cursor-pointer"> <SidebarFolder defaultOpen={shouldExpand} className="bg-blue hover:cursor-pointer">
<SidebarFolderTrigger className="hover:cursor-pointer">{item.name}</SidebarFolderTrigger> <SidebarFolderTrigger className="hover:cursor-pointer">{item.name}</SidebarFolderTrigger>
<SidebarFolderContent className="bg-blue hover:cursor-pointer"> <SidebarFolderContent className="bg-blue hover:cursor-pointer">
{children} {children}
</SidebarFolderContent> </SidebarFolderContent>
</SidebarFolder> </SidebarFolder>
</NestingLevelContext.Provider>
); );
}; };
const CustomSeparator: FC<{ item: PageTree.Separator }> = ({ item }) => ( const CustomSeparator: FC<{ item: PageTree.Separator }> = ({ item }) => {
<div className="text-sm font-semibold px-2 py-1.5 mt-1 mb-1 first:mt-0">{item.name}</div> const level = useContext(NestingLevelContext);
); return (
<div
className={`text-sm font-semibold ${level > 0 ? 'pl-6' : 'px-2'} pr-2 py-1.5 mt-1 mb-1 first:mt-0`}
>
{item.name}
</div>
);
};
export const CustomSidebarComponents: SidebarComponents = { export const CustomSidebarComponents: SidebarComponents = {
Item: CustomItem, Item: CustomItem,
......
document/content/docs/introduction/cloud/faq.en.mdx 0 → 100644
---
title: FAQ
description: FastGPT Cloud Service FAQ
---
## Does FastGPT Cloud Service support integrating your own models?
Currently, FastGPT Cloud Service does not support integrating your own models, only the unified models provided by the official are supported.
\ No newline at end of file
document/content/docs/introduction/cloud/faq.mdx 0 → 100644
---
title: 常见问题
description: FastGPT 云服务常见问题
---
## 是否支持接入自己的模型
目前 FastGPT 云服务暂不支持接入自己的模型，只能使用官方提供的统一模型。
\ No newline at end of file
document/content/docs/introduction/cloud.mdx → document/content/docs/introduction/cloud/intro.mdx
--- ---
title: FastGPT 云服务 title: 介绍
description: FastGPT 云服务 description: FastGPT 云服务介绍
--- ---
## 服务地址 ## 服务地址
......
document/content/docs/introduction/cloud/meta.en.json 0 → 100644
{
"title": "FastGPT Cloud",
"description": "FastGPT Cloud Service",
"icon": "🌐",
"pages": ["intro", "faq", "terms", "privacy"]
}
document/content/docs/introduction/cloud/meta.json 0 → 100644
{
"title": "FastGPT 云服务",
"description": "FastGPT 云服务",
"icon": "🌐",
"pages": ["intro", "faq", "terms", "privacy"]
}
document/content/docs/introduction/commercial.en.mdx
...@@ -36,7 +36,7 @@ FastGPT Commercial Edition is an enhanced version built on top of the Community ...@@ -36,7 +36,7 @@ FastGPT Commercial Edition is an enhanced version built on top of the Community
| Team spaces & permissions | ❌ | ✅ | ✅ | | Team spaces & permissions | ❌ | ✅ | ✅ |
| Admin dashboard | ❌ | ✅ | Not needed | | Admin dashboard | ❌ | ✅ | Not needed |
| SSO login | ❌ | ✅ | In design | | SSO login | ❌ | ✅ | In design |
| Commercial license | [View open source license](/docs/protocol/open-source) | Full | Full | | Commercial license | [View open source license](/docs/introduction/opensource/license) | Full | Full |
## Pricing ## Pricing
......
document/content/docs/introduction/commercial.mdx
...@@ -36,7 +36,7 @@ FastGPT 商业版是基于 FastGPT 社区版的增强版本，增加了一些独 ...@@ -36,7 +36,7 @@ FastGPT 商业版是基于 FastGPT 社区版的增强版本，增加了一些独
| 团队空间 & 权限 | ❌ | ✅ | ✅ | | 团队空间 & 权限 | ❌ | ✅ | ✅ |
| 管理后台 | ❌ | ✅ | 不需要 | | 管理后台 | ❌ | ✅ | 不需要 |
| SSO 登录 | ❌ | ✅ | 设计中 | | SSO 登录 | ❌ | ✅ | 设计中 |
| 商业授权 | [查看开源协议](/docs/protocol/open-source) | 完整 | 完整 | | 商业授权 | [查看开源协议](/docs/introduction/opensource/license) | 完整 | 完整 |
## 商业版软件价格 ## 商业版软件价格
......
document/content/docs/introduction/development/custom-models/meta.en.json deleted 100644 → 0
{
"title": "Local Model Usage",
"pages": [
"marker",
"mineru",
"xinference",
"bge-rerank",
"chatglm2",
"m3e",
"chatglm2-m3e",
"ollama"
]
}
document/content/docs/introduction/development/design/meta.en.json deleted 100644 → 0
{
"title": "Design Solutions",
"pages": [
"dataset",
"design_plugin"
]
}
document/content/docs/introduction/development/meta.en.json deleted 100644 → 0
{
"title": "Community Edition",
"description": "FastGPT Community Edition",
"icon": "🔧",
"pages": [
"sealos",
"docker",
"faq",
"intro",
"configuration",
"object-storage",
"signoz",
"modelConfig",
"custom-models",
"proxy",
"migration",
"design"
]
}
document/content/docs/introduction/development/meta.json deleted 100644 → 0
{
"title": "FastGPT 社区版",
"description": "FastGPT 社区版",
"icon": "🔧",
"pages": [
"sealos",
"docker",
"faq",
"intro",
"configuration",
"object-storage",
"signoz",
"modelConfig",
"custom-models",
"proxy",
"migration",
"design"
]
}
document/content/docs/introduction/development/modelConfig/meta.en.json deleted 100644 → 0
{
"title": "Model Configuration Solutions",
"pages": [
"ai-proxy",
"intro",
"one-api",
"siliconCloud",
"ppio"
]
}
document/content/docs/introduction/development/proxy/cloudflare.en.mdx deleted 100644 → 0
---
title: Cloudflare Worker Proxy
description: Use Cloudflare Worker as a Proxy
---
[Reference tutorial by "不做了睡觉"](https://gravel-twister-d32.notion.site/FastGPT-API-ba7bb261d5fd4fd9bbb2f0607dacdc9e)
**Workers configuration file**
```js
const TELEGRAPH_URL = 'https://api.openai.com';
addEventListener('fetch', (event) => {
event.respondWith(handleRequest(event.request));
});
async function handleRequest(request) {
// Security check
if (request.headers.get('auth') !== 'auth_code') {
return new Response('UnAuthorization', { status: 403 });
}
const url = new URL(request.url);
url.host = TELEGRAPH_URL.replace(/^https?:\/\//, '');
const modifiedRequest = new Request(url.toString(), {
headers: request.headers,
method: request.method,
body: request.body,
redirect: 'follow'
});
const response = await fetch(modifiedRequest);
const modifiedResponse = new Response(response.body, response);
// Add CORS headers
modifiedResponse.headers.set('Access-Control-Allow-Origin', '*');
return modifiedResponse;
}
```
**Update FastGPT environment variables**
> Don't forget to include v1!
```bash
OPENAI_BASE_URL=https://xxxxxx/v1
OPENAI_BASE_URL_AUTH=auth_code
```
document/content/docs/introduction/development/proxy/cloudflare.mdx deleted 100644 → 0
---
title: Cloudflare Worker 中转
description: 使用 Cloudflare Worker 实现中转
---
[参考 "不做了睡觉" 的教程](https://gravel-twister-d32.notion.site/FastGPT-API-ba7bb261d5fd4fd9bbb2f0607dacdc9e)
**workers 配置文件**
```js
const TELEGRAPH_URL = 'https://api.openai.com';
addEventListener('fetch', (event) => {
event.respondWith(handleRequest(event.request));
});
async function handleRequest(request) {
// 安全校验
if (request.headers.get('auth') !== 'auth_code') {
return new Response('UnAuthorization', { status: 403 });
}
const url = new URL(request.url);
url.host = TELEGRAPH_URL.replace(/^https?:\/\//, '');
const modifiedRequest = new Request(url.toString(), {
headers: request.headers,
method: request.method,
body: request.body,
redirect: 'follow'
});
const response = await fetch(modifiedRequest);
const modifiedResponse = new Response(response.body, response);
// 添加允许跨域访问的响应头
modifiedResponse.headers.set('Access-Control-Allow-Origin', '*');
return modifiedResponse;
}
```
**修改 FastGPT 的环境变量**
> 务必别忘了填 v1！
```bash
OPENAI_BASE_URL=https://xxxxxx/v1
OPENAI_BASE_URL_AUTH=auth_code
```
document/content/docs/introduction/development/proxy/http_proxy.en.mdx deleted 100644 → 0
---
title: HTTP Proxy
description: Use an HTTP Proxy for Routing
---
If you have a proxy tool (like [Clash](https://github.com/Dreamacro/clash) or [sing-box](https://github.com/SagerNet/sing-box)), you can use an HTTP proxy to access OpenAI. Just add these two environment variables:
```bash
AXIOS_PROXY_HOST=
AXIOS_PROXY_PORT=
```
Using Clash as an example, it's recommended to route only `api.openai.com` through the proxy and direct-connect everything else. Example configuration:
```yaml
mixed-port: 7890
allow-lan: false
bind-address: '*'
mode: rule
log-level: warning
dns:
enable: true
ipv6: false
nameserver:
- 8.8.8.8
- 8.8.4.4
cache-size: 400
proxies:
-
proxy-groups:
- { name: '♻️ Auto Select', type: url-test, proxies: [HK-V01×1.5], url: 'https://api.openai.com', interval: 3600}
rules:
- 'DOMAIN-SUFFIX,api.openai.com,♻️ Auto Select'
- 'MATCH,DIRECT'
```
Then add these two environment variables to FastGPT:
```bash
AXIOS_PROXY_HOST=127.0.0.1
AXIOS_PROXY_PORT=7890
```
document/content/docs/introduction/development/proxy/http_proxy.mdx deleted 100644 → 0
---
title: HTTP 代理中转
description: 使用 HTTP 代理实现中转
---
如果你有代理工具（例如 [Clash](https://github.com/Dreamacro/clash) 或者 [sing-box](https://github.com/SagerNet/sing-box)），也可以使用 HTTP 代理来访问 OpenAI。只需要添加以下两个环境变量即可：
```bash
AXIOS_PROXY_HOST=
AXIOS_PROXY_PORT=
```
以 Clash 为例，建议指定 `api.openai.com` 走代理，其他请求都直连。示例配置如下：
```yaml
mixed-port: 7890
allow-lan: false
bind-address: '*'
mode: rule
log-level: warning
dns:
enable: true
ipv6: false
nameserver:
- 8.8.8.8
- 8.8.4.4
cache-size: 400
proxies:
-
proxy-groups:
- { name: '♻️ 自动选择', type: url-test, proxies: [香港V01×1.5], url: 'https://api.openai.com', interval: 3600}
rules:
- 'DOMAIN-SUFFIX,api.openai.com,♻️ 自动选择'
- 'MATCH,DIRECT'
```
然后给 FastGPT 添加两个环境变量：
```bash
AXIOS_PROXY_HOST=127.0.0.1
AXIOS_PROXY_PORT=7890
```
document/content/docs/introduction/development/proxy/meta.en.json deleted 100644 → 0
{
"title": "Proxy Solutions",
"description": "FastGPT private deployment proxy solutions",
"pages": [
"nginx",
"http_proxy",
"cloudflare"
]
}
document/content/docs/introduction/development/proxy/meta.json deleted 100644 → 0
{
"title": "代理方案",
"description": "FastGPT 私有化部署代理方案",
"pages": ["nginx","http_proxy","cloudflare"]
}
\ No newline at end of file
document/content/docs/introduction/development/proxy/nginx.en.mdx deleted 100644 → 0
---
title: Nginx Proxy
description: Deploy Nginx on Sealos as a Proxy
---
## Log in to Sealos
[Sealos](https://cloud.sealos.io?uid=fnWRt09fZP)
## Create an Application
Open "App Launchpad" and click "New Application":
![](/imgs/sealos3.webp)
![](/imgs/sealos4.png)
### Fill in Basic Configuration
Make sure to enable external access and copy the provided external access address.
![](/imgs/sealos5.png)
### Add Configuration File
1. Copy the configuration below. Replace the content after `server_name` with the external access address from step 2.
```nginx
user nginx;
worker_processes auto;
worker_rlimit_nofile 51200;
events {
worker_connections 1024;
}
http {
resolver 8.8.8.8;
proxy_ssl_server_name on;
access_log off;
server_names_hash_bucket_size 512;
client_header_buffer_size 64k;
large_client_header_buffers 4 64k;
client_max_body_size 50M;
proxy_connect_timeout 240s;
proxy_read_timeout 240s;
proxy_buffer_size 128k;
proxy_buffers 4 256k;
server {
listen 80;
server_name tgohwtdlrmer.cloud.sealos.io; # Replace with the Sealos external address
location ~ /openai/(.*) {
proxy_pass https://api.openai.com/$1$is_args$args;
proxy_set_header Host api.openai.com;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
# For streaming responses
proxy_set_header Connection '';
proxy_http_version 1.1;
chunked_transfer_encoding off;
proxy_buffering off;
proxy_cache off;
# For regular responses
proxy_buffer_size 128k;
proxy_buffers 4 256k;
proxy_busy_buffers_size 256k;
}
}
}
```
2. Open Advanced Configuration.
3. Click "Add Config File".
4. File name: `/etc/nginx/nginx.conf`.
5. File value: the code you just copied.
6. Click Confirm.
![](/imgs/sealos6.png)
### Deploy the Application
After filling everything in, click "Deploy" in the upper right corner to complete deployment.
## Update FastGPT Environment Variables
1. Go to the deployed app's details and copy the external address.
> Note: This is an API address — opening it directly in a browser won't work. To verify, visit: `*.cloud.sealos.io/openai/api`. If you see `Invalid URL (GET /api)`, it's working correctly.
![](/imgs/sealos7.png)
2. Update the environment variable (this is FastGPT's environment variable, not Sealos'):
```bash
OPENAI_BASE_URL=https://tgohwtdlrmer.cloud.sealos.io/openai/v1
```
**Done!**
document/content/docs/introduction/development/proxy/nginx.mdx deleted 100644 → 0
---
title: Nginx 中转
description: 使用 Sealos 部署 Nginx 实现中转
---
## 登录 Sealos
[Sealos](https://cloud.sealos.io?uid=fnWRt09fZP)
## 创建应用
打开 「应用管理」，点击「新建应用」：
![](/imgs/sealos3.webp)
![](/imgs/sealos4.png)
### 填写基本配置
务必开启外网访问，复制外网访问提供的地址。
![](/imgs/sealos5.png)
### 添加配置文件
1. 复制下面这段配置文件，注意 `server_name` 后面的内容替换成第二步的外网访问地址。
```nginx
user nginx;
worker_processes auto;
worker_rlimit_nofile 51200;
events {
worker_connections 1024;
}
http {
resolver 8.8.8.8;
proxy_ssl_server_name on;
access_log off;
server_names_hash_bucket_size 512;
client_header_buffer_size 64k;
large_client_header_buffers 4 64k;
client_max_body_size 50M;
proxy_connect_timeout 240s;
proxy_read_timeout 240s;
proxy_buffer_size 128k;
proxy_buffers 4 256k;
server {
listen 80;
server_name tgohwtdlrmer.cloud.sealos.io; # 这个地方替换成 Sealos 提供的外网地址
location ~ /openai/(.*) {
proxy_pass https://api.openai.com/$1$is_args$args;
proxy_set_header Host api.openai.com;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
# 如果响应是流式的
proxy_set_header Connection '';
proxy_http_version 1.1;
chunked_transfer_encoding off;
proxy_buffering off;
proxy_cache off;
# 如果响应是一般的
proxy_buffer_size 128k;
proxy_buffers 4 256k;
proxy_busy_buffers_size 256k;
}
}
}
```
2. 点开高级配置。
3. 点击「新增配置文件」。
4. 文件名写: `/etc/nginx/nginx.conf`。
5. 文件值为刚刚复制的那段代码。
6. 点击确认。
![](/imgs/sealos6.png)
### 部署应用
填写完毕后，点击右上角的「部署」，即可完成部署。
## 修改 FastGPT 环境变量
1. 进入刚刚部署应用的详情，复制外网地址
> 注意：这是个 API 地址，点击打开是无效的。如需验证，可以访问: `*.cloud.sealos.io/openai/api`，如果提示 `Invalid URL (GET /api)` 则代表成功。
![](/imgs/sealos7.png)
2. 修改环境变量（是 FastGPT 的环境变量，不是 Sealos 的）：
```bash
OPENAI_BASE_URL=https://tgohwtdlrmer.cloud.sealos.io/openai/v1
```
**Done!**
document/content/docs/introduction/guide/dashboard/workflow/ai_chat.en.mdx
...@@ -17,7 +17,7 @@ import { Alert } from '@/components/docs/Alert'; ...@@ -17,7 +17,7 @@ import { Alert } from '@/components/docs/Alert';
## AI Model ## AI Model
Configure available chat models via [config.json](/docs/introduction/development/configuration/) and connect multiple models through [one-api](/docs/introduction/development/modelConfig/one-api). Configure available chat models via [config.json](/docs/self-host/config/model/intro)。
Click the AI model to configure its parameters. Click the AI model to configure its parameters.
......
document/content/docs/introduction/guide/dashboard/workflow/ai_chat.mdx
...@@ -17,7 +17,7 @@ import { Alert } from '@/components/docs/Alert'; ...@@ -17,7 +17,7 @@ import { Alert } from '@/components/docs/Alert';
## AI模型 ## AI模型
可以通过 [config.json](/docs/introduction/development/configuration/) 配置可选的对话模型，通过 [one-api](/docs/introduction/development/modelConfig/one-api) 来实现多模型接入。 可以通过 [config.json](/docs/self-host/config/model/intro) 配置可选的对话模型。
点击AI模型后，可以配置模型的相关参数。 点击AI模型后，可以配置模型的相关参数。
......
document/content/docs/introduction/guide/plugins/dev_system_tool.en.mdx
...@@ -322,7 +322,7 @@ Simple tools may not need E2E testing. For complex tools, the review team may re ...@@ -322,7 +322,7 @@ Simple tools may not need E2E testing. For complex tools, the review team may re
### 6.1 Deploy the E2E Test Environment ### 6.1 Deploy the E2E Test Environment
1. Follow [Quick Start Local Development](/docs/introduction/development/intro) to set up a local FastGPT development environment 1. Follow [Quick Start Local Development](/docs/self-host/dev) to set up a local FastGPT development environment
2. Run `cd runtime && cp .env.template .env.local` to copy the environment variable template, then connect to the Minio, Mongo, and Redis instances from step 1 2. Run `cd runtime && cp .env.template .env.local` to copy the environment variable template, then connect to the Minio, Mongo, and Redis instances from step 1
3. Run `bun run dev` to start the development environment, then update FastGPT's environment variables to connect to your fastgpt-plugin instance 3. Run `bun run dev` to start the development environment, then update FastGPT's environment variables to connect to your fastgpt-plugin instance
......
document/content/docs/introduction/guide/plugins/dev_system_tool.mdx
...@@ -323,7 +323,7 @@ FastGPT-plugin 使用 Vitest 作为单测框架。 ...@@ -323,7 +323,7 @@ FastGPT-plugin 使用 Vitest 作为单测框架。
### 6.1 部署 E2E 测试环境 ### 6.1 部署 E2E 测试环境
1. 参考 [快速开始本地开发](/docs/introduction/development/intro)，在本地部署一套 FastGPT 开发环境 1. 参考 [快速开始本地开发](/docs/self-host/dev)，在本地部署一套 FastGPT 开发环境
2. `cd runtime && cp .env.template .env.local` 复制环境变量样例文件，连接到上一步部署的 Minio, Mongo, Redis 中 2. `cd runtime && cp .env.template .env.local` 复制环境变量样例文件，连接到上一步部署的 Minio, Mongo, Redis 中
3. `bun run dev` 运行开发环境，修改 FastGPT 的环境变量，连接到你刚刚启动的 fastgpt-plugin 3. `bun run dev` 运行开发环境，修改 FastGPT 的环境变量，连接到你刚刚启动的 fastgpt-plugin
......
document/content/docs/introduction/meta.en.json
{ {
"title": "Documentation", "title": "User Guide",
"root": true, "root": true,
"pages": [ "pages": [
"---Getting Started---", "---Tutorials---",
"index", "index",
"...guide",
"---Editions---",
"cloud", "cloud",
"commercial", "commercial",
"development", "opensource"
"---Features---",
"...guide"
], ],
"order": 1 "order": 1
} }
document/content/docs/introduction/meta.json
...@@ -2,13 +2,13 @@ ...@@ -2,13 +2,13 @@
"title": "使用文档", "title": "使用文档",
"root": true, "root": true,
"pages": [ "pages": [
"---入门---", "---教程---",
"index", "index",
"...guide",
"---版本介绍---",
"cloud", "cloud",
"commercial", "commercial",
"development", "opensource"
"---功能介绍---",
"...guide"
], ],
"order": 1 "order": 1
} }
document/content/docs/introduction/opensource/intro.en.mdx 0 → 100644
---
title: Introduction
description: FastGPT Community Edition Introduction
---
FastGPT Community Edition is the free version of FastGPT, designed for individual developers and small delivery teams. It includes all core FastGPT features: Agent building, workflows, and knowledge bases. Please use it in compliance with the [FastGPT Open Source License](/docs/introduction/opensource/license).
**Related Links**
* [GitHub Repository](https://github.com/labring/FastGPT)
* [Deployment Guide](https://doc.fastgpt.io/docs/self-host/intro/)
* [Local Development Guide](https://doc.fastgpt.io/docs/self-host/intro/)
\ No newline at end of file
document/content/docs/introduction/opensource/intro.mdx 0 → 100644
---
title: 介绍
description: FastGPT 社区版介绍
---
FastGPT 社区版是 FastGPT 的免费版本，适合于个人开发者或小型交付团队使用。包含了 FastGPT 所有核心功能：Agent 构建、工作流、知识库，请在遵守[FastGPT 开源协议](/docs/introduction/opensource/license)的前提下使用。
**相关链接**
* [GitHub 仓库](https://github.com/labring/FastGPT)
* [部署教程](https://doc.fastgpt.io/docs/self-host/intro/)
* [本地开发介绍](https://doc.fastgpt.io/docs/self-host/intro/)
\ No newline at end of file
document/content/docs/introduction/opensource/meta.en.json 0 → 100644
{
"title": "FastGPT Community Edition",
"description": "FastGPT Community Edition",
"icon": "🔧",
"pages": ["intro", "license"]
}
document/content/docs/introduction/opensource/meta.json 0 → 100644
{
"title": "FastGPT 社区版",
"description": "FastGPT 社区版",
"icon": "🔧",
"pages": ["intro", "license"]
}
document/content/docs/protocol/meta.en.json deleted 100644 → 0
{
"title": "Legal",
"root": true,
"description": "Legal",
"pages": [
"open-source",
"terms",
"privacy"
],
"order": 3
}
document/content/docs/protocol/meta.json deleted 100644 → 0
{
"title": "协议",
"root": true,
"description": "协议",
"pages": ["open-source", "terms", "privacy"],
"order": 3
}
document/content/docs/introduction/development/configuration.en.mdx → document/content/docs/self-host/config/json.en.mdx
...@@ -3,7 +3,7 @@ title: Configuration File Guide ...@@ -3,7 +3,7 @@ title: Configuration File Guide
description: FastGPT configuration parameters explained description: FastGPT configuration parameters explained
--- ---
Since environment variables aren't ideal for complex configurations, newer versions of FastGPT use ConfigMap-style mounted configuration files. You can find the default config at `projects/app/data/config.json`. See the [Docker Compose deployment guide](/docs/introduction/development/docker/) for how to mount the config file. Since environment variables aren't ideal for complex configurations, newer versions of FastGPT use ConfigMap-style mounted configuration files. You can find the default config at `projects/app/data/config.json`. See the [Docker Compose deployment guide](/docs/self-host/deploy/docker/) for how to mount the config file.
**In development**, copy the example config `config.json` to `config.local.json` for it to take effect. **In development**, copy the example config `config.json` to `config.local.json` for it to take effect.
...@@ -70,4 +70,4 @@ When importing data to your knowledge base or configuring file uploads in your a ...@@ -70,4 +70,4 @@ When importing data to your knowledge base or configuring file uploads in your a
### Using Marker for PDF Parsing ### Using Marker for PDF Parsing
[View the Marker integration tutorial](/docs/introduction/development/custom-models/marker) [View the Marker integration tutorial](/docs/self-host/custom-models/marker)
document/content/docs/introduction/development/configuration.mdx → document/content/docs/self-host/config/json.mdx
--- ---
title: 配置文件介绍 title: config.json 文件配置
description: FastGPT 配置参数介绍 description: FastGPT config.json 文件配置
--- ---
由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 `projects/app/data/config.json` 看到默认的配置文件。可以参考 [docker-compose 快速部署](/docs/introduction/development/docker/) 来挂载配置文件。 **该配置仅适用于社区版，商业版用户该配置已集成至后台。**
由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 `projects/app/data/config.json` 看到默认的配置文件。可以参考 [docker-compose 快速部署](/docs/self-host/deploy/docker/) 来挂载配置文件。
**开发环境下**，你需要将示例配置文件 `config.json` 复制成 `config.local.json` 文件才会生效。 **开发环境下**，你需要将示例配置文件 `config.json` 复制成 `config.local.json` 文件才会生效。
...@@ -70,4 +72,4 @@ description: FastGPT 配置参数介绍 ...@@ -70,4 +72,4 @@ description: FastGPT 配置参数介绍
### 使用 Marker 解析 PDF 文件 ### 使用 Marker 解析 PDF 文件
[点击查看 Marker 接入教程](/docs/introduction/development/custom-models/marker) [点击查看 Marker 接入教程](/docs/self-host/custom-models/marker)
document/content/docs/introduction/development/modelConfig/ai-proxy.en.mdx → document/content/docs/self-host/config/model/ai-proxy.en.mdx
...@@ -47,7 +47,7 @@ Using Alibaba Cloud models as an example: ...@@ -47,7 +47,7 @@ Using Alibaba Cloud models as an example:
1. Channel Name: The display name for the channel, used for identification only; 1. Channel Name: The display name for the channel, used for identification only;
2. Provider: The provider corresponding to the model. Different providers have different default addresses and API key formats; 2. Provider: The provider corresponding to the model. Different providers have different default addresses and API key formats;
3. Models: The specific models available for this channel. The system includes mainstream models by default. If the desired option is not in the dropdown, click "Add Model" to [add a custom model](/docs/introduction/development/modelconfig/intro/#add-custom-models); 3. Models: The specific models available for this channel. The system includes mainstream models by default. If the desired option is not in the dropdown, click "Add Model" to [add a custom model](/docs/self-host/config/model/intro/#add-custom-models);
4. Model Mapping: Map the model requested by FastGPT to the actual model provided. For example: 4. Model Mapping: Map the model requested by FastGPT to the actual model provided. For example:
```json ```json
...@@ -81,7 +81,7 @@ After the test completes, the results and request duration for each model will b ...@@ -81,7 +81,7 @@ After the test completes, the results and request duration for each model will b
### 3. Enable Models ### 3. Enable Models
Finally, in `Model Configuration`, you can enable the corresponding models to use them on the platform. For more model configuration details, see [Model Configuration](/docs/introduction/development/modelconfig/intro). Finally, in `Model Configuration`, you can enable the corresponding models to use them on the platform. For more model configuration details, see [Model Configuration](/docs/self-host/config/model/intro).
![aiproxy8](/imgs/aiproxy-8.png) ![aiproxy8](/imgs/aiproxy-8.png)
......
document/content/docs/introduction/development/modelConfig/ai-proxy.mdx → document/content/docs/self-host/config/model/ai-proxy.mdx
...@@ -47,7 +47,7 @@ AI proxy 相关功能，可以在`账号-模型提供商`页面找到。 ...@@ -47,7 +47,7 @@ AI proxy 相关功能，可以在`账号-模型提供商`页面找到。
1. 渠道名：展示在外部的渠道名称，仅作标识; 1. 渠道名：展示在外部的渠道名称，仅作标识;
2. 厂商：模型对应的厂商，不同厂商对应不同的默认地址和 API 密钥格式; 2. 厂商：模型对应的厂商，不同厂商对应不同的默认地址和 API 密钥格式;
3. 模型：当前渠道具体可以使用的模型，系统内置了主流的一些模型，如果下拉框中没有想要的选项，可以点击“新增模型”，[增加自定义模型](/docs/introduction/development/modelconfig/intro/#新增自定义模型); 3. 模型：当前渠道具体可以使用的模型，系统内置了主流的一些模型，如果下拉框中没有想要的选项，可以点击“新增模型”，[增加自定义模型](/docs/self-host/config/model/intro/#新增自定义模型);
4. 模型映射：将 FastGPT 请求的模型，映射到具体提供的模型上。例如： 4. 模型映射：将 FastGPT 请求的模型，映射到具体提供的模型上。例如：
```json ```json
...@@ -81,7 +81,7 @@ FatGPT 中的模型为 `gpt-4o-test`，向 AI Proxy 发起请求时也是 `gpt-4 ...@@ -81,7 +81,7 @@ FatGPT 中的模型为 `gpt-4o-test`，向 AI Proxy 发起请求时也是 `gpt-4
### 3. 启用模型 ### 3. 启用模型
最后在`模型配置`中，可以选择启用对应的模型，这样就能在平台中使用了，更多模型配置可以参考[模型配置](/docs/introduction/development/modelconfig/intro) 最后在`模型配置`中，可以选择启用对应的模型，这样就能在平台中使用了，更多模型配置可以参考[模型配置](/docs/self-host/config/model/intro)
![aiproxy8](/imgs/aiproxy-8.png) ![aiproxy8](/imgs/aiproxy-8.png)
......
document/content/docs/introduction/development/modelConfig/intro.en.mdx → document/content/docs/self-host/config/model/intro.en.mdx
...@@ -15,11 +15,11 @@ Starting from version 4.8.20, you can configure models directly in the FastGPT U ...@@ -15,11 +15,11 @@ Starting from version 4.8.20, you can configure models directly in the FastGPT U
#### AI Proxy #### AI Proxy
Starting from version 4.8.23, FastGPT supports configuring model providers directly in the UI using [AI Proxy](/docs/introduction/development/modelconfig/ai-proxy) for model aggregation, enabling connections to more providers. Starting from version 4.8.23, FastGPT supports configuring model providers directly in the UI using [AI Proxy](/docs/self-host/config/model/ai-proxy) for model aggregation, enabling connections to more providers.
#### One API #### One API
You can also use the [OneAPI Integration Guide](/docs/introduction/development/modelconfig/one-api). You'll need to apply for API access from each provider and add them to OneAPI before using them in FastGPT. Example flow: You can also use the [OneAPI Integration Guide](/docs/self-host/config/model/one-api). You'll need to apply for API access from each provider and add them to OneAPI before using them in FastGPT. Example flow:
![alt text](/imgs/image-95.png) ![alt text](/imgs/image-95.png)
...@@ -223,7 +223,7 @@ A free `bge-reranker-v2-m3` model is available. ...@@ -223,7 +223,7 @@ A free `bge-reranker-v2-m3` model is available.
#### Self-Hosted Rerank Models #### Self-Hosted Rerank Models
[View the ReRank model deployment tutorial](/docs/introduction/development/custom-models/bge-rerank/) [View the ReRank model deployment tutorial](/docs/self-host/custom-models/bge-rerank/)
### Integrating Speech Recognition Models ### Integrating Speech Recognition Models
...@@ -253,7 +253,7 @@ The custom request key is sent as a request header: `Authorization: Bearer xxx`. ...@@ -253,7 +253,7 @@ The custom request key is sent as a request header: `Authorization: Bearer xxx`.
All interfaces follow OpenAI's model format. See the [OpenAI API documentation](https://platform.openai.com/docs/api-reference/introduction) for details. All interfaces follow OpenAI's model format. See the [OpenAI API documentation](https://platform.openai.com/docs/api-reference/introduction) for details.
Since OpenAI doesn't provide a ReRank model, the Cohere format is used instead. [View request examples](/docs/introduction/development/faq/#how-to-check-model-issues) Since OpenAI doesn't provide a ReRank model, the Cohere format is used instead. [View request examples](/docs/self-host/faq/#how-to-check-model-issues)
### Model Pricing Configuration ### Model Pricing Configuration
...@@ -276,13 +276,13 @@ To add a model provider, modify the following: ...@@ -276,13 +276,13 @@ To add a model provider, modify the following:
### Adding Models ### Adding Models
In the `FastGPT-plugin` project, find the corresponding provider's config file under the `modules/model/provider` directory and add the model configuration. Make sure the `model` field is unique across all models. For field descriptions, see [Model Configuration Field Descriptions](/docs/introduction/development/modelconfig/intro/#configuration-via-config-file). In the `FastGPT-plugin` project, find the corresponding provider's config file under the `modules/model/provider` directory and add the model configuration. Make sure the `model` field is unique across all models. For field descriptions, see [Model Configuration Field Descriptions](/docs/self-host/config/model/intro/#configuration-via-config-file).
## Legacy Model Configuration ## Legacy Model Configuration
After configuring OneAPI, you need to manually add model configuration to the `config.json` file and restart. After configuring OneAPI, you need to manually add model configuration to the `config.json` file and restart.
Since environment variables aren't ideal for complex configuration, FastGPT uses ConfigMap to mount config files. You can find the default config file at `projects/app/data/config.json`. See [docker-compose Quick Deployment](/docs/introduction/development/docker/) for how to mount config files. Since environment variables aren't ideal for complex configuration, FastGPT uses ConfigMap to mount config files. You can find the default config file at `projects/app/data/config.json`. See [docker-compose Quick Deployment](/docs/self-host/deploy/docker/) for how to mount config files.
**In development**, copy the example config file `config.json` to `config.local.json` for it to take effect. **In development**, copy the example config file `config.json` to `config.local.json` for it to take effect.
**In Docker deployment**, modifying `config.json` requires restarting the container. **In Docker deployment**, modifying `config.json` requires restarting the container.
......
document/content/docs/introduction/development/modelConfig/intro.mdx → document/content/docs/self-host/config/model/intro.mdx
...@@ -15,11 +15,11 @@ import { Alert } from '@/components/docs/Alert'; ...@@ -15,11 +15,11 @@ import { Alert } from '@/components/docs/Alert';
#### AI Proxy #### AI Proxy
从 4.8.23 版本开始， FastGPT 支持在页面上配置模型提供商，即使用 [AI Proxy 接入教程](/docs/introduction/development/modelconfig/ai-proxy) 来进行模型聚合，从而可以对接更多模型提供商。 从 4.8.23 版本开始， FastGPT 支持在页面上配置模型提供商，即使用 [AI Proxy 接入教程](/docs/self-host/config/model/ai-proxy) 来进行模型聚合，从而可以对接更多模型提供商。
#### One API #### One API
也可以使用 [OneAPI 接入教程](/docs/introduction/development/modelconfig/one-api)。你需要先在各服务商申请好 API 接入 OneAPI 后，才能在 FastGPT 中使用这些模型。示例流程如下： 也可以使用 [OneAPI 接入教程](/docs/self-host/config/model/one-api)。你需要先在各服务商申请好 API 接入 OneAPI 后，才能在 FastGPT 中使用这些模型。示例流程如下：
![alt text](/imgs/image-95.png) ![alt text](/imgs/image-95.png)
...@@ -223,7 +223,7 @@ FastGPT 页面上提供了每类模型的简单测试，可以初步检查模型 ...@@ -223,7 +223,7 @@ FastGPT 页面上提供了每类模型的简单测试，可以初步检查模型
#### 私有部署模型 #### 私有部署模型
[点击查看部署 ReRank 模型教程](/docs/introduction/development/custom-models/bge-rerank/) [点击查看部署 ReRank 模型教程](/docs/self-host/custom-models/bge-rerank/)
### 接入语音识别模型 ### 接入语音识别模型
...@@ -253,7 +253,7 @@ OneAPI 的语言识别接口，无法正确的识别其他模型（会始终识 ...@@ -253,7 +253,7 @@ OneAPI 的语言识别接口，无法正确的识别其他模型（会始终识
所有接口均遵循 OpenAI 提供的模型格式，可参考 [OpenAI API 文档](https://platform.openai.com/docs/api-reference/introduction) 进行配置。 所有接口均遵循 OpenAI 提供的模型格式，可参考 [OpenAI API 文档](https://platform.openai.com/docs/api-reference/introduction) 进行配置。
由于 OpenAI 没有提供 ReRank 模型，遵循的是 Cohere 的格式。[点击查看接口请求示例](/docs/introduction/development/faq/#如何检查模型问题) 由于 OpenAI 没有提供 ReRank 模型，遵循的是 Cohere 的格式。[点击查看接口请求示例](/docs/self-host/faq/#如何检查模型问题)
### 模型价格配置 ### 模型价格配置
...@@ -276,13 +276,13 @@ OneAPI 的语言识别接口，无法正确的识别其他模型（会始终识 ...@@ -276,13 +276,13 @@ OneAPI 的语言识别接口，无法正确的识别其他模型（会始终识
### 添加模型 ### 添加模型
你可以在`FastGPT-plugin`项目中`modules/model/provider`目录下，找对应模型提供商的配置文件，并追加模型配置。请自行全文检查，`model`字段，必须在所有模型中唯一。具体配置字段说明，参考[模型配置字段说明](/docs/introduction/development/modelconfig/intro/#通过配置文件配置) 你可以在`FastGPT-plugin`项目中`modules/model/provider`目录下，找对应模型提供商的配置文件，并追加模型配置。请自行全文检查，`model`字段，必须在所有模型中唯一。具体配置字段说明，参考[模型配置字段说明](/docs/self-host/config/model/intro/#通过配置文件配置)
## 旧版模型配置说明 ## 旧版模型配置说明
配置好 OneAPI 后，需要在`config.json`文件中，手动的增加模型配置，并重启。 配置好 OneAPI 后，需要在`config.json`文件中，手动的增加模型配置，并重启。
由于环境变量不利于配置复杂的内容，FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 `projects/app/data/config.json` 看到默认的配置文件。可以参考 [docker-compose 快速部署](/docs/introduction/development/docker/) 来挂载配置文件。 由于环境变量不利于配置复杂的内容，FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 `projects/app/data/config.json` 看到默认的配置文件。可以参考 [docker-compose 快速部署](/docs/self-host/deploy/docker/) 来挂载配置文件。
**开发环境下**，你需要将示例配置文件 `config.json` 复制成 `config.local.json` 文件才会生效。 **开发环境下**，你需要将示例配置文件 `config.json` 复制成 `config.local.json` 文件才会生效。
**Docker部署**，修改`config.json` 文件，需要重启容器。 **Docker部署**，修改`config.json` 文件，需要重启容器。
......
document/content/docs/self-host/config/model/meta.en.json 0 → 100644
{
"title": "Model Configuration",
"pages": ["intro", "ai-proxy", "one-api", "siliconCloud", "ppio"]
}
document/content/docs/introduction/development/modelConfig/meta.json → document/content/docs/self-host/config/model/meta.json
{ {
"title": "模型配置方案", "title": "模型配置方案",
"pages": ["ai-proxy","intro","one-api","siliconCloud","ppio"] "pages": ["intro", "ai-proxy", "one-api", "siliconCloud", "ppio"]
} }
document/content/docs/introduction/development/modelConfig/ppio.en.mdx → document/content/docs/self-host/config/model/ppio.en.mdx
...@@ -65,7 +65,7 @@ For other model IDs, max context, and pricing, see: [Model List](https://ppinfra ...@@ -65,7 +65,7 @@ For other model IDs, max context, and pricing, see: [Model List](https://ppinfra
## 2. Deploy the Latest FastGPT to Your Local Environment ## 2. Deploy the Latest FastGPT to Your Local Environment
<Alert context="warning"> <Alert context="warning">
Please use version v4.8.22 or above. Deployment reference: [Deploy FastGPT](/docs/introduction/development/intro/) Please use version v4.8.22 or above. Deployment reference: [Deploy FastGPT](/docs/self-host/dev/)
</Alert> </Alert>
## 3. Model Configuration (Choose One of the Two Methods Below) ## 3. Model Configuration (Choose One of the Two Methods Below)
......
document/content/docs/introduction/development/modelConfig/ppio.mdx → document/content/docs/self-host/config/model/ppio.mdx
...@@ -66,7 +66,7 @@ deepseek 系列： ...@@ -66,7 +66,7 @@ deepseek 系列：
## 2. 部署最新版 FastGPT 到本地环境 ## 2. 部署最新版 FastGPT 到本地环境
<Alert context="warning"> <Alert context="warning">
请使用 v4.8.22 以上版本，部署参考: [部署 FastGPT](/docs/introduction/development/intro/) 请使用 v4.8.22 以上版本，部署参考: [部署 FastGPT](/docs/self-host/dev/)
</Alert> </Alert>
## 3. 模型配置（下面两种方式二选其一） ## 3. 模型配置（下面两种方式二选其一）
......
document/content/docs/introduction/development/modelConfig/siliconCloud.en.mdx → document/content/docs/self-host/config/model/siliconCloud.en.mdx
...@@ -5,7 +5,7 @@ description: Try Open Source Models with SiliconCloud ...@@ -5,7 +5,7 @@ description: Try Open Source Models with SiliconCloud
[SiliconCloud](https://cloud.siliconflow.cn/i/TR9Ym0c4) is a platform focused on providing open source model inference, with its own acceleration engine. It helps users test and use open source models quickly at low cost. In our experience, their models offer solid speed and stability, with a wide variety covering language, embedding, reranking, TTS, STT, image generation, and video generation models — meeting all model requirements in FastGPT. [SiliconCloud](https://cloud.siliconflow.cn/i/TR9Ym0c4) is a platform focused on providing open source model inference, with its own acceleration engine. It helps users test and use open source models quickly at low cost. In our experience, their models offer solid speed and stability, with a wide variety covering language, embedding, reranking, TTS, STT, image generation, and video generation models — meeting all model requirements in FastGPT.
If you want to use SiliconCloud for only some models, see [OneAPI Integration with SiliconCloud](/docs/introduction/development/modelconfig/one-api/#siliconcloud--open-source-model-collection). If you want to use SiliconCloud for only some models, see [OneAPI Integration with SiliconCloud](/docs/self-host/config/model/one-api/#siliconcloud--open-source-model-collection).
This guide covers deploying FastGPT entirely with SiliconCloud models. This guide covers deploying FastGPT entirely with SiliconCloud models.
......
document/content/docs/introduction/development/modelConfig/siliconCloud.mdx → document/content/docs/self-host/config/model/siliconCloud.mdx
...@@ -5,7 +5,7 @@ description: 通过 SiliconCloud 体验开源模型 ...@@ -5,7 +5,7 @@ description: 通过 SiliconCloud 体验开源模型
[SiliconCloud(硅基流动)](https://cloud.siliconflow.cn/i/TR9Ym0c4) 是一个以提供开源模型调用为主的平台，并拥有自己的加速引擎。帮助用户低成本、快速的进行开源模型的测试和使用。实际体验下来，他们家模型的速度和稳定性都非常不错，并且种类丰富，覆盖语言、向量、重排、TTS、STT、绘图、视频生成模型，可以满足 FastGPT 中所有模型需求。 [SiliconCloud(硅基流动)](https://cloud.siliconflow.cn/i/TR9Ym0c4) 是一个以提供开源模型调用为主的平台，并拥有自己的加速引擎。帮助用户低成本、快速的进行开源模型的测试和使用。实际体验下来，他们家模型的速度和稳定性都非常不错，并且种类丰富，覆盖语言、向量、重排、TTS、STT、绘图、视频生成模型，可以满足 FastGPT 中所有模型需求。
如果你想部分模型使用 SiliconCloud 的模型，可额外参考[OneAPI接入硅基流动](/docs/introduction/development/modelconfig/one-api/#硅基流动--开源模型大合集)。 如果你想部分模型使用 SiliconCloud 的模型，可额外参考[OneAPI接入硅基流动](/docs/self-host/config/model/one-api/#硅基流动--开源模型大合集)。
本文会介绍完全使用 SiliconCloud 模型来部署 FastGPT 的方案。 本文会介绍完全使用 SiliconCloud 模型来部署 FastGPT 的方案。
......
document/content/docs/introduction/development/object-storage.en.mdx → document/content/docs/self-host/config/object-storage.en.mdx
--- ---
title: Object Storage Configuration & Common Issues title: Object Storage Configuration
description: How to configure and connect to various object storage providers via environment variables, and common configuration issues description: How to configure and connect to various object storage providers via environment variables, and common configuration issues
--- ---
......
document/content/docs/introduction/development/object-storage.mdx → document/content/docs/self-host/config/object-storage.mdx
--- ---
title: 对象存储配置及常见问题 title: 对象存储配置
description: 如何通过环境变量配置并连接个各厂商的对象存储，以及常见的配置问题 description: 如何通过环境变量配置并连接个各厂商的对象存储
--- ---
import { Alert } from '@/components/docs/Alert'; import { Alert } from '@/components/docs/Alert';
......
document/content/docs/introduction/development/signoz.mdx → document/content/docs/self-host/config/signoz.mdx
--- ---
title: 接入 Signoz 服务监控 title: Signoz 监控服务
description: FastGPT 接入 Signoz 服务监控 description: FastGPT 接入 Signoz 监控服务
--- ---
## 介绍 ## 介绍
......
document/content/docs/introduction/development/custom-models/chatglm2-m3e.en.mdx → document/content/docs/self-host/custom-models/chatglm2-m3e.en.mdx
...@@ -21,7 +21,7 @@ You can also set it via the environment variable: sk-key. Refer to Docker docume ...@@ -21,7 +21,7 @@ You can also set it via the environment variable: sk-key. Refer to Docker docume
## Connect to OneAPI ## Connect to OneAPI
Documentation: [One API](/docs/introduction/development/modelconfig/one-api/) Documentation: [One API](/docs/self-host/config/model/one-api/)
Add a channel for chatglm2 and m3e-large respectively, with the following parameters: Add a channel for chatglm2 and m3e-large respectively, with the following parameters:
......
document/content/docs/introduction/development/custom-models/chatglm2-m3e.mdx → document/content/docs/self-host/custom-models/chatglm2-m3e.mdx
...@@ -21,7 +21,7 @@ FastGPT 默认使用了 OpenAI 的 LLM 模型和向量模型，如果想要私 ...@@ -21,7 +21,7 @@ FastGPT 默认使用了 OpenAI 的 LLM 模型和向量模型，如果想要私
## 接入 OneAPI ## 接入 OneAPI
文档链接：[One API](/docs/introduction/development/modelconfig/one-api/) 文档链接：[One API](/docs/self-host/config/model/one-api/)
为 chatglm2 和 m3e-large 各添加一个渠道，参数如下： 为 chatglm2 和 m3e-large 各添加一个渠道，参数如下：
......
document/content/docs/self-host/custom-models/meta.en.json 0 → 100644
{
"title": "Local Models",
"pages": ["marker","mineru","xinference","bge-rerank","chatglm2","m3e","chatglm2-m3e","ollama"]
}
document/content/docs/introduction/development/custom-models/ollama.en.mdx → document/content/docs/self-host/custom-models/ollama.en.mdx
...@@ -107,7 +107,7 @@ ollama ls ...@@ -107,7 +107,7 @@ ollama ls
### 2. AI Proxy Integration ### 2. AI Proxy Integration
If you're using FastGPT's default configuration from [here](/docs/introduction/development/docker.md), AI Proxy is enabled by default. If you're using FastGPT's default configuration from [here](/docs/self-host/deploy/docker), AI Proxy is enabled by default.
![](/imgs/Ollama-aiproxy1.png) ![](/imgs/Ollama-aiproxy1.png)
...@@ -115,7 +115,7 @@ Make sure your FastGPT can access the Ollama container. If not, refer to the [in ...@@ -115,7 +115,7 @@ Make sure your FastGPT can access the Ollama container. If not, refer to the [in
![](/imgs/Ollama-aiproxy2.png) ![](/imgs/Ollama-aiproxy2.png)
In FastGPT, go to Account -> Model Providers -> Model Configuration -> Add Model. Make sure the model ID matches the model name in OneAPI. See details [here](/docs/introduction/development/modelConfig/intro.md). In FastGPT, go to Account -> Model Providers -> Model Configuration -> Add Model. Make sure the model ID matches the model name in OneAPI. See details [here](/docs/self-host/config/model/intro).
![](/imgs/Ollama-models2.png) ![](/imgs/Ollama-models2.png)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment