Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Doc: fix readme (#20663)

Jin Haibe46e6867a29
diff --git a/README.md b/README.md
index 5a0f2699f2..ae1979b808 100644
--- a/README.md
+++ b/README.md
@@ -126,13 +126,6 @@ releases! 🌟
- Gather more complete context through multiple rounds of retrieval and reasoning to help generate well-grounded answers.
- Choose Low, Medium, High, or Ultra thinking modes to control retrieval and reasoning depth according to question complexity.
-### ⚙️ **Go-native service architecture**
-
-- API, Admin, Ingestor, and Syncer are provided by a unified Go service.
-- DeepDoc runs within the Go process and handles layout analysis, OCR, and table recognition.
-- Go services use CGO to call native document parsing libraries and ONNX Runtime.
-- MCP and Sandbox Executor are optional capabilities that can be enabled as needed.
-
### 🌱 **Grounded citations with reduced hallucinations**
- Visualization of text chunking to allow human intervention.
@@ -165,7 +158,7 @@ releases! 🌟
- Docker >= 24.0.0 & Docker Compose >= v2.26.1
- [gVisor](https://gvisor.dev/docs/user_guide/install/): Required only when using the Self-Managed container Sandbox.
-Docker deployment does not require Go on the host. Self-Managed container Sandbox requires gVisor; other Sandbox providers do not require gVisor on the RAGFlow host.
+Docker deployment does not require Go compiler on the host. Self-Managed container Sandbox requires gVisor; other Sandbox providers do not require gVisor on the RAGFlow host.
> [!TIP]
> If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
diff --git a/README_ar.md b/README_ar.md
index 9c98af79f3..96aba074f3 100644
--- a/README_ar.md
+++ b/README_ar.md
@@ -133,11 +133,6 @@
- يحلل الأسئلة المعقدة، ويقسمها عند الحاجة، ويسترجع المعرفة ويتحقق من الأدلة عبر خطوات متعددة.
- تدعم أوضاع التفكير Low وMedium وHigh وUltra ضبط عمق الاسترجاع والاستدلال حسب تعقيد السؤال.
-### ⚙️ **بنية خدمات Go الأصلية**
-
-- توفر خدمة Go موحدة API وAdmin وIngestor وSyncer. يعمل DeepDoc داخل عملية Go لتحليل التخطيط وOCR والتعرف على الجداول.
-- تستدعي خدمات Go مكتبات تحليل المستندات الأصلية وONNX Runtime عبر CGO. ويمكن تفعيل MCP وSandbox Executor عند الحاجة.
-
### 🌱 **استشهادات مؤرضة لتقليل الهلوسة**
- تصور تقطيع النص للسماح بالتدخل البشري.
diff --git a/README_fr.md b/README_fr.md
index 5900e3c7db..e819bc12c7 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -129,11 +129,6 @@ Consultez les [notes de version complètes](./docs/release_notes.md) pour décou
- Le modèle analyse les questions complexes et peut les décomposer, rechercher des connaissances et vérifier les preuves en plusieurs étapes.
- Les modes Low, Medium, High et Ultra permettent de régler la profondeur de recherche et de raisonnement selon la complexité de la question.
-### ⚙️ **Architecture de services native Go**
-
-- Une implémentation Go unifiée fournit API, Admin, Ingestor et Syncer. DeepDoc s’exécute dans le processus Go pour l’analyse de mise en page, l’OCR et la reconnaissance des tableaux.
-- Les services Go appellent les bibliothèques natives d’analyse de documents et ONNX Runtime via CGO. MCP et Sandbox Executor sont activables à la demande.
-
### 🌱 **Citations fondées avec réduction des hallucinations**
- Visualisation du découpage de texte pour permettre une intervention humaine.
diff --git a/README_id.md b/README_id.md
index a5387d30da..2c52ab75f0 100644
--- a/README_id.md
+++ b/README_id.md
@@ -129,11 +129,6 @@ Lihat [catatan rilis lengkap](./docs/release_notes.md) untuk pembaruan lainnya.
- Model menganalisis pertanyaan kompleks dan bila perlu memecahnya, mencari pengetahuan, serta memverifikasi bukti melalui beberapa tahap.
- Mode Low, Medium, High, dan Ultra menyesuaikan kedalaman pencarian dan penalaran dengan kompleksitas pertanyaan.
-### ⚙️ **Arsitektur layanan native Go**
-
-- Satu layanan Go menyediakan API, Admin, Ingestor, dan Syncer. DeepDoc berjalan di dalam proses Go untuk analisis tata letak, OCR, dan pengenalan tabel.
-- Layanan Go memanggil pustaka pengurai dokumen native dan ONNX Runtime melalui CGO. MCP dan Sandbox Executor dapat diaktifkan sesuai kebutuhan.
-
### 🌱 **Referensi yang Didasarkan pada Data untuk Mengurangi Hallusinasi**
- Visualisasi pemotongan teks memungkinkan intervensi manusia.
diff --git a/README_ja.md b/README_ja.md
index a1ae328d0f..2c0f282daf 100644
--- a/README_ja.md
+++ b/README_ja.md
@@ -113,11 +113,6 @@
- 複雑な質問を分析し、必要に応じて分解、ナレッジ検索、根拠確認を複数段階で行います。
- Low、Medium、High、Ultra の思考モードで、質問の複雑さに応じて検索と推論の深さを調整できます。
-### ⚙️ **Go ネイティブサービスアーキテクチャ**
-
-- API、Admin、Ingestor、Syncer は統合された Go サービスが提供します。DeepDoc は Go プロセス内で動作し、レイアウト解析、OCR、表認識を担当します。
-- Go サービスは CGO 経由でネイティブ文書解析ライブラリと ONNX Runtime を呼び出します。MCP と Sandbox Executor は必要に応じて有効化できます。
-
### 🌱 **ハルシネーションが軽減された根拠のある引用**
- 可視化されたテキストチャンキング(text chunking)で人間の介入を可能にする。
diff --git a/README_ko.md b/README_ko.md
index fa22b04274..eb29ffc117 100644
--- a/README_ko.md
+++ b/README_ko.md
@@ -114,11 +114,6 @@
- 복잡한 질문을 분석하고 필요하면 여러 단계로 질문을 분해하고 지식을 검색하며 근거를 검증합니다.
- Low, Medium, High, Ultra 사고 모드로 질문 복잡도에 따라 검색 및 추론 깊이를 조절할 수 있습니다.
-### ⚙️ **Go 네이티브 서비스 아키텍처**
-
-- 통합 Go 서비스가 API, Admin, Ingestor, Syncer를 제공합니다. DeepDoc은 Go 프로세스 안에서 레이아웃 분석, OCR, 표 인식을 수행합니다.
-- Go 서비스는 CGO를 통해 네이티브 문서 파싱 라이브러리와 ONNX Runtime을 호출합니다. MCP와 Sandbox Executor는 필요할 때 활성화할 수 있습니다.
-
### 🌱 **할루시네이션을 줄인 신뢰할 수 있는 인용**
- 텍스트 청킹을 시각화하여 사용자가 개입할 수 있도록 합니다.
diff --git a/README_pt_br.md b/README_pt_br.md
index 9de7e3528a..cdb85aedd9 100644
--- a/README_pt_br.md
+++ b/README_pt_br.md
@@ -129,11 +129,6 @@ Consulte as [notas de versão completas](./docs/release_notes.md) para ver outra
- O modelo analisa perguntas complexas e, quando necessário, divide a questão, pesquisa conhecimentos e verifica evidências em várias etapas.
- Os modos Low, Medium, High e Ultra permitem ajustar a profundidade da busca e do raciocínio à complexidade da pergunta.
-### ⚙️ **Arquitetura de serviços nativa em Go**
-
-- Um serviço Go unificado fornece API, Admin, Ingestor e Syncer. O DeepDoc é executado no processo Go e realiza análise de layout, OCR e reconhecimento de tabelas.
-- Os serviços Go chamam bibliotecas nativas de análise de documentos e ONNX Runtime via CGO. MCP e Sandbox Executor podem ser habilitados conforme necessário.
-
### 🌱 **Citações fundamentadas com menos alucinações**
- Visualização da fragmentação de texto para permitir intervenção humana.
diff --git a/README_ru.md b/README_ru.md
index 9716a42e21..7c5c54d0c0 100644
--- a/README_ru.md
+++ b/README_ru.md
@@ -131,11 +131,6 @@
- Модель анализирует сложные вопросы и при необходимости разбивает их на части, ищет знания и проверяет доказательства в несколько этапов.
- Режимы Low, Medium, High и Ultra позволяют регулировать глубину поиска и рассуждений в зависимости от сложности вопроса.
-### ⚙️ **Нативная Go-архитектура сервисов**
-
-- Единый сервис Go предоставляет API, Admin, Ingestor и Syncer. DeepDoc работает внутри процесса Go и выполняет анализ макета, OCR и распознавание таблиц.
-- Сервисы Go вызывают нативные библиотеки обработки документов и ONNX Runtime через CGO. MCP и Sandbox Executor можно включать по мере необходимости.
-
### 🌱 **Обоснованные цитаты с минимальными галлюцинациями**
- Визуализация чанкинга с возможностью ручной корректировки.
diff --git a/README_tr.md b/README_tr.md
index f088e8094d..0610ab5495 100644
--- a/README_tr.md
+++ b/README_tr.md
@@ -131,11 +131,6 @@ Diğer güncellemeler için [tam sürüm notlarına](./docs/release_notes.md) ba
- Karmaşık soruları analiz edin; gerektiğinde soruları alt parçalara ayırın, bilgi arayın ve kanıtları birden fazla adımda doğrulayın.
- Low, Medium, High ve Ultra düşünme modlarıyla arama ve akıl yürütme derinliğini sorunun karmaşıklığına göre ayarlayın.
-### ⚙️ **Go yerel servis mimarisi**
-
-- API, Admin, Ingestor ve Syncer birleşik bir Go servisi tarafından sunulur. DeepDoc, Go süreci içinde sayfa düzeni analizi, OCR ve tablo tanımayı yürütür.
-- Go servisleri CGO üzerinden yerel belge ayrıştırma kitaplıklarını ve ONNX Runtime'ı çağırır. MCP ve Sandbox Executor gerektiğinde etkinleştirilebilir.
-
### 🌱 **Azaltılmış halüsinasyonlarla temellendirilmiş alıntılar**
- İnsan müdahalesine olanak tanıyan metin parçalama görselleştirmesi.
diff --git a/README_tzh.md b/README_tzh.md
index 54160bfb5d..04069c6003 100644
--- a/README_tzh.md
+++ b/README_tzh.md
@@ -134,13 +134,6 @@
- 透過多輪檢索與推理取得更完整的上下文,協助產生有依據的回答。
- 支援 Low、Medium、High、Ultra 思考模式,可依問題複雜度控制檢索和推理深度。
-### ⚙️ **Go 原生服務架構**
-
-- API、Admin、Ingestor 和 Syncer 由 Go 服務統一提供。
-- DeepDoc 在 Go 行程內執行,負責版面分析、OCR 和表格辨識。
-- Go 服務透過 CGO 呼叫原生文件解析程式庫和 ONNX Runtime。
-- MCP 和 Sandbox Executor 是可按需啟用的選用能力。
-
### 🌱 **有理有據、最大程度降低幻覺(hallucination)**
- 文字切片過程視覺化,支援手動調整。
diff --git a/README_zh.md b/README_zh.md
index 8640e737bd..61360a5b6d 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -85,17 +85,13 @@
## 🔥 近期更新
+- 2026-09-30 发布 RAGFlow 1.0.0-rc1。
- 2026-09-10 支持通过 Sitemap 接入网站内容。
- 2026-08-19 推出知识编译,支持在文档级和知识库级生成 Wiki、Graph、Tree、PageIndex、Mind Map、Timeline 及 Skills。
- 2026-08-19 推出 Agentic RAG,支持 Low、Medium、High、Ultra 四种思考模式。
- 2026-07-02 支持 Google BigQuery 数据源接入与增量同步。
-- 2026-06-29 支持 WhatsApp、钉钉和企业微信聊天渠道。
-- 2026-05-26 新增 Browser 组件,支持 Agent 自主浏览和操作网页。
-- 2026-04-21 提供七种预置数据摄取流水线模板。
-- 2026-04-21 支持 Agent 应用发布、沙箱代码执行与图表生成。
-- 2026-04-21 支持用户级记忆存储和检索。
-更多更新请参阅[完整发布记录](./docs/release_notes.md)。
+更多更新请参阅[完整发布记录](https://ragflow.io/docs/dev/release_notes)。
## 🎉 关注项目
@@ -129,13 +125,6 @@
- 通过多轮检索与推理获取更完整的上下文,帮助生成有依据的回答。
- 支持 Low、Medium、High、Ultra 思考模式,可按问题复杂度控制检索和推理深度。
-### ⚙️ **Go 原生服务架构**
-
-- API、Admin、Ingestor 和 Syncer 由 Go 服务统一提供。
-- DeepDoc 在 Go 进程内运行,负责版面分析、OCR 和表格识别。
-- Go 服务通过 CGO 调用原生文档解析库和 ONNX Runtime。
-- MCP 和 Sandbox Executor 作为可选能力按需启用。
-
### 🌱 **有理有据、最大程度降低幻觉(hallucination)**
- 文本切片过程可视化,支持手动调整。
@@ -160,7 +149,7 @@
## 🏠 本地部署
-本地部署提供 Docker 部署和源码启动两种方式:Docker 适合快速体验、集成测试和生产部署;源码启动适合 Go 服务开发、调试和二次开发。Docker 部署无需安装 Go,源码启动需要安装 `go.mod` 指定的 Go 版本;前端开发还需要 Node.js 和 npm。
+本地部署提供 Docker 部署和源码启动两种方式:Docker 适合快速体验、集成测试和生产部署;源码启动适合 RAGFlow 开发和调试。Docker 部署无需安装 Go 编译器,源码启动需要安装 `go.mod` 指定版本的 Go 编译器;前端开发还需要 Node.js 和 npm。
### 🐳 Docker 部署
@@ -168,15 +157,12 @@
- 建议起步配置:4 核 CPU、16 GB 内存和 50 GB 可用磁盘。实际资源需求取决于文档引擎、数据规模、解析任务和并发量;启用本地模型或其他额外组件时,请同时满足相应组件的资源要求。
- Docker ≥ 24.0.0,Docker Compose ≥ v2.26.1。
-- [gVisor](https://gvisor.dev/docs/user_guide/install/):仅在使用 Self-Managed 容器 Sandbox 时需要安装和配置。
-
-Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox 时需要额外安装和配置 gVisor,其他 Sandbox Provider 不要求在 RAGFlow 主机上安装 gVisor。
> ⚠️ **提示:** 如果你尚未在本机安装 Docker(Windows、macOS 或 Linux),可以参考 [Install Docker Engine](https://docs.docker.com/engine/install/) 自行安装。
#### 🚀 启动服务器
-1. 如果使用 Elasticsearch,将 Docker 主机的 `vm.max_map_count` 设置为至少 262144。使用 Infinity 时通常不需要执行此步骤:
+1. 如果使用 Elasticsearch,将 Docker 宿主机的 `vm.max_map_count` 设置为至少 262144。使用 Infinity 时则不需要执行此步骤:
> 如需确认 `vm.max_map_count` 的大小:
>
@@ -203,9 +189,7 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
git clone https://github.com/infiniflow/ragflow.git
```
-3. 切换到 Go 版发布标签并使用 Docker Compose 启动服务器:
-
- > ⚠️ **提示:** `v1.0.0-rc1` 及之后的发布标签使用 Go 实现。平台支持说明(注意:macOS 暂不受 Go 后端支持,请使用 Linux x86_64 主机)请参阅[Go Docker 镜像构建指南](./docs/develop/build_docker_image.mdx)。
+3. 切换到发布标签并使用 Docker Compose 启动服务器:
进入仓库中的 Docker 部署目录。
@@ -213,24 +197,24 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
cd ragflow/docker
```
- 切换到 Go 版 `v1.0.0-rc1` 发布标签。
+ 切换到 `v1.0.0-rc1` 发布标签。
```bash
git checkout v1.0.0-rc1
```
- 在后台启动 Go 服务及其依赖服务。
+ 在启动 RAGFlow 服务及其依赖服务。
```bash
docker compose -f docker-compose.yml up -d
```
- > 💡 **镜像下载提示:** 如果无法从默认仓库拉取 Go 镜像,请先在 `docker/.env` 中将 `RAGFLOW_IMAGE` 设置为以下镜像源之一,并保留 `v1.0.0-rc1` 标签:
+ > 💡 **镜像下载提示:** 如果无法从默认仓库拉取镜像,请先在 `docker/.env` 中将 `RAGFLOW_IMAGE` 设置为以下镜像源之一,并保留 `v1.0.0-rc1` 标签:
>
> - 华为云:`swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:v1.0.0-rc1`
> - 阿里云:`registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:v1.0.0-rc1`
- 默认 MySQL 配置下,Go 镜像入口会先执行数据库迁移,再通过 `bin/ragflow_server` 启动 Syncer、Admin、API 和 Ingestor。
+ 默认 MySQL 配置下,镜像入口会先执行数据库迁移,再启动 Admin、Syncer、Ingestor 和 API 等服务。
> RAGFlow 开源版 1.0 的 DeepDoc 版面分析、OCR 和表格识别使用 CPU 推理。
@@ -252,6 +236,7 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
5. 在你的浏览器中输入你的服务器对应的 IP 地址并登录 RAGFlow。
> 上面这个例子中,您只需输入 http://IP_OF_YOUR_MACHINE 即可:未改动过配置则无需输入端口(默认的 HTTP 服务端口 80)。
+
6. 登录 RAGFlow 后,在模型提供商页面添加 LLM、Embedding 和 Reranker,并填写对应的模型名称、服务地址和 API key。
> 详见 [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)。
@@ -262,101 +247,97 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
#### ⚙️ Docker 配置与调整
-Go 版 Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`,使用 Kvrocks 存储缓存和 Checkpoint,并使用 NATS JetStream 作为消息队列。镜像、端口、密码、文档引擎及模型镜像源请按[Docker 配置说明](./docker/README.md)修改;平台支持(注意:macOS 暂不受支持)请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。源码构建 Docker 镜像请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。
+Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`。镜像、端口、密码、文档引擎及模型镜像源请按[Docker 配置说明](./docker/README.md)修改;平台支持(注意:macOS 暂不受支持)请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。源码构建 Docker 镜像请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。
切换文档引擎、修改配置后重启服务,以及保留或清理已有数据的操作,也请按照上述 Docker 配置文档执行。
-### 🔨 以源代码启动 Go 服务
+### 🔨 以源代码启动
#### 📝 源码启动前提条件
-源码启动请安装 `go.mod` 中指定的 Go 版本(当前为 Go 1.27)、Clang 20、LLD 20、CMake ≥ 4.0、PCRE2 开发文件和 CGO 所需的原生库。仅开发 React 前端时需要 Node.js 和 npm。
-
-1. 克隆仓库,并安装 `go.mod` 中指定的 Go 版本(当前为 Go 1.27)、Clang 20、LLD 20、CMake ≥ 4.0,以及 PCRE2 开发文件。Go 服务依赖 CGO 和原生静态库;[build.sh](./build.sh) 会设置所需的构建参数。
+1. 克隆仓库,并安装 `go.mod` 中指定版本的 Go 编译器(当前为 Go 1.27)、Clang 20、LLD 20、CMake ≥ 4.0、PCRE2 开发文件 CGO 依赖的静态库;[build.sh](./build.sh) 会设置所需的构建参数。
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow
```
-2. 按 [Go 依赖下载脚本](./ragflow_deps/download_deps.py)准备原生库、模型文件和 tokenizer 资源,再编译 Go 服务:
+2. 运行 [依赖下载脚本](./ragflow_deps/download_deps.py) 下载静态库和模型文件:
```bash
python3 -m venv /tmp/ragflow-go-download-venv
/tmp/ragflow-go-download-venv/bin/python -m pip install requests huggingface-hub
/tmp/ragflow-go-download-venv/bin/python ragflow_deps/download_deps.py
- bash build.sh --all
+ ./build.sh --all
```
- 下载脚本负责准备 Go 构建所需的原生库和模型资源,并需要 `requests` 和 `huggingface-hub`。如果已通过其他方式准备好相同资源,可跳过这一步。Go 服务从仓库根目录启动时会自动查找 `internal/rag/res/deepdoc`;如需从其他目录启动,请将 `DEEPDOC_MODEL_DIR` 设为该目录的绝对路径。
+ 下载脚本准备构建所需的静态库和模型资源,并需要 `requests` 和 `huggingface-hub`。如果已通过其他方式准备好相同资源,可跳过这一步。Go 服务从仓库根目录启动时会自动查找 `internal/rag/res/deepdoc`;如需从其他目录启动,请将 `DEEPDOC_MODEL_DIR` 设为该目录的绝对路径。
-3. 启动本地依赖服务,并确认 **conf/service_conf.yaml** 中的主机与端口对应宿主机可访问的地址。Go 源码服务通过 `localhost:6379` 连接 Compose 暴露的 Kvrocks;Go Docker 服务则在容器网络中连接 Kvrocks。如果使用默认 Elasticsearch,还需先将 Docker 主机的 `vm.max_map_count` 设为至少 `262144`。
+3. 编译:
```bash
- sudo sysctl -w vm.max_map_count=262144
- docker compose --env-file docker/.env -f docker/docker-compose-base.yml \
- up -d --wait es01 mysql minio nats kvrocks clickhouse
+ ./build.sh --all
```
-4. 先迁移数据库,再分别在 5 个独立终端中按顺序启动 Go 服务(命令均在仓库根目录运行)。每次只在对应终端中执行该终端下方的命令,不要把所有命令一次性粘贴到同一个终端。迁移命令无需设置 `RAGFLOW_DEV_MODE`;开发环境中的 Admin、Ingestor、Syncer 和 API 按下方命令设置 `RAGFLOW_DEV_MODE=true`。迁移命令执行完成后即可关闭终端,其他 4 个服务终端需要保持运行。
+4. 启动本地依赖服务,并确认 **conf/service_conf.yaml** 中的主机与端口对应宿主机可访问的地址。如果使用 Elasticsearch,还需先将 Docker 主机的 `vm.max_map_count` 设为至少 `262144`。
- 终端 1:迁移数据库。
+ ```bash
+ sudo sysctl -w vm.max_map_count=262144
+ docker compose --env-file docker/.env -f docker/docker-compose-base.yml up -d --wait es01 mysql minio nats kvrocks
+ ```
+
+5. 数据迁移:
```bash
./bin/ragflow_server --migrate
```
- 终端 2:启动 Admin(目标端口 `9381`)。
+6. 启动 4 个终端分别启动 4 个服务:
+
+ 终端 1:启动 Admin,监听端口 `9381`。
```bash
- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin
+ ./bin/ragflow_server --admin
```
- 终端 3:启动 Ingestor。
-
```bash
- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor
+ ./bin/ragflow_server --ingestor
```
- 终端 4:启动 Syncer。
+ 终端 3:启动 Syncer。
```bash
- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer
+ ./bin/ragflow_server --syncer
```
- 终端 5:启动 API(目标端口 `9380`)。
+ 终端 4:启动 API,监听端口 `9380`。
```bash
- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api
+ ./bin/ragflow_server --api
```
- 各启动模式的作用如下:
+ 各启动参数的作用如下:
- `--migrate`:执行数据库迁移,完成后即可退出。
- `--admin`:启动 Admin 服务,负责管理和初始化操作。
- `--ingestor`:启动 Ingestor 服务,负责数据摄取和解析任务。
- - `--syncer`:启动 Syncer 服务,负责数据同步任务。
- - `--api`:启动 API 服务,为 Web、SDK 和外部客户端提供接口。
-
- `RAGFLOW_DEV_MODE=true` 仅用于开发环境关闭代码版本与数据库迁移版本之间的降级检查,不会执行迁移或改变数据库结构,生产部署不要设置此变量。Admin 应先于其他服务启动。数据库迁移完成后,`RAGFLOW_DEV_MODE=true bash build.sh --run` 可作为便捷方式启动 Admin、Ingestor 和 API;该命令不启动 Syncer,需要完整服务链路时仍应另行执行 `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer`。
+ - `--syncer`:启动 Syncer 服务,负责外部数据源的数据同步任务。
+ - `--api`:启动 API 服务,为 Web 和 SDK 提供 API 接口。
-5. 仅在前端开发时安装 Node.js 和 npm,然后启动 React 前端:
+7. 仅在前端开发时安装 Node.js 和 npm,然后启动 React 前端:
```bash
cd web
npm install
- API_PROXY_SCHEME=go npm run dev
```
- 服务启动后,在另一个终端确认 Go API 已就绪:
+ 服务启动后,运行下面命令来确认 API 服务已就绪:
```bash
curl -f http://127.0.0.1:9380/api/v1/system/healthz
```
- 返回 HTTP 200 表示 API 可以正常响应。前端、ClickHouse 和 DeepDoc 的完整验证步骤请参阅[从源代码启动服务](./docs/develop/launch_ragflow_from_source.md#5-verify-the-startup)。
-
- 开发结束时,在各服务终端按 `Ctrl+C` 停止进程。如需停止依赖但保留容器以便下次使用,运行 `docker compose --env-file docker/.env -f docker/docker-compose-base.yml stop es01 mysql minio nats kvrocks clickhouse`;如需删除依赖容器和 Compose 网络但保留命名数据卷,运行 `docker compose --env-file docker/.env -f docker/docker-compose-base.yml down`。
+ 返回 HTTP 200 表示 API 可以正常响应。前端 和 DeepDoc 的完整验证步骤请参阅[从源代码启动服务](./docs/develop/launch_ragflow_from_source.md#5-verify-the-startup)。
详情请见 [从源代码启动服务](./docs/develop/launch_ragflow_from_source.md)。