RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
docs: Removed the description of API_PROXY_SCHEME and synchronized the README files (#20756)
YanZhangb9d814437f0f
diff --git a/AGENTS.md b/AGENTS.mdindex 3911b37149..24b67c9e84 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -11,7 +11,7 @@ Use this file as the local operating guide for the current codebase. Prefer the- Keep refactors centered on the owning abstraction, not on adjacent compatibility layers.## Current stack-- Backend: Go implements the API, admin, ingestor, and syncer modes in `cmd/ragflow_server.go`; the CLI runs from `cmd/ragflow-cli.go`. The Python API, admin, and workers are still present and `docker/entrypoint.sh` still defaults to Python when `API_PROXY_SCHEME` is unset. Go-only operation is the migration target, not the current repository state.+- Backend: Go implements the API, admin, ingestor, and syncer modes in `cmd/ragflow_server.go`; the CLI runs from `cmd/ragflow-cli.go`. The Docker entrypoint starts the Go services according to its command-line flags, and the frontend development server uses fixed Go backend proxy routes. The Python API, admin, and workers are still present pending removal.- Frontend: React + TypeScript + Vite in `web/`. When working under `web/`, read and follow `web/AGENTS.md` for frontend conventions.- The Go module contains the server, ingestion, parsing, agent runtime, CLI, and supporting services.- Runtime services commonly include MySQL/PostgreSQL, Kvrocks, NATS JetStream, MinIO, ClickHouse, and Elasticsearch/Infinity/OpenSearch depending on configuration.@@ -20,7 +20,7 @@ Use this file as the local operating guide for the current codebase. Prefer the- Move any still-required behavior and test coverage into the Go backend or the frontend before deleting the old implementation. Do not preserve a Python server, compatibility layer, fallback, or dual-backend path.- Before deleting `rag/`, move the Go DeepDoc `.ort` models and `ocr.res` out of `internal/rag/res/deepdoc/`, then update model discovery, dependency preparation, Docker packaging, and tests together.- Remove the frontend's Go/Python backend variants and update `web/CLAUDE.md` when the frontend no longer needs them. Until then, treat its dual-backend instructions as migration-only guidance; new frontend work should target the Go API.-- Update Docker's default entrypoint, dependency image, and CI workflows when removing their Python paths. Until then, select Go explicitly with `API_PROXY_SCHEME=go` where that variable controls startup.+- Update Docker's default entrypoint, dependency image, and CI workflows when removing their remaining Python paths. Keep the frontend development proxy routes aligned with the Go API and Admin ports in `web/vite.config.ts`.- Keep this guide aligned with the checked-in tree. Once the Python directories are deleted, remove their migration inventory below.## Code Layout to Expectdiff --git a/README.md b/README.mdindex ae1979b808..707cd19ba6 100644--- a/README.md+++ b/README.md@@ -90,12 +90,11 @@ For local deployment, see [Local Deployment](#-local-deployment).- 2026-08-19 Introduced Agentic RAG with Low, Medium, High, and Ultra thinking modes.- 2026-07-02 Added Google BigQuery data source ingestion and incremental synchronization.-See the [full release notes](./docs/release_notes.md) for more updates.+See the [full release notes](https://ragflow.io/docs/dev/release_notes) for more updates.## 🎉 Stay Tuned-⭐️ Star our repository to stay up-to-date with exciting new features and improvements! Get instant notifications for new-releases! 🌟+⭐️ Star our repository to stay up-to-date with exciting new features and improvements! Get instant notifications for new releases! 🌟<div align="center" style="margin-top:20px;margin-bottom:20px;"><img alt="RAGFlow feature updates" src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>@@ -133,7 +132,7 @@ releases! 🌟### 🍔 **Compatibility with heterogeneous data sources**-- Supports Word, Slides, Excel, TXT, images, scanned copies, structured data, web pages, and more.+- Supports Word documents, PowerPoint presentations, Excel spreadsheets, TXT files, images, PDFs, scanned copies, structured data, web pages, and more.### 🛀 **Automated and effortless RAG workflow**@@ -150,18 +149,17 @@ releases! 🌟## 🏠 Local Deployment+Local deployment supports both Docker deployment and launching from source. Docker is suitable for quick evaluation, integration testing, and production deployment, while launching from source is intended for RAGFlow development and debugging. Docker deployment does not require a Go compiler. Launching from source requires the Go version specified in `go.mod`; frontend development additionally requires Node.js and npm.+### 🐳 Docker Deployment#### 📝 Docker Deployment Prerequisites- Recommended starting configuration: 4 CPU cores, 16 GB RAM, and 50 GB of available disk space. Actual requirements depend on the document engine, data volume, parsing tasks, and concurrency. Local models and other optional components may require additional resources.-- 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 compiler on the host. Self-Managed container Sandbox requires gVisor; other Sandbox providers do not require gVisor on the RAGFlow host.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.> [!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/).+> If you have not installed Docker on your local machine (Windows, macOS, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).#### 🚀 Start up the server@@ -180,8 +178,7 @@ Docker deployment does not require Go compiler on the host. Self-Managed contain> sudo sysctl -w vm.max_map_count=262144> ```>- > This change will be reset after a system reboot. To ensure your change remains permanent, add or update the- > `vm.max_map_count` value in **/etc/sysctl.conf** accordingly:+ > This change will be reset after a system reboot. To ensure your change remains permanent, add or update the `vm.max_map_count` value in **/etc/sysctl.conf** accordingly:>> ```bash> vm.max_map_count=262144@@ -191,56 +188,67 @@ Docker deployment does not require Go compiler on the host. Self-Managed contain```bashgit clone https://github.com/infiniflow/ragflow.git```-3. Check out the Go release tag and start the prebuilt Go image with Docker Compose:+3. Check out the release tag and start the server with Docker Compose:- > [!NOTE]- > The `v1.0.0-rc1` tag and later release tags use the Go implementation. See the [Go Docker image build and platform support guide](./docs/develop/build_docker_image.mdx) only if you need to build an image locally.+ Enter the Docker deployment directory.- > ```bash- > # Enter the Docker deployment directory.- > cd ragflow/docker- > # Check out the Go v1.0.0-rc1 release tag.- > git checkout v1.0.0-rc1- > # Start the Go services and their dependencies in the background.- > docker compose -f docker-compose.yml up -d- > ```+ ```bash+ cd ragflow/docker+ ```- > In the default MySQL configuration, the Go image entrypoint runs database migrations before starting Syncer, Admin, API, and Ingestor through `bin/ragflow_server`.+ Check out the `v1.0.0-rc1` release tag.- > In the RAGFlow open-source 1.0 release, DeepDoc uses CPU inference for layout analysis, OCR, and table recognition.+ ```bash+ git checkout v1.0.0-rc1+ ```-4. Check service status and API readiness after startup:+ Start the RAGFlow services and their dependencies.```bash- docker ps+ docker compose -f docker-compose.yml up -d```- The command above displays dependency status. RAGFlow itself does not define a Compose healthcheck; confirm readiness through its API:+ With the default MySQL configuration, the image entrypoint runs database migrations before starting Admin, Syncer, Ingestor, API, and other services.++ > In the RAGFlow open-source 1.0 release, DeepDoc uses CPU inference for layout analysis, OCR, and table recognition.++4. Check the server status after startup:++ Use `docker ps` to check the dependency services. After the dependencies show `healthy` and the RAGFlow container remains running, use the HTTP endpoint to determine whether RAGFlow is ready. The RAGFlow container itself does not define a Compose healthcheck.```bashcurl -f http://localhost/api/v1/system/healthz```- An HTTP 200 response indicates readiness. If you changed `SVR_WEB_HTTP_PORT`, use that port in the health-check URL. If startup fails, inspect the relevant service logs with `docker logs --tail 50 <service>`.+ After receiving an HTTP 200 response, open the Web UI. If you changed `SVR_WEB_HTTP_PORT`, replace the port in the health-check URL accordingly.++ If startup fails, inspect the container logs:++ ```bash+ docker logs --tail 50 ragflow-cpu+ ```5. In your web browser, enter the IP address of your server and log in to RAGFlow.- > With the default settings, you only need to enter `http://IP_OF_YOUR_MACHINE` (**sans** port number) as the default- > HTTP serving port `80` can be omitted when using the default configurations.- >+ > With the default settings, you only need to enter `http://IP_OF_YOUR_MACHINE` (**sans** port number), because the default HTTP serving port `80` can be omitted when using the default configuration.+6. After signing in, add an LLM, embedding, and reranker on the model provider page, including the model name, service address, and API key.+ > For details, see [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup).++ _The show is on!_++See the [Quickstart guide](./docs/quickstart.mdx) for details.+#### ⚙️ Docker Configuration and Adjustment-Go Docker deployment uses `docker/.env` and `docker/docker-compose.yml`, uses Kvrocks for cache and Checkpoint storage, and uses NATS JetStream as the message queue. Configure the image, ports, passwords, document engine, and model image source as described in the [Docker configuration guide](./docker/README.md). macOS is temporarily not supported by the Go backend (use a Linux x86_64 host); for platform support details, see the [Go Docker image build guide](./docs/develop/build_docker_image.mdx).+Docker deployment uses `docker/.env` and `docker/docker-compose.yml`. Configure the image, ports, passwords, document engine, and model image source as described in the [Docker configuration guide](./docker/README.md). For platform support (note that macOS is not currently supported), see the [Go Docker image build and platform support guide](./docs/develop/build_docker_image.mdx). To build the Docker image from source, see the [Go Docker image build and platform support guide](./docs/develop/build_docker_image.mdx).For document-engine changes, configuration updates, restarting services, and retaining or removing existing data, follow the Docker configuration guide.-### 🔨 Launch Go Services from Source+### 🔨 Launch from Source#### 📝 Source Build Prerequisites-Install the Go version specified in `go.mod` (currently Go 1.27), Clang 20, LLD 20, CMake ≥ 4.0, PCRE2 development files, and the native libraries required by CGO. Node.js and npm are required only when developing the React frontend.-1. Clone the repository and install the Go version specified in `go.mod` (currently Go 1.27), Clang 20, LLD 20, CMake ≥ 4.0, and PCRE2 development files. Go services depend on CGO and native static libraries; [build.sh](./build.sh) sets the required build parameters.```bash@@ -248,55 +256,57 @@ Install the Go version specified in `go.mod` (currently Go 1.27), Clang 20, LLDcd ragflow```-2. Prepare native libraries, model files, and tokenizer assets with the [Go dependency download script](./ragflow_deps/download_deps.py), then build the Go services:+2. Run the [dependency download script](./ragflow_deps/download_deps.py) to download the static libraries and model files:```bashpython3 -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```The script prepares native libraries and model resources required for the Go build and needs `requests` and `huggingface-hub`. Skip this step if you have prepared the same resources by other means. When started from the repository root, Go services automatically find `internal/rag/res/deepdoc`; to start from another directory, set `DEEPDOC_MODEL_DIR` to its absolute path.-3. Start the local dependencies and make sure the hosts and ports in **conf/service_conf.yaml** point to addresses accessible from the host. Go source services connect to Compose-exposed Kvrocks at `localhost:6379`, while Go Docker services connect to Kvrocks on the container network. If using the default Elasticsearch engine, set `vm.max_map_count` on the Docker host to at least `262144` first.+3. Build the services:```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. Migrate the database first, then start the Go services in order in five separate terminals. Run each command below from the repository root. Keep the four service terminals running. The migration command does not need `RAGFLOW_DEV_MODE`; set `RAGFLOW_DEV_MODE=true` for Admin, Ingestor, Syncer, and API in a development environment. Close the migration terminal after the migration completes.+4. Start the local dependency services and make sure the hosts and ports in **conf/service_conf.yaml** point to addresses accessible from the host. If using Elasticsearch, first set `vm.max_map_count` on the Docker host to at least `262144`.- Terminal 1: migrate the database.+ ```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. Migrate the database:```bash./bin/ragflow_server --migrate```- Terminal 2: start Admin (target port `9381`).+6. Start the four services in four separate terminals:++ Terminal 1: start Admin on port `9381`.```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin+ ./bin/ragflow_server --admin```- Terminal 3: start Ingestor.-```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor+ ./bin/ragflow_server --ingestor```- Terminal 4: start Syncer.+ Terminal 3: start Syncer.```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer+ ./bin/ragflow_server --syncer```- Terminal 5: start API (target port `9380`).+ Terminal 4: start API on port `9380`.```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --api```The startup modes work as follows:@@ -304,28 +314,23 @@ Install the Go version specified in `go.mod` (currently Go 1.27), Clang 20, LLD- `--migrate`: Runs database migrations and exits when complete.- `--admin`: Starts the Admin service for management and initialization operations.- `--ingestor`: Starts the Ingestor service for data ingestion and parsing tasks.- - `--syncer`: Starts the Syncer service for data synchronization tasks.- - `--api`: Starts the API service for the Web UI, SDKs, and external clients.+ - `--syncer`: Starts the Syncer service for external data source synchronization tasks.+ - `--api`: Starts the API service for the Web UI and SDKs.- `RAGFLOW_DEV_MODE=true` is only for development; it disables the downgrade check between code and database migration versions, but does not run migrations or change the database schema. Do not set it in production. Start Admin before the other services. After database migration, `RAGFLOW_DEV_MODE=true bash build.sh --run` can conveniently start Admin, Ingestor, and API. It does not start Syncer; start it separately with `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer` for the complete service chain.--5. Only when developing the frontend, install Node.js and npm, then start the React frontend:+7. Only when developing the frontend, install Node.js and npm, then start the React frontend:```bashcd webnpm install- API_PROXY_SCHEME=go npm run dev```- In another terminal, confirm that the Go API is ready:+ After the services start, confirm that the API is ready:```bashcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- An HTTP 200 response indicates that the API is responding. See [Launch Service from Source](./docs/develop/launch_ragflow_from_source.md#5-verify-the-startup) for complete frontend, ClickHouse, and DeepDoc verification steps.-- When development is complete, press `Ctrl+C` in each service terminal to stop the processes. To stop dependencies but keep the containers for next time, run `docker compose --env-file docker/.env -f docker/docker-compose-base.yml stop es01 mysql minio nats kvrocks clickhouse`. To remove the dependency containers and Compose network while keeping named data volumes, run `docker compose --env-file docker/.env -f docker/docker-compose-base.yml down`.+ An HTTP 200 response indicates that the API is responding. See [Launch Service from Source](./docs/develop/launch_ragflow_from_source.md#5-verify-the-startup) for complete frontend and DeepDoc verification steps.See [Launch Service from Source](./docs/develop/launch_ragflow_from_source.md) for details.@@ -341,7 +346,7 @@ See [Launch Service from Source](./docs/develop/launch_ragflow_from_source.md) f## 📜 Roadmap-See the [RAGFlow Roadmap 2026](https://github.com/infiniflow/ragflow/issues/12241)+See the [RAGFlow Roadmap 2026](https://github.com/infiniflow/ragflow/issues/12241).## 🏄 Community@@ -351,5 +356,4 @@ See the [RAGFlow Roadmap 2026](https://github.com/infiniflow/ragflow/issues/1224## 🙌 Contributing-RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community.-If you would like to be a part, review our [Contribution Guidelines](https://ragflow.io/docs/dev/contributing) first.+RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. If you would like to be a part, review our [Contribution Guidelines](https://ragflow.io/docs/dev/contributing) first.diff --git a/README_ar.md b/README_ar.mdindex 96aba074f3..585236a006 100644--- a/README_ar.md+++ b/README_ar.md@@ -56,17 +56,14 @@- 💡 [ما هو RAGFlow؟](#-ما-هو-ragflow)- 🎮 [ابدأ](#-ابدأ)-- 📌 [آخر التحديثات](#-آخر-التحديثات)+- 🔥 [آخر التحديثات](#-آخر-التحديثات)- 🌟 [الميزات الرئيسية](#-الميزات-الرئيسية)-- 🔎 [بنية النظام](#-هندسة-النظام)-- 🎬 [الاستضافة الذاتية](#-الاستضافة-الذاتية)-- 🔧 [التكوينات](#-التكوينات)-- 🔧 [إنشاء صورة Docker](#-أنشئ-صورة-docker)-- 🔨 [إطلاق الخدمة من المصدر للتطوير](#-إطلاق-الخدمة-من-المصدر-للتطوير)+- 🔎 [هندسة النظام](#-هندسة-النظام)+- 🏠 [النشر المحلي](#-النشر-المحلي)- 📚 [التوثيق](#-التوثيق)- 📜 [Roadmap](#-roadmap)- 🏄 [المجتمع](#-المجتمع)-- 🙌 [مساهمة](#-المساهمة)+- 🙌 [المساهمة](#-المساهمة)</details>@@ -93,18 +90,12 @@- 2026-08-19 إطلاق Knowledge Compilation لإنشاء 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 وDingTalk وWeCom.-- 2026-05-26 إضافة مكوّن Browser لتمكين Agents من تصفح صفحات الويب والتفاعل معها.-- 2026-04-21 إضافة سبعة قوالب مضمّنة لخطوط استيعاب البيانات.-- 2026-04-21 إضافة نشر تطبيقات Agent وتنفيذ التعليمات البرمجية في Sandbox وإنشاء المخططات.-- 2026-04-21 إضافة تخزين الذاكرة واسترجاعها على مستوى المستخدم.-راجع [ملاحظات الإصدار الكاملة](./docs/release_notes.md) لمزيد من التحديثات.+راجع [ملاحظات الإصدار الكاملة](https://ragflow.io/docs/dev/release_notes) لمزيد من التحديثات.## 🎉 تابعونا-⭐️ قم بتمييز مستودعنا بنجمة لتبقى على اطلاع بالميزات والتحسينات الجديدة والمثيرة! احصل على إشعارات فورية بالجديد-الإصدارات! 🌟+⭐️ قم بتمييز مستودعنا بنجمة لتبقى على اطلاع بالميزات والتحسينات الجديدة والمثيرة! احصل على إشعارات فورية بالإصدارات الجديدة! 🌟<div align="center" style="margin-top:20px;margin-bottom:20px;"><img alt="RAGFlow feature updates" src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>@@ -140,7 +131,7 @@### 🍔 **التوافق مع مصادر البيانات غير المتجانسة**-- يدعم Word، والشرائح، وExcel، وtxt، والصور، والنسخ الممسوحة ضوئيًا، والبيانات المنظمة، وصفحات الويب، والمزيد.+- يدعم مستندات Word، وعروض PowerPoint، وجداول Excel، وملفات TXT، والصور، وملفات PDF، والنسخ الممسوحة ضوئيًا، والبيانات المنظمة، وصفحات الويب، والمزيد.### 🛀 **سير عمل RAG آلي وسهل**@@ -152,194 +143,138 @@## 🔎 هندسة النظام<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="بنية RAGFlow" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 الاستضافة الذاتية+## 🏠 النشر المحلي++يدعم النشر المحلي النشر باستخدام Docker والتشغيل من المصدر. يناسب Docker التقييم السريع واختبارات التكامل والإنتاج، بينما يناسب التشغيل من المصدر تطوير RAGFlow وتصحيح أخطائه. لا يتطلب Docker مترجم Go؛ ويتطلب التشغيل من المصدر إصدار Go المحدد في `go.mod`، كما يتطلب تطوير الواجهة Node.js وnpm.### 🐳 نشر Docker#### 📝 متطلبات نشر Docker-- التكوين الابتدائي الموصى به: 4 أنوية CPU وذاكرة RAM بسعة 16 GB ومساحة قرص متاحة تبلغ 50 GB. تختلف المتطلبات الفعلية حسب محرك المستندات وحجم البيانات ومهام التحليل والتزامن؛ وقد تتطلب النماذج المحلية والمكونات الاختيارية الأخرى موارد إضافية.-- Docker >= 24.0.0 & Docker Compose >= v2.26.1-- [gVisor](https://gvisor.dev/docs/user_guide/install/): مطلوب فقط عند استخدام Sandbox للحاويات Self-Managed.--لا يتطلب نشر Docker تثبيت Go على المضيف. يتطلب Self-Managed container Sandbox تثبيت gVisor وإعداده؛ أما موفرو Sandbox الآخرون فلا يتطلبون تثبيت gVisor على مضيف RAGFlow.--> [!TIP]-> إذا لم تقم بتثبيت Docker على جهازك المحلي (Windows أو Mac أو Linux)، راجع [تثبيت Docker Engine](https://docs.docker.com/engine/install/).+- التكوين المبدئي الموصى به: 4 أنوية CPU وذاكرة RAM بسعة 16 GB ومساحة قرص متاحة 50 GB.+- Docker ≥ 24.0.0، وDocker Compose ≥ v2.26.1.#### 🚀 بدء تشغيل الخادم-1. تأكد من `vm.max_map_count` >= 262144:+1. عند استخدام Elasticsearch، اضبط `vm.max_map_count` على 262144 على الأقل. لا يلزم ذلك عادةً مع Infinity:- > للتحقق من قيمة `vm.max_map_count`:- >> ```bash> sysctl vm.max_map_count- > ```- >- > أعد تعيين `vm.max_map_count` إلى قيمة 262144 على الأقل إذا لم تكن كذلك.- >- > ```bash- > # In this case, we set it to 262144:> sudo sysctl -w vm.max_map_count=262144> ```- >- > سيتم إعادة ضبط هذا التغيير بعد إعادة تشغيل النظام. لضمان بقاء التغيير دائمًا، قم بإضافة أو تحديث- > `vm.max_map_count` القيمة في **/etc/sysctl.conf** وفقًا لذلك:- >- > ```bash- > vm.max_map_count=262144- > ```- >-2. استنساخ الريبو:++2. استنسخ المستودع:```bashgit clone https://github.com/infiniflow/ragflow.git```-3. انتقل إلى وسم إصدار Go وشغّل صورة Go الجاهزة باستخدام Docker Compose:--> [!CAUTION]-> جميع الصور Docker مصممة لمنصات x86. لا نعرض حاليًا صور Docker لـ ARM64.-> إذا كنت تستخدم نظامًا أساسيًا ARM64، فاتبع [هذا الدليل](https://ragflow.io/docs/dev/build_docker_image) لإنشاء صورة Docker متوافقة مع نظامك.--- الدخول إلى دليل نشر Docker.+3. انتقل إلى دليل Docker، وانتقل إلى وسم الإصدار، ثم شغّل الخدمات:```bashcd ragflow/docker- ```-- التبديل إلى وسم إصدار Go v1.0.0-rc1.-- ```bashgit checkout v1.0.0-rc1- ```-- تشغيل خدمات Go وتبعياتها في الخلفية.-- ```bashdocker compose -f docker-compose.yml up -d```- في إعداد MySQL الافتراضي، تنفّذ نقطة دخول صورة Go ترحيلات قاعدة البيانات أولًا، ثم تشغّل Syncer وAdmin وAPI وIngestor عبر `bin/ragflow_server`.--> يستخدم DeepDoc في الإصدار مفتوح المصدر 1.0 استدلال CPU لتحليل التخطيط وOCR والتعرف على الجداول.--4. تحقق من حالة الخدمات وجاهزية API بعد بدء التشغيل:-- ```bash- docker ps- ```+ > RAGFlow 1.0 open source uses CPU inference for DeepDoc layout analysis, OCR, and table recognition.- يعرض الأمر أعلاه حالة الخدمات التابعة. لا يعرّف RAGFlow فحص صحة Compose؛ تحقق من الجاهزية عبر API:+4. تحقق من حالة التبعيات وجاهزية API:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- تشير استجابة HTTP 200 إلى الجاهزية. إذا غيّرت `SVR_WEB_HTTP_PORT`، فاستخدم ذلك المنفذ في عنوان URL لفحص الصحة. إذا فشل بدء التشغيل، فافحص سجلات الخدمة المعنية باستخدام `docker logs --tail 50 <service>`.--5. في متصفح الويب الخاص بك، أدخل عنوان IP الخاص بالخادم الخاص بك وقم بتسجيل الدخول إلى RAGFlow.+5. افتح `http://IP_OF_YOUR_MACHINE` في المتصفح وسجّل الدخول. عند استخدام الإعدادات الافتراضية، يمكن حذف منفذ HTTP الافتراضي `80`.- > باستخدام الإعدادات الافتراضية، ما عليك سوى إدخال `http://IP_OF_YOUR_MACHINE` (**من دون** رقم المنفذ) كإعداد افتراضي- > HTTP يمكن حذف منفذ العرض `80` عند استخدام التكوينات الافتراضية.- >-6. بعد تسجيل الدخول، أضف LLM ونموذج embedding ونموذج reranker من صفحة موفري النماذج، ثم أدخل اسم النموذج وعنوان الخدمة ومفتاح API.+6. أضف LLM وEmbedding وReranker من صفحة موفري النماذج، وأدخل اسم النموذج وعنوان الخدمة ومفتاح API.- > راجع [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) لمزيد من المعلومات.- >+ > [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)- _العرض بدأ!_+راجع [دليل البدء السريع](./docs/quickstart.mdx) لمزيد من التفاصيل.#### ⚙️ إعداد Docker وتعديله-يستخدم نشر Go عبر Docker الملفين `docker/.env` و`docker/docker-compose.yml`، ويستخدم Kvrocks لتخزين ذاكرة التخزين المؤقت ونقاط التحقق، كما يستخدم NATS JetStream كقائمة انتظار للرسائل. لتعديل الصورة والمنافذ وكلمات المرور ومحرك المستندات ومصدر صور النماذج، اتبع [دليل إعداد Docker](./docker/README.md). ودعم المنصات (ملاحظة: نظام macOS غير مدعوم مؤقتًا، استخدم مضيف Linux x86_64)، راجع [دليل بناء صورة Go ودعم المنصات](./docs/develop/build_docker_image.mdx).+يستخدم نشر Docker الملفين `docker/.env` و`docker/docker-compose.yml`. اتبع [دليل إعداد Docker](./docker/README.md) لإعداد الصورة والمنافذ وكلمات المرور ومحرك المستندات ومصدر صور النماذج. ولدعم المنصات وبناء الصورة من المصدر، راجع [دليل بناء صورة Go ودعم المنصات](./docs/develop/build_docker_image.mdx). نظام macOS غير مدعوم حاليًا.-عند تبديل محرك المستندات أو تعديل الإعدادات وإعادة تشغيل الخدمات أو الاحتفاظ بالبيانات الحالية أو حذفها، اتبع أيضًا دليل إعداد Docker أعلاه.--### 🔨 إطلاق الخدمة من المصدر للتطوير+### 🔨 التشغيل من المصدر#### 📝 متطلبات البناء من المصدر-1. ثبّت إصدار Go المحدد في `go.mod` (حاليًا Go 1.27)، وClang 20 وLLD 20 وCMake 4.0 أو أحدث وملفات تطوير PCRE2. تعتمد خدمات Go على CGO والمكتبات الأصلية؛ ويضبط [build.sh](./build.sh) خيارات البناء اللازمة.-2. استنسخ المستودع وجهّز المكتبات الأصلية وملفات النماذج المطلوبة للبناء، ثم ابنِ خدمات Go:+1. استنسخ المستودع وثبّت إصدار Go المحدد في `go.mod` وClang 20 وLLD 20 وCMake ≥ 4.0 وملفات تطوير PCRE2 والمكتبات الأصلية اللازمة لـ CGO.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. شغّل [برنامج تنزيل التبعيات](./ragflow_deps/download_deps.py) لإعداد المكتبات الأصلية وملفات النماذج:+```bashpython3 -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```- يجهّز البرنامج النصي المكتبات الأصلية وموارد النماذج اللازمة لبناء Go، ويحتاج إلى `requests` و`huggingface-hub`. يمكن تخطي هذه الخطوة إذا جُهزت الموارد نفسها بطريقة أخرى. عند التشغيل من جذر المستودع، تعثر خدمات Go تلقائيًا على `internal/rag/res/deepdoc`؛ وللتشغيل من دليل آخر، اضبط `DEEPDOC_MODEL_DIR` على المسار المطلق لذلك الدليل.-3. ابدأ الخدمات التابعة المطلوبة (Elasticsearch وMySQL وMinIO وNATS وKvrocks وClickHouse) باستخدام Docker Compose:+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```- تتصل خدمات Go التي تعمل من المصدر بـ Kvrocks عبر `localhost:6379`، ولا يتطلب التكوين المرفق تعديل `/etc/hosts`.--4. بعد اكتمال ترحيل قاعدة البيانات، شغّل الخدمات بالترتيب. نفّذ كل أمر في نافذة طرفية مستقلة ومن جذر المستودع، واترك نوافذ الخدمات الأربع مفتوحة:+4. شغّل خدمات التبعية المحلية، وتأكد من إمكانية الوصول إلى المضيفين والمنافذ في **conf/service_conf.yaml**:```bash- ./bin/ragflow_server --migrate+ 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```- ```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin- ```+5. نفّذ ترحيل قاعدة البيانات:```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor+ ./bin/ragflow_server --migrate```+6. شغّل الخدمات الأربع في أربع نوافذ طرفية منفصلة:++ النافذة 1: Admin على المنفذ `9381`.+```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer+ ./bin/ragflow_server --admin``````bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --ingestor```- تعمل أوضاع التشغيل كما يلي:+ النافذة 3: Syncer.- - `--migrate`: ينفذ ترحيلات قاعدة البيانات ثم يخرج.- - `--admin`: يشغّل خدمة Admin للإدارة والتهيئة.- - `--ingestor`: يشغّل خدمة Ingestor لمهام استيعاب البيانات وتحليلها.- - `--syncer`: يشغّل خدمة Syncer لمهام مزامنة البيانات.- - `--api`: يشغّل خدمة API لواجهة الويب وSDK والعملاء الخارجيين.+ ```bash+ ./bin/ragflow_server --syncer+ ```- يُستخدم `RAGFLOW_DEV_MODE=true` للتطوير فقط؛ فهو يعطّل فحص الرجوع بين إصدار الكود وإصدار ترحيل قاعدة البيانات، ولا ينفذ الترحيلات أو يغير المخطط. لا تستخدمه في الإنتاج. شغّل Admin قبل الخدمات الأخرى. بعد الترحيل، يشغّل `RAGFLOW_DEV_MODE=true bash build.sh --run` خدمات Admin وIngestor وAPI، لكنه لا يشغّل Syncer؛ شغّل Syncer منفصلًا باستخدام `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer` لتشغيل سلسلة الخدمات كاملة.-5. ثبّت Node.js وnpm وشغّل واجهة React فقط عند تطوير الواجهة الأمامية:+ النافذة 4: API على المنفذ `9380`.```bash- cd web- npm install- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --api```- تحقق من جاهزية Go API من نافذة طرفية أخرى:+7. عند تطوير الواجهة فقط، ثبّت Node.js وnpm ثم تحقق من جاهزية API:```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- تعني استجابة HTTP 200 أن API يستجيب. عند انتهاء التطوير، اضغط `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`.-راجع [تشغيل الخدمة من المصدر](./docs/develop/launch_ragflow_from_source.md) لمزيد من التفاصيل.+> **ملاحظات التشغيل:** لجعل إعداد Elasticsearch دائمًا، أضف `vm.max_map_count=262144` إلى `/etc/sysctl.conf`. في إعداد MySQL الافتراضي، ينفذ مدخل صورة Docker ترحيل قاعدة البيانات قبل تشغيل Admin وSyncer وIngestor وAPI. يستخدم DeepDoc في الإصدار المفتوح 1.0 استدلال CPU لتحليل التخطيط وOCR والجداول. بعد تغيير إعداد Docker، أعد تشغيل الخدمات واتبع [دليل Docker](./docker/README.md) للاحتفاظ بالبيانات أو حذفها. يجهز `download_deps.py` المكتبات الأصلية وموارد النماذج، ويتطلب `requests` و`huggingface-hub`. ينفذ `--migrate` الترحيل ثم يخرج؛ ويشغّل `--admin` خدمة الإدارة، ويشغّل `--ingestor` خدمة الاستيعاب، ويشغّل `--syncer` خدمة مزامنة مصادر البيانات الخارجية، ويشغّل `--api` خدمة API لواجهة الويب وحزم SDK. تعني استجابة HTTP 200 أن API جاهز.+## 📚 التوثيق- [البدء السريع](https://ragflow.io/docs/dev/)@@ -362,5 +297,4 @@## 🙌 المساهمة-RAGFlow يزدهر من خلال التعاون مفتوح المصدر. وبهذه الروح، فإننا نحتضن المساهمات المتنوعة من المجتمع.-إذا كنت ترغب في أن تكون جزءًا، فراجع [إرشادات المساهمة](https://ragflow.io/docs/dev/contributing) أولاً.+RAGFlow يزدهر من خلال التعاون مفتوح المصدر. وبهذه الروح، فإننا نحتضن المساهمات المتنوعة من المجتمع. إذا كنت ترغب في أن تكون جزءًا، فراجع [إرشادات المساهمة](https://ragflow.io/docs/dev/contributing) أولاً.diff --git a/README_fr.md b/README_fr.mdindex e819bc12c7..9a1f5f3d66 100644--- a/README_fr.md+++ b/README_fr.md@@ -56,13 +56,10 @@- 💡 [Qu'est-ce que RAGFlow?](#-quest-ce-que-ragflow)- 🎮 [Démarrage](#-démarrage)-- 📌 [Dernières mises à jour](#-dernières-mises-à-jour)+- 🔥 [Dernières mises à jour](#-dernières-mises-à-jour)- 🌟 [Fonctionnalités clés](#-fonctionnalités-clés)- 🔎 [Architecture du système](#-architecture-du-système)-- 🎬 [Auto-hébergement](#-auto-hébergement)-- 🔧 [Configurations](#-configurations)-- 🔧 [Construire une image Docker](#-construire-une-image-docker)-- 🔨 [Lancer le service depuis les sources pour le développement](#-lancer-le-service-depuis-les-sources-pour-le-développement)+- 🏠 [Déploiement local](#-déploiement-local)- 📚 [Documentation](#-documentation)- 📜 [Roadmap](#-roadmap)- 🏄 [Communauté](#-communauté)@@ -91,13 +88,8 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow- 2026-08-19 Lancement de Knowledge Compilation pour générer des wikis, graphes, arbres, PageIndex, cartes mentales, chronologies et compétences au niveau des documents et des bases de connaissances.- 2026-08-19 Lancement d’Agentic RAG avec quatre modes de réflexion : Low, Medium, High et Ultra.- 2026-07-02 Ajout de l’ingestion de données depuis Google BigQuery et de la synchronisation incrémentielle.-- 2026-06-29 Ajout de canaux de conversation WhatsApp, DingTalk et WeCom.-- 2026-05-26 Ajout du composant Browser, qui permet aux Agents de parcourir et d’utiliser des pages Web.-- 2026-04-21 Ajout de sept modèles prédéfinis de pipelines d’ingestion de données.-- 2026-04-21 Ajout de la publication d’applications Agent, de l’exécution de code en sandbox et de la génération de graphiques.-- 2026-04-21 Ajout du stockage et de la récupération de mémoire au niveau utilisateur.-Consultez les [notes de version complètes](./docs/release_notes.md) pour découvrir les autres nouveautés.+Consultez les [notes de version complètes](https://ragflow.io/docs/dev/release_notes) pour découvrir les autres nouveautés.## 🎉 Restez informé@@ -136,7 +128,7 @@ Consultez les [notes de version complètes](./docs/release_notes.md) pour décou### 🍔 **Compatibilité avec des sources de données hétérogènes**-- Prend en charge Word, présentations, Excel, txt, images, copies numérisées, données structurées, pages web, et plus encore.+- Prend en charge les documents Word, les présentations PowerPoint, les feuilles Excel, les fichiers TXT, les images, les PDF, les copies numérisées, les données structurées, les pages web, et plus encore.### 🛀 **Flux de travail RAG automatisé et sans effort**@@ -148,199 +140,138 @@ Consultez les [notes de version complètes](./docs/release_notes.md) pour décou## 🔎 Architecture du système<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="Architecture du système RAGFlow" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 Auto-hébergement+## 🏠 Déploiement local++Le déploiement local prend en charge Docker et le lancement depuis les sources. Docker convient à l’évaluation rapide, aux tests d’intégration et à la production, tandis que le lancement depuis les sources est destiné au développement et au débogage de RAGFlow. Docker ne nécessite pas de compilateur Go ; le lancement depuis les sources requiert la version de Go indiquée dans `go.mod`, ainsi que Node.js et npm pour le développement de l’interface.### 🐳 Déploiement Docker#### 📝 Prérequis du déploiement Docker-- Configuration de départ recommandée : 4 cœurs CPU, 16 Go de RAM et 50 Go d’espace disque disponible. Les besoins réels dépendent du moteur de documents, du volume de données, des tâches d’analyse et de la concurrence. Les modèles locaux et les autres composants facultatifs peuvent nécessiter des ressources supplémentaires.-- Docker >= 24.0.0 & Docker Compose >= v2.26.1-- [gVisor](https://gvisor.dev/docs/user_guide/install/) : requis uniquement avec le Sandbox de conteneurs Self-Managed.--Le déploiement Docker ne nécessite pas l’installation de Go sur l’hôte. Le Sandbox de conteneurs Self-Managed nécessite l’installation et la configuration de gVisor ; les autres fournisseurs de Sandbox n’en ont pas besoin sur l’hôte RAGFlow.--> [!TIP]-> Si vous n'avez pas installé Docker sur votre machine locale (Windows, Mac ou Linux), consultez [Installer Docker Engine](https://docs.docker.com/engine/install/).+- Configuration de départ recommandée : 4 cœurs CPU, 16 Go de RAM et 50 Go d’espace disque disponible.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.#### 🚀 Démarrer le serveur-1. Assurez-vous que `vm.max_map_count` >= 262144 :+1. Avec Elasticsearch, définissez `vm.max_map_count` sur au moins 262144. Cette étape n’est généralement pas nécessaire avec Infinity :- > Pour vérifier la valeur de `vm.max_map_count` :- >> ```bash> sysctl vm.max_map_count- > ```- >- > Réinitialisez `vm.max_map_count` à une valeur d'au moins 262144 si ce n'est pas le cas.- >- > ```bash- > # Dans ce cas, nous le définissons à 262144 :> sudo sysctl -w vm.max_map_count=262144> ```- >- > Ce changement sera réinitialisé après un redémarrage du système. Pour que votre modification reste permanente, ajoutez ou mettez à jour la valeur `vm.max_map_count` dans **/etc/sysctl.conf** :- >- > ```bash- > vm.max_map_count=262144- > ```- >+2. Clonez le dépôt :```bashgit clone https://github.com/infiniflow/ragflow.git```-3. Passez à la balise de version Go et démarrez l’image Go préconstruite avec Docker Compose :--- Accédez au répertoire de déploiement Docker.+3. Accédez au répertoire Docker, sélectionnez le tag de version, puis démarrez les services :```bashcd ragflow/docker- ```-- Basculez vers la balise de version Go v1.0.0-rc1.-- ```bashgit checkout v1.0.0-rc1- ```-- Démarrez les services Go et leurs dépendances en arrière-plan.-- ```bashdocker compose -f docker-compose.yml up -d```- Avec la configuration MySQL par défaut, le point d’entrée de l’image exécute d’abord les migrations, puis démarre Syncer, Admin, API et Ingestor via `bin/ragflow_server`. Dans RAGFlow open-source 1.0, DeepDoc utilise l’inférence CPU pour l’analyse de mise en page, l’OCR et la reconnaissance des tableaux.--4. Vérifiez l’état des services et la disponibilité de l’API après le démarrage :-- ```bash- docker ps- ```+ > RAGFlow 1.0 open source uses CPU inference for DeepDoc layout analysis, OCR, and table recognition.- La commande ci-dessus affiche l’état des dépendances. RAGFlow ne définit pas de healthcheck Compose ; confirmez sa disponibilité via son API :+4. Vérifiez l’état des dépendances et la disponibilité de l’API :```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- Une réponse HTTP 200 indique que le service est prêt. Si `SVR_WEB_HTTP_PORT` a été modifié, utilisez ce port dans l’URL de vérification. En cas d’échec du démarrage, consultez les journaux du service concerné avec `docker logs --tail 50 <service>`.- >-5. Dans votre navigateur web, entrez l'adresse IP de votre serveur et connectez-vous à RAGFlow.+5. Ouvrez `http://IP_OF_YOUR_MACHINE` dans un navigateur et connectez-vous. Avec la configuration par défaut, le port HTTP `80` peut être omis.- > Avec les paramètres par défaut, il vous suffit d'entrer `http://IP_OF_YOUR_MACHINE` (**sans** numéro de port), car le port HTTP par défaut `80` peut être omis lors de l'utilisation des configurations par défaut.- >-6. Après vous être connecté à RAGFlow, ajoutez le LLM, le modèle d'embedding et le reranker sur la page des fournisseurs de modèles, puis renseignez le nom du modèle, l'adresse du service et la clé API correspondants.+6. Ajoutez un LLM, un modèle d’embedding et un reranker dans la page des fournisseurs de modèles, avec le nom, l’adresse du service et la clé API.- > Voir [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) pour plus d'informations.- >+ > [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)- _Le spectacle commence !_+Consultez le [guide de démarrage rapide](./docs/quickstart.mdx) pour plus de détails.#### ⚙️ Configuration et ajustement de Docker-Le déploiement Docker Go utilise `docker/.env` et `docker/docker-compose.yml`, Kvrocks pour le cache et le stockage des Checkpoints, et NATS JetStream comme file de messages. Pour configurer l’image, les ports, les mots de passe, le moteur de documents et la source des images de modèles, consultez le [guide de configuration Docker](./docker/README.md). Pour la prise en charge des plateformes (note : macOS n'est temporairement pas pris en charge, utilisez un hôte Linux x86_64), consultez le [guide de construction de l’image Go et de prise en charge des plateformes](./docs/develop/build_docker_image.mdx).--Pour changer de moteur de documents, modifier la configuration, redémarrer les services ou conserver/supprimer les données existantes, suivez également le guide de configuration Docker ci-dessus.+Docker utilise `docker/.env` et `docker/docker-compose.yml`. Suivez le [guide de configuration Docker](./docker/README.md) pour l’image, les ports, les mots de passe, le moteur de documents et la source des images de modèles. Pour les plateformes prises en charge et la construction depuis les sources, consultez le [guide de construction de l’image Go](./docs/develop/build_docker_image.mdx). macOS n’est actuellement pas pris en charge.-### 🔨 Lancer le service depuis les sources pour le développement+### 🔨 Lancer depuis les sources#### 📝 Prérequis de la compilation depuis les sources-1. Installez la version de Go indiquée dans `go.mod` (Go 1.27 actuellement), Clang 20, LLD 20, CMake 4.0 ou version ultérieure, ainsi que les fichiers de développement PCRE2. Les services Go dépendent de CGO et de bibliothèques natives ; [build.sh](./build.sh) configure les paramètres nécessaires.-2. Clonez le dépôt, préparez les bibliothèques natives et les fichiers de modèles requis, puis compilez les services Go :+1. Clonez le dépôt et installez la version de Go indiquée dans `go.mod`, Clang 20, LLD 20, CMake ≥ 4.0, les fichiers de développement PCRE2 et les bibliothèques natives requises par CGO.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. Exécutez le [script de téléchargement des dépendances](./ragflow_deps/download_deps.py) pour préparer les bibliothèques natives et les fichiers de modèles :+```bashpython3 -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```- Le script prépare les bibliothèques natives et les ressources de modèles nécessaires à la compilation Go et requiert `requests` et `huggingface-hub`. Ignorez cette étape si vous avez préparé les mêmes ressources autrement. Depuis la racine du dépôt, les services Go trouvent automatiquement `internal/rag/res/deepdoc` ; depuis un autre répertoire, définissez `DEEPDOC_MODEL_DIR` sur son chemin absolu.-3. Lancez les dépendances requises (Elasticsearch, MySQL, MinIO, NATS, Kvrocks et ClickHouse) avec Docker Compose :+3. Compilez les services :```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```- Les services Go lancés depuis les sources se connectent à Kvrocks via `localhost:6379`, tandis que les services Docker utilisent le nom d'hôte du réseau de conteneurs. Aucune modification de `/etc/hosts` n'est nécessaire avec la configuration fournie.-4. Exécutez d'abord la migration, puis démarrez Admin, Ingestor, Syncer et API dans quatre terminaux distincts depuis la racine du dépôt. Le terminal de migration peut être fermé une fois la commande terminée ; les quatre autres doivent rester ouverts :-- Terminal 1 : migration+4. Démarrez les dépendances locales et vérifiez que les hôtes et ports de **conf/service_conf.yaml** sont accessibles :```bash- ./bin/ragflow_server --migrate+ 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```- Terminal 2 : Admin, port cible 9381+5. Exécutez la migration de la base de données :```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin+ ./bin/ragflow_server --migrate```- Terminal 3 : Ingestor-- ```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor- ```+6. Démarrez les quatre services dans quatre terminaux distincts :- Terminal 4 : Syncer+ Terminal 1 : Admin sur le port `9381`.```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer+ ./bin/ragflow_server --admin```- Terminal 5 : API, port cible 9380-```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --ingestor```- Les modes de démarrage fonctionnent comme suit :-- - `--migrate` : exécute les migrations de base de données puis quitte.- - `--admin` : démarre le service Admin pour les opérations de gestion et d'initialisation.- - `--ingestor` : démarre le service Ingestor pour l'ingestion et l'analyse des données.- - `--syncer` : démarre le service Syncer pour la synchronisation des données.- - `--api` : démarre le service API pour l'interface Web, les SDK et les clients externes.-- `RAGFLOW_DEV_MODE=true` est réservé au développement. Il désactive le contrôle de rétrogradation entre la version du code et celle des migrations, mais n'exécute aucune migration et ne modifie pas le schéma. Ne l'utilisez pas en production. Après la migration, `RAGFLOW_DEV_MODE=true bash build.sh --run` peut démarrer Admin, Ingestor et API, mais pas Syncer. Pour démarrer la chaîne complète, exécutez séparément `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer`.-5. Installez Node.js et npm uniquement pour développer le front-end :+ Terminal 3 : Syncer.```bash- cd web- npm install+ ./bin/ragflow_server --syncer```- Lancez ensuite le service front-end :++ Terminal 4 : API sur le port `9380`.```bash- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --api```- Dans un autre terminal, vérifiez ensuite que l'API Go est prête :+7. Uniquement pour développer le front-end, installez Node.js et npm, puis vérifiez la disponibilité de l’API :```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- Une réponse HTTP 200 indique que l'API répond. À la fin du développement, appuyez sur `Ctrl+C` dans chaque terminal de service. Pour arrêter les dépendances sans supprimer les conteneurs, exécutez `docker compose --env-file docker/.env -f docker/docker-compose-base.yml stop es01 mysql minio nats kvrocks clickhouse`. Pour supprimer les conteneurs de dépendances et le réseau Compose tout en conservant les volumes nommés, exécutez `docker compose --env-file docker/.env -f docker/docker-compose-base.yml down`.-Consultez [Lancer le service depuis les sources](./docs/develop/launch_ragflow_from_source.md) pour plus de détails.+> **Notes d’exploitation :** pour rendre le réglage Elasticsearch permanent, ajoutez `vm.max_map_count=262144` à `/etc/sysctl.conf`. Avec MySQL par défaut, l’entrée de l’image Docker exécute la migration avant de démarrer Admin, Syncer, Ingestor et API. Dans la version open source 1.0, DeepDoc utilise le CPU pour l’analyse de mise en page, l’OCR et les tableaux. Après une modification Docker, redémarrez les services et suivez le [guide Docker](./docker/README.md) pour conserver ou supprimer les données. `download_deps.py` prépare les bibliothèques natives et les modèles et nécessite `requests` et `huggingface-hub`. `--migrate` migre puis quitte ; `--admin` démarre le service d’administration, `--ingestor` le service d’ingestion, `--syncer` le service de synchronisation des sources de données externes et `--api` le service API pour l’interface Web et les SDK. Une réponse HTTP 200 indique que l’API est prête.+## 📚 Documentation- [Quickstart](https://ragflow.io/docs/dev/)@@ -363,5 +294,4 @@ Voir la [Feuille de route RAGFlow 2026](https://github.com/infiniflow/ragflow/is## 🙌 Contribuer-RAGFlow s'épanouit grâce à la collaboration open-source. Dans cet esprit, nous accueillons des contributions diverses de la communauté.-Si vous souhaitez en faire partie, consultez d'abord nos [Directives de contribution](https://ragflow.io/docs/dev/contributing).+RAGFlow s'épanouit grâce à la collaboration open-source. Dans cet esprit, nous accueillons des contributions diverses de la communauté. Si vous souhaitez en faire partie, consultez d'abord nos [Directives de contribution](https://ragflow.io/docs/dev/contributing).diff --git a/README_id.md b/README_id.mdindex 2c52ab75f0..29d6986574 100644--- a/README_id.md+++ b/README_id.md@@ -52,17 +52,14 @@</div><details open>-<summary><b>📕 Daftar Isi </b> </summary>+<summary><b>📕 Daftar Isi</b></summary>- 💡 [Apa Itu RAGFlow?](#-apa-itu-ragflow)- 🎮 [Mulai](#-mulai)-- 📌 [Pembaruan Terbaru](#-pembaruan-terbaru)+- 🔥 [Pembaruan Terbaru](#-pembaruan-terbaru)- 🌟 [Fitur Utama](#-fitur-utama)- 🔎 [Arsitektur Sistem](#-arsitektur-sistem)-- 🎬 [Pengelolaan Mandiri](#-pengelolaan-mandiri)-- 🔧 [Konfigurasi](#-konfigurasi)-- 🔧 [Membangun Image Docker](#-membangun-docker-image)-- 🔨 [Meluncurkan aplikasi dari Sumber untuk Pengembangan](#-menjalankan-aplikasi-dari-sumber-untuk-pengembangan)+- 🏠 [Deployment Lokal](#-deployment-lokal)- 📚 [Dokumentasi](#-dokumentasi)- 📜 [Peta Jalan](#-roadmap)- 🏄 [Komunitas](#-komunitas)@@ -72,7 +69,7 @@## 💡 Apa Itu RAGFlow?-[RAGFlow](https://ragflow.io/) adalah mesin [RAG](https://ragflow.io/basics/what-is-rag) (Retrieval-Augmented Generation) open-source terkemuka yang mengintegrasikan teknologi RAG mutakhir dengan kemampuan Agent untuk menciptakan lapisan kontekstual superior bagi LLM. Menyediakan alur kerja RAG yang efisien dan dapat diadaptasi untuk perusahaan segala skala. Didukung oleh mesin konteks terkonvergensi dan template Agent yang telah dipra-bangun, RAGFlow memungkinkan pengembang mengubah data kompleks menjadi sistem AI kesetiaan-tinggi dan siap-produksi dengan efisiensi dan presisi yang luar biasa.+[RAGFlow](https://ragflow.io/) adalah mesin [RAG](https://ragflow.io/basics/what-is-rag) (Retrieval-Augmented Generation) open-source terkemuka yang mengintegrasikan teknologi RAG mutakhir dengan kemampuan Agent untuk menciptakan lapisan kontekstual superior bagi LLM. Menyediakan alur kerja RAG yang efisien dan dapat diadaptasi untuk perusahaan segala skala. Didukung oleh [mesin konteks](https://ragflow.io/basics/what-is-agent-context-engine) terkonvergensi dan template Agent yang telah dipra-bangun, RAGFlow memungkinkan pengembang mengubah data kompleks menjadi sistem AI kesetiaan-tinggi dan siap-produksi dengan efisiensi dan presisi yang luar biasa.## 🎮 Mulai@@ -91,13 +88,8 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io).- 2026-08-19 Memperkenalkan Knowledge Compilation untuk menghasilkan Wiki, Graph, Tree, PageIndex, Mind Map, Timeline, dan Skills pada tingkat dokumen dan dataset.- 2026-08-19 Memperkenalkan Agentic RAG dengan mode berpikir Low, Medium, High, dan Ultra.- 2026-07-02 Menambahkan ingest sumber data Google BigQuery dan sinkronisasi inkremental.-- 2026-06-29 Menambahkan kanal chat WhatsApp, DingTalk, dan WeCom.-- 2026-05-26 Menambahkan komponen Browser agar Agent dapat menjelajahi dan berinteraksi dengan halaman web.-- 2026-04-21 Menambahkan tujuh templat pipeline ingest data bawaan.-- 2026-04-21 Menambahkan publikasi aplikasi Agent, eksekusi kode sandbox, dan pembuatan grafik.-- 2026-04-21 Menambahkan penyimpanan dan pengambilan memori tingkat pengguna.-Lihat [catatan rilis lengkap](./docs/release_notes.md) untuk pembaruan lainnya.+Lihat [catatan rilis lengkap](https://ragflow.io/docs/dev/release_notes) untuk pembaruan lainnya.## 🎉 Tetap Terkini@@ -136,7 +128,7 @@ Lihat [catatan rilis lengkap](./docs/release_notes.md) untuk pembaruan lainnya.### 🍔 **Kompatibilitas dengan Sumber Data Heterogen**-- Mendukung Word, slide, excel, txt, gambar, salinan hasil scan, data terstruktur, halaman web, dan banyak lagi.+- Mendukung dokumen Word, presentasi PowerPoint, spreadsheet Excel, file TXT, gambar, PDF, salinan hasil pemindaian, data terstruktur, halaman web, dan banyak lagi.### 🛀 **Alur Kerja RAG yang Otomatis dan Mudah**@@ -148,194 +140,138 @@ Lihat [catatan rilis lengkap](./docs/release_notes.md) untuk pembaruan lainnya.## 🔎 Arsitektur Sistem<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="Arsitektur sistem RAGFlow" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 Pengelolaan Mandiri+## 🏠 Deployment Lokal++Deployment lokal mendukung Docker dan menjalankan dari sumber. Docker cocok untuk evaluasi cepat, pengujian integrasi, dan produksi, sedangkan sumber ditujukan untuk pengembangan dan debugging RAGFlow. Docker tidak memerlukan compiler Go; sumber memerlukan versi Go dalam `go.mod`, serta Node.js dan npm untuk pengembangan frontend.### 🐳 Deployment Docker#### 📝 Prasyarat Deployment Docker-- Konfigurasi awal yang disarankan: 4 inti CPU, RAM 16 GB, dan ruang disk tersedia 50 GB. Kebutuhan aktual bergantung pada mesin dokumen, volume data, tugas penguraian, dan konkurensi. Model lokal dan komponen opsional lainnya mungkin memerlukan sumber daya tambahan.-- Docker >= 24.0.0 & Docker Compose >= v2.26.1-- [gVisor](https://gvisor.dev/docs/user_guide/install/): Hanya diperlukan saat menggunakan container Sandbox Self-Managed.--Deployment Docker tidak memerlukan Go di host. Container Sandbox Self-Managed memerlukan instalasi dan konfigurasi gVisor; penyedia Sandbox lainnya tidak memerlukan gVisor di host RAGFlow.--> [!TIP]-> Jika Anda belum menginstal Docker di komputer lokal Anda (Windows, Mac, atau Linux), lihat [Install Docker Engine](https://docs.docker.com/engine/install/).+- Konfigurasi awal yang disarankan: 4 core CPU, RAM 16 GB, dan ruang disk kosong 50 GB.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.#### 🚀 Menjalankan Server-1. Pastikan `vm.max_map_count` >= 262144:+1. Jika menggunakan Elasticsearch, atur `vm.max_map_count` minimal 262144. Langkah ini biasanya tidak diperlukan dengan Infinity:- > Untuk memeriksa nilai `vm.max_map_count`:- >> ```bash> sysctl vm.max_map_count- > ```- >- > Jika nilainya kurang dari 262144, setel ulang `vm.max_map_count` ke setidaknya 262144:- >- > ```bash- > # Dalam contoh ini, kita atur menjadi 262144:> sudo sysctl -w vm.max_map_count=262144> ```- >- > Perubahan ini akan hilang setelah sistem direboot. Untuk membuat perubahan ini permanen, tambahkan atau perbarui nilai- > `vm.max_map_count` di **/etc/sysctl.conf**:- >- > ```bash- > vm.max_map_count=262144- > ```- >+2. Clone repositori:```bashgit clone https://github.com/infiniflow/ragflow.git```-3. Beralih ke tag rilis Go dan jalankan image Go yang telah disiapkan dengan Docker Compose:--> [!CAUTION]-> Semua gambar Docker dibangun untuk platform x86. Saat ini, kami tidak menawarkan gambar Docker untuk ARM64.-> Jika Anda menggunakan platform ARM64, [silakan gunakan panduan ini untuk membangun gambar Docker yang kompatibel dengan sistem Anda](https://ragflow.io/docs/dev/build_docker_image).--- Masuk ke direktori deployment Docker.+3. Masuk ke direktori Docker, checkout tag rilis, lalu jalankan layanan:```bashcd ragflow/docker- ```-- Beralih ke tag rilis Go v1.0.0-rc1.-- ```bashgit checkout v1.0.0-rc1- ```-- Jalankan layanan Go dan dependensinya di latar belakang.-- ```bashdocker compose -f docker-compose.yml up -d```- Dalam konfigurasi MySQL default, entrypoint image Go menjalankan migrasi database terlebih dahulu, lalu memulai Syncer, Admin, API, dan Ingestor melalui `bin/ragflow_server`.--> Pada RAGFlow open-source 1.0, DeepDoc menggunakan inferensi CPU untuk analisis tata letak, OCR, dan pengenalan tabel.--4. Periksa status layanan dan kesiapan API setelah startup:-- ```bash- docker ps- ```+ > RAGFlow 1.0 open source uses CPU inference for DeepDoc layout analysis, OCR, and table recognition.- Perintah di atas menampilkan status dependensi. RAGFlow tidak mendefinisikan healthcheck Compose; konfirmasikan kesiapan melalui API:+4. Periksa status dependensi dan kesiapan API:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- Respons HTTP 200 menunjukkan bahwa layanan siap. Jika Anda mengubah `SVR_WEB_HTTP_PORT`, gunakan port tersebut dalam URL pemeriksaan kesehatan. Jika startup gagal, periksa log layanan terkait dengan `docker logs --tail 50 <service>`.--5. Buka browser web Anda, masukkan alamat IP server Anda, dan login ke RAGFlow.+5. Buka `http://IP_OF_YOUR_MACHINE` di browser dan masuk. Dengan konfigurasi default, port HTTP `80` dapat dihilangkan.- > Dengan pengaturan default, Anda hanya perlu memasukkan `http://IP_DEVICE_ANDA` (**tanpa** nomor port) karena- > port HTTP default `80` bisa dihilangkan saat menggunakan konfigurasi default.- >-6. Setelah masuk ke RAGFlow, tambahkan LLM, model embedding, dan reranker pada halaman penyedia model, lalu isi nama model, alamat layanan, dan API key yang sesuai.+6. Tambahkan LLM, embedding, dan reranker pada halaman penyedia model, beserta nama model, alamat layanan, dan API key.- > Lihat [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) untuk informasi lebih lanjut.- >+ > [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)- _Sistem telah siap digunakan!_+Lihat [panduan mulai cepat](./docs/quickstart.mdx) untuk detail selengkapnya.#### ⚙️ Konfigurasi dan Penyesuaian Docker-Deployment Docker Go menggunakan `docker/.env` dan `docker/docker-compose.yml`, dengan Kvrocks untuk cache dan penyimpanan Checkpoint serta NATS JetStream sebagai antrean pesan. Untuk mengatur image, port, kata sandi, mesin dokumen, dan sumber image model, lihat [panduan konfigurasi Docker](./docker/README.md). Untuk dukungan platform (catatan: macOS sementara tidak didukung, gunakan host Linux x86_64), lihat [panduan build image Go dan dukungan platform](./docs/develop/build_docker_image.mdx).+Docker menggunakan `docker/.env` dan `docker/docker-compose.yml`. Ikuti [panduan konfigurasi Docker](./docker/README.md) untuk image, port, kata sandi, mesin dokumen, dan sumber image model. Untuk dukungan platform dan build dari sumber, lihat [panduan build image Go](./docs/develop/build_docker_image.mdx). macOS saat ini tidak didukung.-Untuk mengganti mesin dokumen, mengubah konfigurasi, memulai ulang layanan, serta mempertahankan atau menghapus data yang ada, ikuti juga panduan konfigurasi Docker tersebut.--### 🔨 Menjalankan Aplikasi dari Sumber untuk Pengembangan+### 🔨 Menjalankan dari Sumber#### 📝 Prasyarat Build dari Sumber-1. Instal versi Go yang ditentukan di `go.mod` (saat ini Go 1.27), Clang 20, LLD 20, CMake 4.0 atau yang lebih baru, serta berkas pengembangan PCRE2. Layanan Go memerlukan CGO dan pustaka native; [build.sh](./build.sh) mengatur parameter build yang diperlukan.-2. Clone repositori, siapkan pustaka native dan berkas model yang diperlukan, lalu build layanan Go:+1. Clone repositori dan instal versi Go dalam `go.mod`, Clang 20, LLD 20, CMake ≥ 4.0, file pengembangan PCRE2, dan pustaka native yang diperlukan CGO.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. Jalankan [skrip pengunduh dependensi](./ragflow_deps/download_deps.py) untuk menyiapkan pustaka native dan file model:+```bashpython3 -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```- Skrip tersebut menyiapkan pustaka native dan sumber daya model yang diperlukan untuk build Go serta memerlukan `requests` dan `huggingface-hub`. Lewati langkah ini jika sumber daya yang sama telah disiapkan dengan cara lain. Saat dijalankan dari root repositori, layanan Go otomatis menemukan `internal/rag/res/deepdoc`; untuk menjalankan dari direktori lain, atur `DEEPDOC_MODEL_DIR` ke path absolutnya.-3. Jalankan dependensi yang diperlukan (Elasticsearch, MySQL, MinIO, NATS, Kvrocks, dan ClickHouse) menggunakan Docker Compose:+3. Build layanan:```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```- Layanan Go yang dijalankan dari sumber terhubung ke Kvrocks melalui `localhost:6379`; konfigurasi yang disediakan tidak memerlukan perubahan pada `/etc/hosts`.--4. Setelah migrasi database selesai, jalankan layanan secara berurutan. Jalankan setiap perintah di terminal terpisah dari root repositori dan biarkan keempat terminal layanan tetap berjalan:+4. Jalankan dependensi lokal dan pastikan host serta port di **conf/service_conf.yaml** dapat diakses:```bash- ./bin/ragflow_server --migrate+ 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```- ```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin- ```+5. Migrasikan database:```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor+ ./bin/ragflow_server --migrate```+6. Jalankan empat layanan dalam empat terminal terpisah:++ Terminal 1: Admin pada port `9381`.+```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer+ ./bin/ragflow_server --admin``````bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --ingestor```- Mode startup bekerja sebagai berikut:+ Terminal 3: Syncer.- - `--migrate`: Menjalankan migrasi database lalu keluar.- - `--admin`: Memulai layanan Admin untuk pengelolaan dan inisialisasi.- - `--ingestor`: Memulai layanan Ingestor untuk tugas ingestion dan parsing data.- - `--syncer`: Memulai layanan Syncer untuk sinkronisasi data.- - `--api`: Memulai layanan API untuk Web UI, SDK, dan klien eksternal.+ ```bash+ ./bin/ragflow_server --syncer+ ```- `RAGFLOW_DEV_MODE=true` hanya untuk pengembangan; variabel ini menonaktifkan pemeriksaan downgrade antara versi kode dan migrasi database, tetapi tidak menjalankan migrasi atau mengubah skema. Jangan gunakan di produksi. Jalankan Admin sebelum layanan lain. Setelah migrasi, `RAGFLOW_DEV_MODE=true bash build.sh --run` memulai Admin, Ingestor, dan API, tetapi tidak memulai Syncer; jalankan Syncer secara terpisah dengan `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer` untuk menjalankan seluruh rantai layanan.-5. Hanya untuk pengembangan frontend, instal Node.js dan npm, lalu jalankan frontend React:+ Terminal 4: API pada port `9380`.```bash- cd web- npm install- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --api```- Di terminal lain, pastikan Go API siap:+7. Hanya untuk pengembangan frontend, instal Node.js dan npm, lalu periksa kesiapan API:```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- Respons HTTP 200 menunjukkan bahwa API merespons. Setelah pengembangan selesai, tekan `Ctrl+C` di setiap terminal layanan. Untuk menghentikan dependensi tanpa menghapus kontainer, jalankan `docker compose --env-file docker/.env -f docker/docker-compose-base.yml stop es01 mysql minio nats kvrocks clickhouse`. Untuk menghapus kontainer dependensi dan jaringan Compose sambil mempertahankan volume bernama, jalankan `docker compose --env-file docker/.env -f docker/docker-compose-base.yml down`.-Lihat [Menjalankan Layanan dari Sumber](./docs/develop/launch_ragflow_from_source.md) untuk detailnya.+> **Catatan operasional:** agar pengaturan Elasticsearch permanen, tambahkan `vm.max_map_count=262144` ke `/etc/sysctl.conf`. Dengan MySQL default, entrypoint image Docker menjalankan migrasi sebelum memulai Admin, Syncer, Ingestor, dan API. DeepDoc open-source 1.0 memakai inferensi CPU untuk layout, OCR, dan tabel. Setelah konfigurasi Docker berubah, mulai ulang layanan dan ikuti [panduan Docker](./docker/README.md) untuk mempertahankan atau menghapus data. `download_deps.py` menyiapkan pustaka native dan model serta memerlukan `requests` dan `huggingface-hub`. `--migrate` menjalankan migrasi lalu keluar; `--admin` memulai layanan administrasi, `--ingestor` layanan ingestion, `--syncer` layanan sinkronisasi sumber data eksternal, dan `--api` layanan API untuk Web UI dan SDK. HTTP 200 berarti API siap.+## 📚 Dokumentasi- [Quickstart](https://ragflow.io/docs/dev/)@@ -358,5 +294,4 @@ Lihat [Roadmap RAGFlow 2026](https://github.com/infiniflow/ragflow/issues/12241)## 🙌 Kontribusi-RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas.-Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi](https://ragflow.io/docs/dev/contributing).+RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas. Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi](https://ragflow.io/docs/dev/contributing).diff --git a/README_ja.md b/README_ja.mdindex 2c0f282daf..981c511037 100644--- a/README_ja.md+++ b/README_ja.md@@ -51,6 +51,22 @@<a href="https://trendshift.io/repositories/9064" target="_blank"><img src="https://trendshift.io/api/badge/repositories/9064" alt="infiniflow%2Fragflow | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a></div>+<details open>+<summary><b>📕 目次</b></summary>++- 💡 [RAGFlow とは?](#-ragflow-とは)+- 🎮 [はじめに](#-はじめに)+- 🔥 [最新情報](#-最新情報)+- 🌟 [主な特徴](#-主な特徴)+- 🔎 [システム構成](#-システム構成)+- 🏠 [ローカルデプロイ](#-ローカルデプロイ)+- 📚 [ドキュメンテーション](#-ドキュメンテーション)+- 📜 [ロードマップ](#-ロードマップ)+- 🏄 [コミュニティ](#-コミュニティ)+- 🙌 [コントリビュート](#-コントリビュート)++</details>+## 💡 RAGFlow とは?[RAGFlow](https://ragflow.io/) は、先進的な[RAG](https://ragflow.io/basics/what-is-rag)(Retrieval-Augmented Generation)技術と Agent 機能を融合し、大規模言語モデル(LLM)に優れたコンテキスト層を構築する最先端のオープンソース RAG エンジンです。あらゆる規模の企業に対応可能な合理化された RAG ワークフローを提供し、統合型[コンテキストエンジン](https://ragflow.io/basics/what-is-agent-context-engine)と事前構築されたAgentテンプレートにより、開発者が複雑なデータを驚異的な効率性と精度で高精細なプロダクションレディAIシステムへ変換することを可能にします。@@ -74,13 +90,8 @@- 2026-08-19 Knowledge Compilationを導入。ドキュメントおよびデータセット単位でWiki、Graph、Tree、PageIndex、Mind Map、Timeline、Skillsを生成できます。- 2026-08-19 Low、Medium、High、Ultraの思考モードを備えたAgentic RAGを導入。- 2026-07-02 Google BigQueryデータソースの取り込みと増分同期に対応。-- 2026-06-29 WhatsApp、DingTalk、WeComのチャットチャネルに対応。-- 2026-05-26 AgentがWebページを閲覧・操作できるBrowserコンポーネントを追加。-- 2026-04-21 7種類の組み込みデータ取り込みパイプラインテンプレートを追加。-- 2026-04-21 Agentアプリの公開、Sandboxでのコード実行、グラフ生成に対応。-- 2026-04-21 ユーザー単位のメモリ保存と検索に対応。-その他の更新については[リリースノート全文](./docs/release_notes.md)を参照してください。+その他の更新については[リリースノート全文](https://ragflow.io/docs/dev/release_notes)を参照してください。## 🎉 続きを楽しみに@@ -120,7 +131,7 @@### 🍔 **多様なデータソースとの互換性**-- Word、スライド、Excel、txt、画像、スキャンコピー、構造化データ、Web ページなどをサポート。+- Word 文書、PowerPoint プレゼンテーション、Excel スプレッドシート、TXT ファイル、画像、PDF、スキャンデータ、構造化データ、Web ページなどをサポート。### 🛀 **自動化された楽な RAG ワークフロー**@@ -132,180 +143,125 @@## 🔎 システム構成<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow システムアーキテクチャ" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 セルフホスティング--### 🐳 Docker デプロイ+## 🏠 ローカルデプロイ-#### 📝 Docker デプロイの前提条件+Docker は迅速な評価、統合テスト、本番環境に、ソース起動は開発とデバッグに適しています。Docker に Go は不要です。ソース起動には `go.mod` 指定の Go、フロントエンド開発には Node.js と npm が必要です。-- 推奨する開始時の構成:CPU 4コア、RAM 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 デプロイ-DockerデプロイではホストへのGoのインストールは不要です。Self-ManagedコンテナSandboxではgVisorのインストールと設定が必要ですが、他のSandboxプロバイダーではRAGFlowホストへのgVisorのインストールは不要です。+#### 📝 前提条件-> [!TIP]-> ローカルマシン(Windows、Mac、または Linux)に Docker をインストールしていない場合は、[Docker Engine のインストール](https://docs.docker.com/engine/install/) を参照してください。+- 推奨される初期構成:4 CPU コア、16 GB RAM、50 GB の空きディスク容量。+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.#### 🚀 サーバーを起動-1. `vm.max_map_count` >= 262144 であることを確認する:-- > `vm.max_map_count` の値をチェックするには:- >- > ```bash- > sysctl vm.max_map_count- > ```- >- > `vm.max_map_count` が 262144 より大きい値でなければリセットする。- >- > ```bash- > # In this case, we set it to 262144:- > sudo sysctl -w vm.max_map_count=262144- > ```- >- > この変更はシステム再起動後にリセットされる。変更を恒久的なものにするには、**/etc/sysctl.conf** の `vm.max_map_count` 値を適宜追加または更新する:- >- > ```bash- > vm.max_map_count=262144- > ```- >-2. リポジトリをクローンする:+1. Elasticsearch: `vm.max_map_count` ≥ 262144.- ```bash- git clone https://github.com/infiniflow/ragflow.git- ```-3. Go リリースタグに切り替え、Docker Compose で事前ビルド済み Go イメージを起動します:+2. `git clone https://github.com/infiniflow/ragflow.git`-> [!CAUTION]-> 現在、公式に提供されているすべての Docker イメージは x86 アーキテクチャ向けにビルドされており、ARM64 用の Docker イメージは提供されていません。-> ARM64 アーキテクチャのオペレーティングシステムを使用している場合は、[このドキュメント](https://ragflow.io/docs/dev/build_docker_image)を参照して Docker イメージを自分でビルドしてください。---- Docker デプロイディレクトリに移動します。+3. Docker:```bashcd ragflow/docker- ```-- Go v1.0.0-rc1 リリースタグに切り替えます。-- ```bashgit checkout v1.0.0-rc1- ```-- Go サービスと依存サービスをバックグラウンドで起動します。-- ```bashdocker compose -f docker-compose.yml up -d```- デフォルトの MySQL 構成では、Go イメージのエントリーポイントが最初にデータベース移行を実行し、その後 `bin/ragflow_server` を介して Syncer、Admin、API、Ingestor を起動します。--> RAGFlow オープンソース 1.0 の DeepDoc は、レイアウト解析、OCR、表認識に CPU 推論を使用します。--4. 起動後にサービスの状態と API の準備状況を確認します:-- ```bash- docker ps- ```-- 上記のコマンドは依存サービスの状態を表示します。RAGFlow 自体には Compose healthcheck が定義されていないため、API で準備状況を確認します:+4. サービスと API の準備状況を確認します:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- HTTP 200 レスポンスは準備完了を示します。`SVR_WEB_HTTP_PORT` を変更した場合は、ヘルスチェック URL でそのポートを使用してください。起動に失敗した場合は、`docker logs --tail 50 <service>` で該当サービスのログを確認してください。--5. ウェブブラウザで、プロンプトに従ってサーバーの IP アドレスを入力し、RAGFlow にログインします。+5. ブラウザで `http://IP_OF_YOUR_MACHINE` を開いてログインします。デフォルト設定では、HTTP ポート `80` は省略できます。- > デフォルトの設定を使用する場合、デフォルトの HTTP サービングポート `80` は省略できるので、与えられたシナリオでは、`http://IP_OF_YOUR_MACHINE`(ポート番号は省略)だけを入力すればよい。- >-6. RAGFlow にログインした後、モデルプロバイダーページで LLM、Embedding、Reranker を追加し、モデル名、サービスアドレス、API キーを入力します。+6. モデルプロバイダーページで LLM、Embedding、Reranker を追加します。詳細は [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) を参照してください。- > 詳しくは [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) を参照してください。- >-- _これで初期設定完了!ショーの開幕です!_+詳細は[クイックスタート](./docs/quickstart.mdx)を参照してください。#### ⚙️ Docker の設定と調整-Go版のDockerデプロイでは `docker/.env` と `docker/docker-compose.yml` を使用し、キャッシュとCheckpointの保存にKvrocks、メッセージキューにNATS JetStreamを使用します。イメージ、ポート、パスワード、ドキュメントエンジン、モデルイメージの取得元を変更する場合は、[Docker設定ガイド](./docker/README.md)に従ってください。プラットフォームのサポートについて(注:macOSは現時点では非対応です。Linux x86_64ホストを使用してください)、[Go Dockerイメージのビルドとプラットフォームサポートガイド](./docs/develop/build_docker_image.mdx)を参照してください。--ドキュメントエンジンの切り替え、設定変更後のサービス再起動、既存データの保持または削除についても、上記のDocker設定ガイドに従ってください。+`docker/.env` と `docker/docker-compose.yml` を使用します。[Docker 設定](./docker/README.md)および[イメージのビルドとプラットフォームサポート](./docs/develop/build_docker_image.mdx)を参照してください。macOS は現在サポートされていません。-### 🔨 ソースコードからサービスを起動する方法+### 🔨 ソースコードから起動-#### 📝 ソースビルドの前提条件+#### 📝 前提条件-1. `go.mod` で指定されたGoバージョン(現在はGo 1.27)、Clang 20、LLD 20、CMake 4.0以降、およびPCRE2開発ファイルをインストールします。GoサービスはCGOとネイティブライブラリに依存し、[build.sh](./build.sh)が必要なビルド設定を行います。-2. リポジトリをクローンし、必要なネイティブライブラリとモデルファイルを準備してからGoサービスをビルドします:+1. リポジトリをクローンし、`go.mod` で指定された Go、Clang 20、LLD 20、CMake ≥ 4.0、PCRE2、および CGO に必要なネイティブライブラリをインストールします。```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. 依存関係を準備します:+```bashpython3 -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```- このスクリプトはGoビルドに必要なネイティブライブラリとモデルリソースを準備し、`requests`と`huggingface-hub`を使用します。同じリソースを別の方法で準備済みの場合は、この手順を省略できます。リポジトリルートから起動するとGoサービスは`internal/rag/res/deepdoc`を自動検出します。別のディレクトリから起動する場合は、`DEEPDOC_MODEL_DIR`にその絶対パスを設定してください。-3. Docker Composeで必要な依存サービス(Elasticsearch、MySQL、MinIO、NATS、Kvrocks、ClickHouse)を起動します:+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```- ソースから起動する Go サービスは `localhost:6379` で Kvrocks に接続するため、提供されている設定では `/etc/hosts` の変更は不要です。+4. ローカル依存サービスを起動します:++ ```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+ ```-4. データベースのマイグレーション後、サービスを順番に起動します。各コマンドはリポジトリのルートから別々のターミナルで実行し、サービス用の4つのターミナルは開いたままにします:+5. データベースをマイグレーションします:```bash./bin/ragflow_server --migrate- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api```- 各起動モードの役割は次のとおりです:+6. 4つのサービスを4つのターミナルで起動します:- - `--migrate`: データベース移行を実行して終了します。- - `--admin`: 管理と初期化を行うAdminサービスを起動します。- - `--ingestor`: データ取り込みと解析を行うIngestorサービスを起動します。- - `--syncer`: データ同期を行うSyncerサービスを起動します。- - `--api`: Web UI、SDK、外部クライアント向けのAPIサービスを起動します。+ ターミナル1: Admin (`9381`)。- `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`を別途実行してください。-5. フロントエンドを開発する場合に限り、Node.jsとnpmをインストールしてReactフロントエンドを起動します:+ ```bash+ ./bin/ragflow_server --admin+ ``````bash- cd web- npm install- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --ingestor```- 別のターミナルでGo APIの準備が完了したことを確認します:+ ターミナル3: Syncer。```bash- curl -f http://127.0.0.1:9380/api/v1/system/healthz+ ./bin/ragflow_server --syncer+ ```++ ターミナル4: API (`9380`)。++ ```bash+ ./bin/ragflow_server --api```- HTTP 200が返ればAPIは応答しています。開発終了時は各サービスターミナルで`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` を実行します。+7. フロントエンド開発時のみ Node.js と npm をインストールし、API を確認します:++ ```bash+ cd web+ npm install+ curl -f http://127.0.0.1:9380/api/v1/system/healthz+ ```詳細は[ソースコードからサービスを起動](./docs/develop/launch_ragflow_from_source.md)を参照してください。+> **運用上の注意:** Elasticsearch の設定を永続化するには、`/etc/sysctl.conf` に `vm.max_map_count=262144` を追加します。既定の MySQL 構成では、Docker エントリポイントが移行後に Admin、Syncer、Ingestor、API を起動します。オープンソース 1.0 の DeepDoc はレイアウト解析、OCR、表認識に CPU 推論を使用します。Docker 設定変更後の再起動とデータ保持・削除は [Docker ガイド](./docker/README.md)に従ってください。`download_deps.py` はネイティブライブラリとモデルを準備し、`requests` と `huggingface-hub` を使用します。`--migrate` は移行後に終了し、`--admin` は管理サービス、`--ingestor` は取り込みサービス、`--syncer` は外部データソース同期サービス、`--api` は Web UI と SDK 向けの API サービスを起動します。HTTP 200 は API の準備完了を示します。+## 📚 ドキュメンテーション- [Quickstart](https://ragflow.io/docs/dev/)diff --git a/README_ko.md b/README_ko.mdindex eb29ffc117..e34d3a6f7b 100644--- a/README_ko.md+++ b/README_ko.md@@ -52,6 +52,22 @@</div>+<details open>+<summary><b>📕 목차</b></summary>++- 💡 [RAGFlow란?](#-ragflow란)+- 🎮 [시작하기](#-시작하기)+- 🔥 [업데이트](#-업데이트)+- 🌟 [주요 기능](#-주요-기능)+- 🔎 [시스템 아키텍처](#-시스템-아키텍처)+- 🏠 [로컬 배포](#-로컬-배포)+- 📚 [문서](#-문서)+- 📜 [로드맵](#-로드맵)+- 🏄 [커뮤니티](#-커뮤니티)+- 🙌 [컨트리뷰션](#-컨트리뷰션)++</details>+## 💡 RAGFlow란?[RAGFlow](https://ragflow.io/) 는 최첨단 [RAG](https://ragflow.io/basics/what-is-rag)(Retrieval-Augmented Generation)와 Agent 기능을 융합하여 대규모 언어 모델(LLM)을 위한 우수한 컨텍스트 계층을 생성하는 선도적인 오픈소스 RAG 엔진입니다. 모든 규모의 기업에 적용 가능한 효율적인 RAG 워크플로를 제공하며, 통합 [컨텍스트 엔진](https://ragflow.io/basics/what-is-agent-context-engine)과 사전 구축된 Agent 템플릿을 통해 개발자들이 복잡한 데이터를 예외적인 효율성과 정밀도로 고급 구현도의 프로덕션 준비 완료 AI 시스템으로 변환할 수 있도록 지원합니다.@@ -75,13 +91,8 @@- 2026-08-19 Knowledge Compilation을 도입했습니다. 문서 및 데이터셋 수준에서 Wiki, Graph, Tree, PageIndex, Mind Map, Timeline, Skills를 생성할 수 있습니다.- 2026-08-19 Low, Medium, High, Ultra 사고 모드를 지원하는 Agentic RAG를 도입했습니다.- 2026-07-02 Google BigQuery 데이터 소스 수집 및 증분 동기화를 추가했습니다.-- 2026-06-29 WhatsApp, DingTalk, WeCom 채팅 채널을 추가했습니다.-- 2026-05-26 Agent가 웹 페이지를 탐색하고 조작할 수 있는 Browser 구성 요소를 추가했습니다.-- 2026-04-21 기본 제공 데이터 수집 파이프라인 템플릿 7종을 추가했습니다.-- 2026-04-21 Agent 애플리케이션 게시, Sandbox 코드 실행, 차트 생성을 추가했습니다.-- 2026-04-21 사용자 수준 메모리 저장 및 검색을 추가했습니다.-자세한 내용은 [전체 릴리스 노트](./docs/release_notes.md)를 참조하세요.+자세한 내용은 [전체 릴리스 노트](https://ragflow.io/docs/dev/release_notes)를 참조하세요.## 🎉 계속 지켜봐 주세요@@ -121,7 +132,7 @@### 🍔 **다른 종류의 데이터 소스와의 호환성**-- 워드, 슬라이드, 엑셀, 텍스트 파일, 이미지, 스캔본, 구조화된 데이터, 웹 페이지 등을 지원합니다.+- Word 문서, PowerPoint 프레젠테이션, Excel 스프레드시트, TXT 파일, 이미지, PDF, 스캔본, 구조화된 데이터, 웹 페이지 등을 지원합니다.### 🛀 **자동화되고 손쉬운 RAG 워크플로우**@@ -133,182 +144,126 @@## 🔎 시스템 아키텍처<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow 시스템 아키텍처" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 자체 호스팅--### 🐳 Docker 배포--#### 📝 Docker 배포 사전 요구 사항--- 권장 시작 구성: CPU 4코어, RAM 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 공급자는 RAGFlow 호스트에 gVisor를 설치할 필요가 없습니다.--> [!TIP]-> 로컬 머신(Windows, Mac, Linux)에 Docker가 설치되지 않은 경우, [Docker 엔진 설치](https://docs.docker.com/engine/install/)를 참조하세요.+## 🏠 로컬 배포-#### 🚀 서버 시작하기+Docker는 빠른 평가, 통합 테스트 및 프로덕션에 적합하고 소스 실행은 개발과 디버깅에 적합합니다. Docker에는 Go가 필요하지 않습니다. 소스 실행에는 `go.mod`의 Go가, 프런트엔드 개발에는 Node.js와 npm이 필요합니다.-1. `vm.max_map_count`가 262144 이상인지 확인하세요:-- > `vm.max_map_count`의 값을 아래 명령어를 통해 확인하세요:- >- > ```bash- > sysctl vm.max_map_count- > ```- >- > 만약 `vm.max_map_count` 이 262144 보다 작다면 값을 쟈설정하세요.- >- > ```bash- > # 이 경우에 262144로 설정했습니다.:- > sudo sysctl -w vm.max_map_count=262144- > ```- >- > 이 변경 사항은 시스템 재부팅 후에 초기화됩니다. 변경 사항을 영구적으로 적용하려면 /etc/sysctl.conf 파일에 vm.max_map_count 값을 추가하거나 업데이트하세요:- >- > ```bash- > vm.max_map_count=262144- > ```--2. 레포지토리를 클론하세요:+### 🐳 Docker 배포- ```bash- git clone https://github.com/infiniflow/ragflow.git- ```+#### 📝 사전 요구 사항-3. Go 릴리스 태그로 전환하고 사전 빌드된 Go 이미지를 Docker Compose로 시작하세요:+- 권장 초기 구성: CPU 코어 4개, RAM 16 GB, 사용 가능한 디스크 50 GB.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.-> [!CAUTION]-> 모든 Docker 이미지는 x86 플랫폼을 위해 빌드되었습니다. 우리는 현재 ARM64 플랫폼을 위한 Docker 이미지를 제공하지 않습니다.-> ARM64 플랫폼을 사용 중이라면, [시스템과 호환되는 Docker 이미지를 빌드하려면 이 가이드를 사용해 주세요](https://ragflow.io/docs/dev/build_docker_image).+#### 🚀 서버 시작+1. Elasticsearch: `vm.max_map_count` ≥ 262144.+2. `git clone https://github.com/infiniflow/ragflow.git`- Docker 배포 디렉터리로 이동합니다.+3. Docker:```bashcd ragflow/docker- ```-- Go v1.0.0-rc1 릴리스 태그로 전환합니다.-- ```bashgit checkout v1.0.0-rc1- ```-- Go 서비스와 종속 서비스를 백그라운드에서 시작합니다.-- ```bashdocker compose -f docker-compose.yml up -d```- 기본 MySQL 구성에서는 Go 이미지 진입점이 먼저 데이터베이스 마이그레이션을 실행한 다음 `bin/ragflow_server`를 통해 Syncer, Admin, API 및 Ingestor를 시작합니다.--> RAGFlow 오픈 소스 1.0의 DeepDoc은 레이아웃 분석, OCR, 표 인식에 CPU 추론을 사용합니다.--4. 시작 후 서비스 상태와 API 준비 상태를 확인하세요:-- ```bash- docker ps- ```-- 위 명령은 종속 서비스 상태를 표시합니다. RAGFlow 자체에는 Compose healthcheck가 정의되어 있지 않으므로 API를 통해 준비 상태를 확인하세요:+4. 서비스와 API 준비 상태를 확인합니다:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- HTTP 200 응답은 준비가 완료되었음을 의미합니다. `SVR_WEB_HTTP_PORT`를 변경했다면 상태 확인 URL에 해당 포트를 사용하세요. 시작에 실패하면 `docker logs --tail 50 <service>`로 관련 서비스 로그를 확인하세요.+5. 브라우저에서 `http://IP_OF_YOUR_MACHINE`을 열고 로그인합니다. 기본 구성에서는 HTTP 포트 `80`을 생략할 수 있습니다.-5. 웹 브라우저에 서버의 IP 주소를 입력하고 RAGFlow에 로그인하세요.- > 기본 설정을 사용할 경우, `http://IP_OF_YOUR_MACHINE`만 입력하면 됩니다 (포트 번호는 제외). 기본 HTTP 서비스 포트 `80`은 기본 구성으로 사용할 때 생략할 수 있습니다.-6. RAGFlow에 로그인한 뒤 모델 공급자 페이지에서 LLM, 임베딩 모델, 리랭커를 추가하고 모델 이름, 서비스 주소, API 키를 입력하세요.+6. 모델 공급자 페이지에서 LLM, Embedding, Reranker를 추가합니다. 자세한 내용은 [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)를 참조하세요.- > 자세한 내용은 [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)를 참조하세요.-- _이제 쇼가 시작됩니다!_+자세한 내용은 [빠른 시작](./docs/quickstart.mdx)을 참조하세요.#### ⚙️ Docker 구성 및 조정-Go Docker 배포는 `docker/.env`와 `docker/docker-compose.yml`을 사용하며, 캐시와 Checkpoint 저장에는 Kvrocks를, 메시지 큐에는 NATS JetStream을 사용합니다. 이미지, 포트, 비밀번호, 문서 엔진, 모델 이미지 소스를 변경하려면 [Docker 구성 가이드](./docker/README.md)를 따르세요. 플랫폼 지원(참고: macOS는 현재 지원되지 않음, Linux x86_64 호스트 사용 권장)은 [Go Docker 이미지 빌드 및 플랫폼 지원 가이드](./docs/develop/build_docker_image.mdx)를 참조하세요.--문서 엔진 전환, 구성 변경 후 서비스 재시작, 기존 데이터 보존 또는 삭제 작업도 위 Docker 구성 가이드를 따르세요.+`docker/.env`와 `docker/docker-compose.yml`을 사용합니다. [Docker 구성](./docker/README.md)과 [이미지 빌드 및 플랫폼 지원](./docs/develop/build_docker_image.mdx)을 참조하세요. macOS는 현재 지원되지 않습니다.-### 🔨 소스 코드로 서비스를 시작합니다.+### 🔨 소스 코드로 시작-#### 📝 소스 빌드 사전 요구 사항+#### 📝 사전 요구 사항-1. `go.mod`에 지정된 Go 버전(현재 Go 1.27), Clang 20, LLD 20, CMake 4.0 이상, PCRE2 개발 파일을 설치합니다. Go 서비스는 CGO와 네이티브 라이브러리에 의존하며 [build.sh](./build.sh)가 필요한 빌드 매개변수를 설정합니다.--2. 저장소를 클론하고 빌드에 필요한 네이티브 라이브러리와 모델 파일을 준비한 뒤 Go 서비스를 빌드합니다:+1. 저장소를 클론하고 `go.mod`에 지정된 Go, Clang 20, LLD 20, CMake ≥ 4.0, PCRE2 및 CGO에 필요한 네이티브 라이브러리를 설치합니다.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. 의존성을 준비합니다:+```bashpython3 -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```- 이 스크립트는 Go 빌드에 필요한 네이티브 라이브러리와 모델 리소스를 준비하며 `requests`와 `huggingface-hub`가 필요합니다. 같은 리소스를 다른 방법으로 준비했다면 이 단계를 건너뛸 수 있습니다. 저장소 루트에서 시작하면 Go 서비스가 `internal/rag/res/deepdoc`을 자동으로 찾습니다. 다른 디렉터리에서 시작하려면 `DEEPDOC_MODEL_DIR`을 해당 디렉터리의 절대 경로로 설정하세요.+3. 서비스를 빌드합니다:-3. Docker Compose를 사용하여 필요한 의존 서비스(Elasticsearch, MySQL, MinIO, NATS, Kvrocks, ClickHouse)를 시작합니다:+ ```bash+ ./build.sh --all+ ```++4. 로컬 의존 서비스를 시작합니다:```bashsudo 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+ docker compose --env-file docker/.env -f docker/docker-compose-base.yml up -d --wait es01 mysql minio nats kvrocks```- 소스에서 실행하는 Go 서비스는 `localhost:6379`로 Kvrocks에 연결하므로 제공된 구성에서는 `/etc/hosts`를 수정할 필요가 없습니다.+5. 데이터베이스를 마이그레이션합니다:++ ```bash+ ./bin/ragflow_server --migrate+ ```+6. 네 서비스를 네 터미널에서 시작합니다:-4. 데이터베이스 마이그레이션 후 서비스를 순서대로 시작합니다. 각 명령은 저장소 루트에서 별도의 터미널로 실행하고, 네 개의 서비스 터미널을 계속 열어 둡니다:+ 터미널 1: Admin (`9381`).```bash- ./bin/ragflow_server --migrate- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --admin+ ```++ ```bash+ ./bin/ragflow_server --ingestor```- 시작 모드의 역할은 다음과 같습니다:+ 터미널 3: Syncer.- - `--migrate`: 데이터베이스 마이그레이션을 실행한 뒤 종료합니다.- - `--admin`: 관리 및 초기화 작업을 위한 Admin 서비스를 시작합니다.- - `--ingestor`: 데이터 수집 및 파싱 작업을 위한 Ingestor 서비스를 시작합니다.- - `--syncer`: 데이터 동기화 작업을 위한 Syncer 서비스를 시작합니다.- - `--api`: Web UI, SDK 및 외부 클라이언트를 위한 API 서비스를 시작합니다.+ ```bash+ ./bin/ragflow_server --syncer+ ```- `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`를 별도로 실행하세요.-5. 프론트엔드를 개발할 때만 Node.js와 npm을 설치한 다음 React 프론트엔드를 시작합니다:+ 터미널 4: API (`9380`).```bash- cd web- npm install- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --api```- 다른 터미널에서 Go API가 준비되었는지 확인합니다:+7. 프런트엔드 개발 시에만 Node.js와 npm을 설치하고 API를 확인합니다:```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- HTTP 200 응답은 API가 정상적으로 응답함을 의미합니다. 개발이 끝나면 각 서비스 터미널에서 `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`을 실행합니다.-자세한 내용은 [소스에서 서비스 시작](./docs/develop/launch_ragflow_from_source.md)을 참조하세요.+> **운영 참고:** Elasticsearch 설정을 영구 적용하려면 `/etc/sysctl.conf`에 `vm.max_map_count=262144`를 추가하세요. 기본 MySQL 구성에서는 Docker 엔트리포인트가 마이그레이션 후 Admin, Syncer, Ingestor, API를 시작합니다. 오픈 소스 1.0의 DeepDoc은 레이아웃, OCR, 표 인식에 CPU 추론을 사용합니다. Docker 설정 변경 후 재시작과 데이터 유지·삭제는 [Docker 가이드](./docker/README.md)를 따르세요. `download_deps.py`는 네이티브 라이브러리와 모델을 준비하며 `requests`와 `huggingface-hub`를 사용합니다. `--migrate`는 마이그레이션 후 종료하고, `--admin`은 관리 서비스, `--ingestor`는 수집 서비스, `--syncer`는 외부 데이터 소스 동기화 서비스, `--api`는 Web UI와 SDK용 API 서비스를 시작합니다. HTTP 200은 API 준비 완료를 뜻합니다.+## 📚 문서- [Quickstart](https://ragflow.io/docs/dev/)diff --git a/README_pt_br.md b/README_pt_br.mdindex cdb85aedd9..303fd2843a 100644--- a/README_pt_br.md+++ b/README_pt_br.md@@ -56,13 +56,10 @@- 💡 [O que é o RAGFlow?](#-o-que-é-o-ragflow)- 🎮 [Primeiros Passos](#-primeiros-passos)-- 📌 [Últimas Atualizações](#-últimas-atualizações)+- 🔥 [Últimas Atualizações](#-últimas-atualizações)- 🌟 [Principais Funcionalidades](#-principais-funcionalidades)- 🔎 [Arquitetura do Sistema](#-arquitetura-do-sistema)-- 🎬 [Auto-hospedagem](#-auto-hospedagem)-- 🔧 [Configurações](#-configurações)-- 🔧 [Criar uma imagem Docker](#-criar-uma-imagem-docker)-- 🔨 [Lançar serviço a partir do código-fonte para desenvolvimento](#-lançar-o-serviço-a-partir-do-código-fonte-para-desenvolvimento)+- 🏠 [Implantação local](#-implantação-local)- 📚 [Documentação](#-documentação)- 📜 [Roadmap](#-roadmap)- 🏄 [Comunidade](#-comunidade)@@ -91,13 +88,8 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou- 2026-08-19 Lançado o Knowledge Compilation, que gera Wikis, Graphs, Trees, PageIndex, Mind Maps, Timelines e Skills nos níveis de documento e dataset.- 2026-08-19 Lançado o Agentic RAG com os modos de pensamento Low, Medium, High e Ultra.- 2026-07-02 Adicionadas a ingestão de dados do Google BigQuery e a sincronização incremental.-- 2026-06-29 Adicionados canais de chat para WhatsApp, DingTalk e WeCom.-- 2026-05-26 Adicionado o componente Browser, que permite aos Agents navegar e interagir com páginas da Web.-- 2026-04-21 Adicionados sete modelos integrados de pipeline de ingestão de dados.-- 2026-04-21 Adicionadas a publicação de aplicações Agent, a execução de código em sandbox e a geração de gráficos.-- 2026-04-21 Adicionados o armazenamento e a recuperação de memória em nível de usuário.-Consulte as [notas de versão completas](./docs/release_notes.md) para ver outras atualizações.+Consulte as [notas de versão completas](https://ragflow.io/docs/dev/release_notes) para ver outras atualizações.## 🎉 Fique Ligado@@ -136,7 +128,7 @@ Consulte as [notas de versão completas](./docs/release_notes.md) para ver outra### 🍔 **Compatibilidade com fontes de dados heterogêneas**-- Suporta Word, apresentações, excel, txt, imagens, cópias digitalizadas, dados estruturados, páginas da web e mais.+- Suporta documentos Word, apresentações PowerPoint, planilhas Excel, arquivos TXT, imagens, PDFs, cópias digitalizadas, dados estruturados, páginas da web e mais.### 🛀 **Fluxo de trabalho RAG automatizado e sem esforço**@@ -148,194 +140,138 @@ Consulte as [notas de versão completas](./docs/release_notes.md) para ver outra## 🔎 Arquitetura do Sistema<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="Arquitetura do sistema RAGFlow" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 Auto-hospedagem+## 🏠 Implantação local-### 🐳 Implantação com Docker--#### 📝 Pré-requisitos da implantação com Docker+O Docker é indicado para avaliação rápida, testes de integração e produção; o código-fonte é indicado para desenvolvimento e depuração. O Docker não exige Go. O código-fonte requer a versão do Go em `go.mod`; o frontend também requer Node.js e npm.-- Configuração inicial recomendada: 4 núcleos de CPU, 16 GB de RAM e 50 GB de espaço em disco disponível. Os requisitos reais dependem do mecanismo de documentos, volume de dados, tarefas de análise e concorrência. Modelos locais e outros componentes opcionais podem exigir recursos adicionais.-- Docker >= 24.0.0 & Docker Compose >= v2.26.1-- [gVisor](https://gvisor.dev/docs/user_guide/install/): Necessário somente ao usar o Sandbox de contêineres Self-Managed.+### 🐳 Implantação com Docker-A implantação Docker não exige a instalação do Go no host. O Sandbox de contêineres Self-Managed exige instalação e configuração do gVisor; outros provedores de Sandbox não exigem gVisor no host do RAGFlow.+#### 📝 Pré-requisitos-> [!TIP]-> Se você não instalou o Docker na sua máquina local (Windows, Mac ou Linux), veja [Instalar Docker Engine](https://docs.docker.com/engine/install/).+- Configuração inicial recomendada: 4 núcleos de CPU, 16 GB de RAM e 50 GB de espaço livre em disco.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.#### 🚀 Iniciar o servidor-1. Certifique-se de que `vm.max_map_count` >= 262144:+1. Se você usa Elasticsearch, defina `vm.max_map_count` como pelo menos `262144` no host Docker antes de iniciar o Compose. Com Infinity, normalmente essa etapa não é necessária:- > Para verificar o valor de `vm.max_map_count`:+ > Para verificar o valor atual de `vm.max_map_count`:>> ```bash> sysctl vm.max_map_count> ```>- > Se necessário, redefina `vm.max_map_count` para um valor de pelo menos 262144:+ > Se o valor for inferior a `262144`, redefina-o:>> ```bash- > # Neste caso, defina para 262144:> sudo sysctl -w vm.max_map_count=262144> ```>- > Essa mudança será resetada após a reinicialização do sistema. Para garantir que a alteração permaneça permanente, adicione ou atualize o valor de `vm.max_map_count` em **/etc/sysctl.conf**:- >- > ```bash- > vm.max_map_count=262144- > ```- >-2. Clone o repositório:-- ```bash- git clone https://github.com/infiniflow/ragflow.git- ```-3. Mude para a tag de lançamento Go e inicie a imagem Go pré-criada com o Docker Compose:+ > Essa alteração será perdida após a reinicialização do sistema. Para mantê-la, adicione `vm.max_map_count=262144` a **/etc/sysctl.conf**.+2. `git clone https://github.com/infiniflow/ragflow.git`-- Entre no diretório de implantação do Docker.+3. Docker:```bashcd ragflow/docker- ```-- Mude para a tag de lançamento Go v1.0.0-rc1.-- ```bashgit checkout v1.0.0-rc1- ```-- Inicie os serviços Go e suas dependências em segundo plano.-- ```bashdocker compose -f docker-compose.yml up -d```- Na configuração padrão do MySQL, o entrypoint da imagem executa as migrações do banco de dados e inicia Syncer, Admin, API e Ingestor por meio de `bin/ragflow_server`. No RAGFlow open-source 1.0, DeepDoc usa inferência por CPU para análise de layout, OCR e reconhecimento de tabelas.--4. Verifique o estado dos serviços e a prontidão da API após a inicialização:-- ```bash- docker ps- ```-- O comando acima exibe o estado das dependências. O RAGFlow não define um healthcheck do Compose; confirme a prontidão pela API:+4. Verifique o estado dos serviços e a prontidão da API:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- Uma resposta HTTP 200 indica que o serviço está pronto. Se `SVR_WEB_HTTP_PORT` foi alterado, use essa porta na URL de verificação. Se a inicialização falhar, consulte os logs do serviço correspondente com `docker logs --tail 50 <service>`.-5. No seu navegador, insira o endereço IP do seu servidor e faça login no RAGFlow.+5. Abra `http://IP_OF_YOUR_MACHINE` no navegador e faça login. Com a configuração padrão, a porta HTTP `80` pode ser omitida.- > Com as configurações padrão, você só precisa digitar `http://IP_DO_SEU_MÁQUINA` (**sem** o número da porta), pois a porta HTTP padrão `80` pode ser omitida ao usar as configurações padrão.- >-6. Após entrar, adicione um LLM, um modelo de embedding e um reranker na página de provedores de modelos, incluindo o nome do modelo, o endereço do serviço e a chave de API.+6. Adicione LLM, Embedding e Reranker na página de provedores de modelos. Consulte [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup).-_O show está no ar!_+Consulte o [guia de início rápido](./docs/quickstart.mdx).#### ⚙️ Configuração e ajustes do Docker-A implantação Go com Docker usa `docker/.env` e `docker/docker-compose.yml`, com Kvrocks para cache e armazenamento de Checkpoints e NATS JetStream como fila de mensagens. Para configurar imagem, portas, senhas, mecanismo de documentos e origem das imagens de modelos, consulte o [guia de configuração do Docker](./docker/README.md). Para suporte de plataforma (observação: macOS não é suportado temporariamente, use um host Linux x86_64), consulte o [guia de build da imagem Go e suporte a plataformas](./docs/develop/build_docker_image.mdx).--Para trocar o mecanismo de documentos, alterar configurações, reiniciar serviços e manter ou remover dados existentes, siga também o guia de configuração do Docker.+Use `docker/.env` e `docker/docker-compose.yml`. Consulte a [configuração do Docker](./docker/README.md) e o [build da imagem e suporte de plataforma](./docs/develop/build_docker_image.mdx). O macOS não é suportado atualmente.-### 🔨 Lançar o serviço a partir do código-fonte para desenvolvimento+### 🔨 Executar pelo código-fonte-#### 📝 Pré-requisitos da compilação a partir do código-fonte+#### 📝 Pré-requisitos-1. Instale a versão do Go especificada em `go.mod` (atualmente Go 1.27), Clang 20, LLD 20, CMake 4.0 ou superior e os arquivos de desenvolvimento do PCRE2. Os serviços Go dependem de CGO e bibliotecas nativas; o [build.sh](./build.sh) configura os parâmetros necessários.-2. Clone o repositório, prepare as bibliotecas nativas e os arquivos de modelo necessários e compile os serviços Go:+1. Clone o repositório e instale o Go indicado em `go.mod`, Clang 20, LLD 20, CMake ≥ 4.0, PCRE2 e as bibliotecas nativas exigidas pelo CGO.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. Prepare as dependências:+```bashpython3 -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```- O script prepara as bibliotecas nativas e os recursos de modelo necessários para o build Go e requer `requests` e `huggingface-hub`. Ignore esta etapa se você já preparou os mesmos recursos de outra forma. Quando iniciados na raiz do repositório, os serviços Go encontram automaticamente `internal/rag/res/deepdoc`; para iniciar em outro diretório, defina `DEEPDOC_MODEL_DIR` como o caminho absoluto correspondente.-3. Inicie as dependências necessárias (Elasticsearch, MySQL, MinIO, NATS, Kvrocks e ClickHouse) usando Docker Compose:+3. Compile os serviços:```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```- Os serviços Go iniciados pelo código-fonte acessam o Kvrocks exposto pelo Compose em `localhost:6379`; os serviços Docker usam o nome do host na rede dos contêineres. A configuração fornecida não exige alterações em `/etc/hosts`.-4. Execute primeiro a migração e depois inicie Admin, Ingestor, Syncer e API em quatro terminais separados, sempre na raiz do repositório. O terminal da migração pode ser fechado quando o comando terminar; os outros quatro devem permanecer abertos:-- Terminal 1: migração+4. Inicie as dependências locais:```bash- ./bin/ragflow_server --migrate+ 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```- Terminal 2: Admin, porta de destino 9381+5. Migre o banco de dados:```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin+ ./bin/ragflow_server --migrate```- Terminal 3: Ingestor+6. Inicie os quatro serviços em quatro terminais:- ```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor- ```-- Terminal 4: Syncer+ Terminal 1: Admin (`9381`).```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer+ ./bin/ragflow_server --admin```- Terminal 5: API, porta de destino 9380-```bash- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --ingestor```- Os modos de inicialização funcionam assim:-- - `--migrate`: Executa as migrações do banco de dados e encerra.- - `--admin`: Inicia o serviço Admin para operações de gerenciamento e inicialização.- - `--ingestor`: Inicia o serviço Ingestor para tarefas de ingestão e análise de dados.- - `--syncer`: Inicia o serviço Syncer para tarefas de sincronização de dados.- - `--api`: Inicia o serviço API para a interface Web, SDKs e clientes externos.-- `RAGFLOW_DEV_MODE=true` é exclusivo para desenvolvimento. Ele desativa a verificação de downgrade entre o código e as migrações, mas não executa migrações nem altera o esquema. Não o use em produção. Depois da migração, `RAGFLOW_DEV_MODE=true bash build.sh --run` pode iniciar Admin, Ingestor e API, mas não inicia o Syncer. Para iniciar a cadeia completa de serviços, execute separadamente `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer`.-5. Instale Node.js e npm somente se for desenvolver o front-end:+ Terminal 3: Syncer.```bash- cd web- npm install+ ./bin/ragflow_server --syncer```- Em seguida, inicie o serviço de front-end:++ Terminal 4: API (`9380`).```bash- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --api```- Em outro terminal, confirme que a API Go está pronta:+7. Somente para o frontend, instale Node.js e npm e verifique a API:```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- Uma resposta HTTP 200 indica que a API está respondendo. Ao concluir o desenvolvimento, pressione `Ctrl+C` em cada terminal de serviço. Para interromper as dependências mantendo os contêineres, execute `docker compose --env-file docker/.env -f docker/docker-compose-base.yml stop es01 mysql minio nats kvrocks clickhouse`. Para remover os contêineres de dependência e a rede Compose mantendo os volumes nomeados, execute `docker compose --env-file docker/.env -f docker/docker-compose-base.yml down`.+Consulte [Iniciar pelo código-fonte](./docs/develop/launch_ragflow_from_source.md) para detalhes.-Consulte [Iniciar o serviço a partir do código-fonte](./docs/develop/launch_ragflow_from_source.md) para obter detalhes.+> **Notas operacionais:** para tornar o ajuste do Elasticsearch permanente, adicione `vm.max_map_count=262144` a `/etc/sysctl.conf`. Com o MySQL padrão, o entrypoint Docker executa a migração antes de iniciar Admin, Syncer, Ingestor e API. No open source 1.0, o DeepDoc usa CPU para layout, OCR e tabelas. Após alterar o Docker, reinicie os serviços e siga o [guia Docker](./docker/README.md) para manter ou remover dados. `download_deps.py` prepara bibliotecas nativas e modelos e requer `requests` e `huggingface-hub`. `--migrate` migra e encerra; `--admin` inicia o serviço de administração, `--ingestor` o serviço de ingestão, `--syncer` o serviço de sincronização de fontes de dados externas e `--api` o serviço de API para a interface Web e os SDKs. HTTP 200 indica que a API está pronta.## 📚 Documentação@@ -359,5 +295,4 @@ Veja o [RAGFlow Roadmap 2026](https://github.com/infiniflow/ragflow/issues/12241## 🙌 Contribuindo-O RAGFlow prospera por meio da colaboração de código aberto. Com esse espírito, abraçamos contribuições diversas da comunidade.-Se você deseja fazer parte, primeiro revise nossas [Diretrizes de Contribuição](https://ragflow.io/docs/dev/contributing).+O RAGFlow prospera por meio da colaboração de código aberto. Com esse espírito, abraçamos contribuições diversas da comunidade. Se você deseja fazer parte, primeiro revise nossas [Diretrizes de Contribuição](https://ragflow.io/docs/dev/contributing).diff --git a/README_ru.md b/README_ru.mdindex 7c5c54d0c0..79914e93f2 100644--- a/README_ru.md+++ b/README_ru.md@@ -56,13 +56,10 @@- 💡 [Что такое RAGFlow?](#-что-такое-ragflow)- 🎮 [Начало работы](#-начало-работы)-- 📌 [Последние обновления](#-последние-обновления)+- 🔥 [Последние обновления](#-последние-обновления)- 🌟 [Ключевые возможности](#-ключевые-возможности)- 🔎 [Архитектура системы](#-архитектура-системы)-- 🎬 [Самостоятельное развёртывание](#-самостоятельное-развёртывание)-- 🔧 [Конфигурация](#-конфигурация)-- 🔧 [Сборка Docker-образа](#-сборка-docker-образа)-- 🔨 [Запуск из исходников для разработки](#-запуск-из-исходников-для-разработки)+- 🏠 [Локальное развёртывание](#-локальное-развёртывание)- 📚 [Документация](#-документация)- 📜 [Дорожная карта](#-дорожная-карта)- 🏄 [Сообщество](#-сообщество)@@ -93,13 +90,8 @@- 2026-08-19 Представлена Knowledge Compilation для создания 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, DingTalk и WeCom.-- 2026-05-26 Добавлен компонент Browser для просмотра и взаимодействия агентов с веб-страницами.-- 2026-04-21 Добавлены семь встроенных шаблонов конвейеров ingest данных.-- 2026-04-21 Добавлены публикация приложений Agent, выполнение кода в sandbox и генерация диаграмм.-- 2026-04-21 Добавлены хранение и поиск пользовательской памяти.-Другие обновления см. в [полных примечаниях к выпускам](./docs/release_notes.md).+Другие обновления см. в [полных примечаниях к выпускам](https://ragflow.io/docs/dev/release_notes).## 🎉 Следите за обновлениями@@ -138,7 +130,7 @@### 🍔 **Работа с разнородными источниками данных**-- Поддержка Word, презентаций, Excel, txt, изображений, сканов, структурированных данных, веб-страниц и многого другого.+- Поддержка документов Word, презентаций PowerPoint, таблиц Excel, файлов TXT, изображений, PDF, сканов, структурированных данных, веб-страниц и многого другого.### 🛀 **Автоматизированный и простой RAG-пайплайн**@@ -150,179 +142,124 @@## 🔎 Архитектура системы<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="Архитектура RAGFlow" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 Самостоятельное развёртывание+## 🏠 Локальное развёртывание-### 🐳 Развёртывание с Docker+Docker подходит для быстрой оценки, интеграционных тестов и production, а запуск из исходников — для разработки и отладки. Docker не требует Go. Для исходников нужна версия Go из `go.mod`, а для frontend — Node.js и npm.-#### 📝 Требования к развёртыванию с Docker+### 🐳 Развёртывание Docker-- Рекомендуемая начальная конфигурация: 4 ядра CPU, 16 ГБ RAM и 50 ГБ свободного места на диске. Фактические требования зависят от движка документов, объёма данных, задач анализа и параллельной нагрузки. Для локальных моделей и других дополнительных компонентов могут потребоваться дополнительные ресурсы.-- 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 gVisor на хосте RAGFlow не требуется.--> [!TIP]-> Если Docker ещё не установлен (Windows, Mac или Linux), см. [Install Docker Engine](https://docs.docker.com/engine/install/).+- Рекомендуемая начальная конфигурация: 4 ядра CPU, 16 ГБ RAM и 50 ГБ свободного места.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.#### 🚀 Запуск сервера-1. Убедитесь, что `vm.max_map_count` ≥ 262144:-- > Проверить текущее значение:- >- > ```bash- > sysctl vm.max_map_count- > ```- >- > Если значение меньше 262144, установите:- >- > ```bash- > sudo sysctl -w vm.max_map_count=262144- > ```- >- > Чтобы изменение сохранилось после перезагрузки, добавьте в **/etc/sysctl.conf**:- >- > ```bash- > vm.max_map_count=262144- > ```--2. Клонируйте репозиторий:-- ```bash- git clone https://github.com/infiniflow/ragflow.git- ```--3. Переключитесь на тег релиза Go и запустите готовый образ Go с помощью Docker Compose:+1. Elasticsearch: `vm.max_map_count` ≥ 262144.-> [!CAUTION]-> Все образы собраны под x86. Образов для ARM64 пока нет.-> Если вы на ARM64, следуйте [этому руководству](https://ragflow.io/docs/dev/build_docker_image), чтобы собрать образ самостоятельно.+2. `git clone https://github.com/infiniflow/ragflow.git`- Перейдите в каталог развертывания Docker.+3. Docker:```bashcd ragflow/docker- ```-- Переключитесь на тег релиза Go v1.0.0-rc1.-- ```bashgit checkout v1.0.0-rc1- ```-- Запустите службы Go и их зависимости в фоновом режиме.-- ```bashdocker compose -f docker-compose.yml up -d```- В конфигурации MySQL по умолчанию точка входа Go-образа сначала выполняет миграции базы данных, а затем запускает Syncer, Admin, API и Ingestor через `bin/ragflow_server`.--> В открытой версии RAGFlow 1.0 DeepDoc использует CPU для анализа макета, OCR и распознавания таблиц.--4. После запуска проверьте состояние сервисов и готовность API:-- ```bash- docker ps- ```-- Команда выше показывает состояние зависимостей. В RAGFlow не определён Compose healthcheck; подтвердите готовность через API:+4. Проверьте состояние сервисов и готовность API:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- Ответ HTTP 200 означает готовность. Если вы изменили `SVR_WEB_HTTP_PORT`, используйте этот порт в URL проверки. Если запуск завершился ошибкой, проверьте журналы соответствующего сервиса командой `docker logs --tail 50 <service>`.--5. Откройте в браузере IP-адрес сервера и войдите в RAGFlow.-- > При стандартных настройках достаточно `http://IP_ВАШЕЙ_МАШИНЫ` (порт 80 можно не указывать).+5. Откройте `http://IP_OF_YOUR_MACHINE` в браузере и войдите в систему. При стандартной конфигурации HTTP-порт `80` можно не указывать.-6. После входа добавьте LLM, модель эмбеддингов и reranker на странице поставщиков моделей, затем укажите имя модели, адрес сервиса и API-ключ.+6. Добавьте LLM, Embedding и Reranker на странице поставщиков моделей. Подробнее: [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup).- > Подробнее: [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup).-- _Готово!_+Подробнее см. в [кратком руководстве](./docs/quickstart.mdx).#### ⚙️ Настройка Docker-Развёртывание Go в Docker использует `docker/.env` и `docker/docker-compose.yml`, Kvrocks для кэша и хранения Checkpoint, а NATS JetStream — в качестве очереди сообщений. Изменяйте образ, порты, пароли, движок документов и источник образов моделей в соответствии с [руководством по настройке Docker](./docker/README.md). Поддержка платформ (примечание: macOS временно не поддерживается, используйте хост Linux x86_64) описана в [руководстве по сборке Go-образа и поддержке платформ](./docs/develop/build_docker_image.mdx).--При смене движка документов, изменении конфигурации и перезапуске сервисов, а также при сохранении или удалении существующих данных следуйте этому же руководству по настройке Docker.--### 🔨 Запуск из исходников для разработки+Используйте `docker/.env` и `docker/docker-compose.yml`. См. [настройку Docker](./docker/README.md) и [сборку образа и поддержку платформ](./docs/develop/build_docker_image.mdx). macOS сейчас не поддерживается.-#### 📝 Требования для сборки из исходников+### 🔨 Запуск из исходников-1. Установите версию Go из `go.mod` (сейчас Go 1.27), Clang 20, LLD 20, CMake 4.0 или новее и файлы разработки PCRE2. Сервисам Go нужны CGO и нативные библиотеки; [build.sh](./build.sh) задаёт необходимые параметры сборки.+#### 📝 Требования-2. Клонируйте репозиторий, подготовьте нативные библиотеки и файлы моделей, затем соберите сервисы Go:+1. Клонируйте репозиторий и установите Go из `go.mod`, Clang 20, LLD 20, CMake ≥ 4.0, PCRE2 и нативные библиотеки для CGO.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. Подготовьте зависимости:+```bashpython3 -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```- Скрипт подготавливает нативные библиотеки и ресурсы моделей для сборки Go и требует `requests` и `huggingface-hub`. Пропустите этот шаг, если те же ресурсы подготовлены другим способом. При запуске из корня репозитория сервисы Go автоматически находят `internal/rag/res/deepdoc`; для запуска из другого каталога задайте `DEEPDOC_MODEL_DIR` как абсолютный путь к нему.+3. Соберите сервисы:-3. Запустите необходимые зависимости (Elasticsearch, MySQL, MinIO, NATS, Kvrocks и ClickHouse):+ ```bash+ ./build.sh --all+ ```++4. Запустите локальные зависимости:```bashsudo 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+ docker compose --env-file docker/.env -f docker/docker-compose-base.yml up -d --wait es01 mysql minio nats kvrocks```- Сервисы Go, запущенные из исходного кода, подключаются к Kvrocks через `localhost:6379`; предоставленная конфигурация не требует изменения `/etc/hosts`.+5. Выполните миграцию базы данных:++ ```bash+ ./bin/ragflow_server --migrate+ ```+6. Запустите четыре сервиса в четырёх терминалах:-4. После миграции базы данных запустите сервисы по порядку. Выполняйте каждую команду в отдельном терминале из корня репозитория и оставьте открытыми четыре терминала сервисов:+ Терминал 1: Admin (`9381`).```bash- ./bin/ragflow_server --migrate- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api+ ./bin/ragflow_server --admin```- Режимы запуска работают следующим образом:+ ```bash+ ./bin/ragflow_server --ingestor+ ```- - `--migrate`: выполняет миграции базы данных и завершает работу.- - `--admin`: запускает сервис Admin для управления и инициализации.- - `--ingestor`: запускает сервис Ingestor для приёма и анализа данных.- - `--syncer`: запускает сервис Syncer для синхронизации данных.- - `--api`: запускает API для веб-интерфейса, SDK и внешних клиентов.+ Терминал 3: Syncer.++ ```bash+ ./bin/ragflow_server --syncer+ ```- `RAGFLOW_DEV_MODE=true` предназначен только для разработки. Он отключает проверку отката между версиями кода и миграций базы данных, но не запускает миграции и не изменяет схему. Не используйте его в production. Запускайте Admin раньше остальных сервисов. После миграции `RAGFLOW_DEV_MODE=true bash build.sh --run` запускает Admin, Ingestor и API, но не Syncer; для полной цепочки отдельно выполните `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer`.-5. Только для разработки фронтенда установите Node.js и npm, затем запустите React-фронтенд:+ Терминал 4: API (`9380`).```bash- cd web- npm install- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --api```- В другом терминале проверьте готовность Go API:+7. Только для frontend установите Node.js и npm и проверьте API:```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- Ответ HTTP 200 означает, что API отвечает. После разработки нажмите `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`.+Подробнее см. [Запуск из исходников](./docs/develop/launch_ragflow_from_source.md).-Подробнее см. [Запуск сервиса из исходников](./docs/develop/launch_ragflow_from_source.md).+> **Эксплуатационные примечания:** для постоянной настройки Elasticsearch добавьте `vm.max_map_count=262144` в `/etc/sysctl.conf`. При стандартном MySQL точка входа Docker выполняет миграцию перед запуском Admin, Syncer, Ingestor и API. В open-source 1.0 DeepDoc использует CPU для анализа макета, OCR и таблиц. После изменения Docker перезапустите сервисы и следуйте [руководству Docker](./docker/README.md) для сохранения или удаления данных. `download_deps.py` подготавливает нативные библиотеки и модели и требует `requests` и `huggingface-hub`. `--migrate` выполняет миграцию и завершается; `--admin` запускает службу администрирования, `--ingestor` — службу загрузки данных, `--syncer` — службу синхронизации внешних источников данных, а `--api` — службу API для Web UI и SDK. HTTP 200 означает готовность API.## 📚 Документация@@ -346,5 +283,4 @@## 🙌 Участие в разработке-RAGFlow развивается как open-source проект. Мы рады любым вкладам сообщества.-Если хотите помочь — сначала ознакомьтесь с [Contribution Guidelines](https://ragflow.io/docs/dev/contributing).+RAGFlow развивается как open-source проект. Мы рады любым вкладам сообщества. Если хотите помочь — сначала ознакомьтесь с [Contribution Guidelines](https://ragflow.io/docs/dev/contributing).diff --git a/README_tr.md b/README_tr.mdindex 0610ab5495..7f38c24628 100644--- a/README_tr.md+++ b/README_tr.md@@ -56,13 +56,10 @@- 💡 [RAGFlow Nedir?](#-ragflow-nedir)- 🎮 [Başlarken](#-başlarken)-- 📌 [Son Güncellemeler](#-son-güncellemeler)+- 🔥 [Son Güncellemeler](#-son-güncellemeler)- 🌟 [Temel Özellikler](#-temel-özellikler)- 🔎 [Sistem Mimarisi](#-sistem-mimarisi)-- 🎬 [Kendi Sunucusunda Barındırma](#-kendi-sunucusunda-barındırma)-- 🔧 [Yapılandırmalar](#-yapılandırmalar)-- 🔧 [Docker İmajı Oluşturma](#-docker-i̇majı-oluşturma)-- 🔨 [Geliştirme İçin Kaynaktan Hizmet Başlatma](#-geliştirme-i̇çin-kaynaktan-hizmet-başlatma)+- 🏠 [Yerel Dağıtım](#-yerel-dağıtım)- 📚 [Dokümantasyon](#-dokümantasyon)- 📜 [Yol Haritası](#-yol-haritası)- 🏄 [Topluluk](#-topluluk)@@ -93,13 +90,8 @@ Yerel dağıtım için [Kendi Sunucusunda Barındırma](#-kendi-sunucusunda-bar- 2026-08-19 Belge ve veri kümesi düzeyinde Wiki, Graph, Tree, PageIndex, Mind Map, Timeline ve Skills üretmek için Knowledge Compilation tanıtıldı.- 2026-08-19 Low, Medium, High ve Ultra düşünme modlarına sahip Agentic RAG tanıtıldı.- 2026-07-02 Google BigQuery veri kaynağı alımı ve artımlı eşitleme eklendi.-- 2026-06-29 WhatsApp, DingTalk ve WeCom sohbet kanalları eklendi.-- 2026-05-26 Agent'ların web sayfalarında gezinip işlem yapmasını sağlayan Browser bileşeni eklendi.-- 2026-04-21 Yedi yerleşik veri alım hattı şablonu eklendi.-- 2026-04-21 Agent uygulamalarını yayımlama, sandbox kod yürütme ve grafik oluşturma eklendi.-- 2026-04-21 Kullanıcı düzeyinde bellek depolama ve erişimi eklendi.-Diğer güncellemeler için [tam sürüm notlarına](./docs/release_notes.md) bakın.+Diğer güncellemeler için [tam sürüm notlarına](https://ragflow.io/docs/dev/release_notes) bakın.## 🎉 Bizi Takip Edin@@ -138,7 +130,7 @@ Diğer güncellemeler için [tam sürüm notlarına](./docs/release_notes.md) ba### 🍔 **Heterojen veri kaynaklarıyla uyumluluk**-- Word, slaytlar, Excel, txt, görseller, taranmış kopyalar, yapılandırılmış veriler, web sayfaları ve daha fazlasını destekler.+- Word belgelerini, PowerPoint sunumlarını, Excel tablolarını, TXT dosyalarını, görselleri, PDF'leri, taranmış kopyaları, yapılandırılmış verileri, web sayfalarını ve daha fazlasını destekler.### 🛀 **Otomatik ve zahmetsiz RAG iş akışı**@@ -150,179 +142,124 @@ Diğer güncellemeler için [tam sürüm notlarına](./docs/release_notes.md) ba## 🔎 Sistem Mimarisi<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow sistem mimarisi" width="1000" />+<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 Kendi Sunucusunda Barındırma+## 🏠 Yerel Dağıtım-### 🐳 Docker Dağıtımı--#### 📝 Docker Dağıtımı Ön Koşulları+Docker hızlı değerlendirme, entegrasyon testi ve üretim; kaynak kod ise geliştirme ve hata ayıklama için uygundur. Docker Go gerektirmez. Kaynak kod `go.mod` içindeki Go sürümünü, ön yüz ise Node.js ve npm'i gerektirir.-- Önerilen başlangıç yapılandırması: 4 CPU çekirdeği, 16 GB RAM ve 50 GB kullanılabilir disk alanı. Gerçek gereksinimler belge motoruna, veri hacmine, ayrıştırma görevlerine ve eşzamanlılığa bağlıdır. Yerel modeller ve diğer isteğe bağlı bileşenler ek kaynak gerektirebilir.-- Docker >= 24.0.0 & Docker Compose >= v2.26.1-- [gVisor](https://gvisor.dev/docs/user_guide/install/): Yalnızca Self-Managed kapsayıcı Sandbox kullanılırken gereklidir.+### 🐳 Docker Dağıtımı-Docker dağıtımı ana makineye Go kurulmasını gerektirmez. Self-Managed kapsayıcı Sandbox, gVisor kurulumu ve yapılandırması gerektirir; diğer Sandbox sağlayıcıları RAGFlow ana makinesinde gVisor gerektirmez.+#### 📝 Ön Koşullar-> [!TIP]-> Yerel makinenize (Windows, Mac veya Linux) Docker yüklemediyseniz, [Docker Engine Kurulumu](https://docs.docker.com/engine/install/) sayfasına bakın.+- Önerilen başlangıç yapılandırması: 4 CPU çekirdeği, 16 GB RAM ve 50 GB boş disk alanı.+- Docker ≥ 24.0.0, Docker Compose ≥ v2.26.1.#### 🚀 Sunucuyu Başlatma-1. `vm.max_map_count` değerinin >= 262144 olduğundan emin olun:-- > `vm.max_map_count` değerini kontrol etmek için:- >- > ```bash- > sysctl vm.max_map_count- > ```- >- > Değer 262144'ten düşükse, en az 262144 olarak ayarlayın.- >- > ```bash- > # Bu örnekte 262144 olarak ayarlıyoruz:- > sudo sysctl -w vm.max_map_count=262144- > ```- >- > Bu değişiklik sistem yeniden başlatıldığında sıfırlanacaktır. Değişikliğin kalıcı olmasını sağlamak için- > **/etc/sysctl.conf** dosyasındaki `vm.max_map_count` değerini buna göre ekleyin veya güncelleyin:- >- > ```bash- > vm.max_map_count=262144- > ```- >-2. Depoyu klonlayın:+1. Elasticsearch: `vm.max_map_count` ≥ 262144.- ```bash- git clone https://github.com/infiniflow/ragflow.git- ```-3. Go sürüm etiketine geçin ve önceden oluşturulmuş Go imajını Docker Compose ile başlatın:+2. `git clone https://github.com/infiniflow/ragflow.git`-> [!CAUTION]-> Tüm Docker imajları x86 platformları için oluşturulmuştur. Şu anda ARM64 için Docker imajı sunmuyoruz.-> ARM64 platformundaysanız, sisteminizle uyumlu bir Docker imajı oluşturmak için [bu kılavuzu](https://ragflow.io/docs/dev/build_docker_image) takip edin.-- Docker dağıtım dizinine girin.+3. Docker:```bashcd ragflow/docker- ```-- Go v1.0.0-rc1 sürüm etiketine geçin.-- ```bashgit checkout v1.0.0-rc1- ```-- Go hizmetlerini ve bağımlılıklarını arka planda başlatın.-- ```bashdocker compose -f docker-compose.yml up -d```- Varsayılan MySQL yapılandırmasında Go imajı giriş noktası önce veritabanı geçişlerini çalıştırır, ardından `bin/ragflow_server` aracılığıyla Syncer, Admin, API ve Ingestor hizmetlerini başlatır.--> RAGFlow açık kaynak 1.0 sürümünde DeepDoc, düzen analizi, OCR ve tablo tanıma için CPU çıkarımı kullanır.--4. Başlatma sonrasında hizmet durumunu ve API hazır olma durumunu kontrol edin:-- ```bash- docker ps- ```-- Yukarıdaki komut bağımlılıkların durumunu gösterir. RAGFlow bir Compose healthcheck tanımlamaz; hazır olma durumunu API üzerinden doğrulayın:+4. Hizmet durumunu ve API hazırlığını kontrol edin:```bashcurl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- HTTP 200 yanıtı hazır olunduğunu gösterir. `SVR_WEB_HTTP_PORT` değerini değiştirdiyseniz sağlık kontrolü URL'sinde bu portu kullanın. Başlatma başarısız olursa ilgili hizmetin günlüklerini `docker logs --tail 50 <service>` ile inceleyin.--5. Web tarayıcınıza sunucunuzun IP adresini girin ve RAGFlow'a giriş yapın.+5. Tarayıcıda `http://IP_OF_YOUR_MACHINE` adresini açıp oturum açın. Varsayılan yapılandırmada HTTP bağlantı noktası `80` yazılmayabilir.- > Varsayılan ayarlarla, yalnızca `http://MAKİNENİZİN_IP_ADRESİ` girmeniz yeterlidir (port numarası **gerekmez**),- > çünkü varsayılan HTTP sunucu portu `80` varsayılan yapılandırmalar kullanıldığında ihmal edilebilir.- >-6. RAGFlow'a giriş yaptıktan sonra model sağlayıcıları sayfasından LLM, embedding modeli ve reranker ekleyin; model adını, servis adresini ve API anahtarını girin.+6. Model sağlayıcıları sayfasında LLM, Embedding ve Reranker ekleyin. Ayrıntılar için [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) sayfasına bakın.- > Daha fazla bilgi için [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) sayfasına bakın.- >-- _Gösteri başlasın!_+Ayrıntılar için [hızlı başlangıç kılavuzuna](./docs/quickstart.mdx) bakın.#### ⚙️ Docker Yapılandırması ve Ayarlama-Go Docker dağıtımı `docker/.env` ve `docker/docker-compose.yml` dosyalarını kullanır; önbellek ve Checkpoint depolaması için Kvrocks, mesaj kuyruğu olarak da NATS JetStream kullanılır. İmajı, bağlantı noktalarını, parolaları, belge motorunu ve model imajı kaynağını değiştirmek için [Docker yapılandırma kılavuzunu](./docker/README.md) izleyin. Platform desteği (not: macOS geçici olarak desteklenmiyor, Linux x86_64 ana makinesi kullanın) için [Go Docker imajı oluşturma ve platform desteği kılavuzuna](./docs/develop/build_docker_image.mdx) bakın.--Belge motorunu değiştirme, yapılandırma değişikliklerinden sonra hizmetleri yeniden başlatma ve mevcut verileri koruma veya temizleme işlemleri için de yukarıdaki Docker yapılandırma kılavuzunu izleyin.+`docker/.env` ve `docker/docker-compose.yml` dosyalarını kullanın. [Docker yapılandırmasına](./docker/README.md) ve [imaj oluşturma ve platform desteğine](./docs/develop/build_docker_image.mdx) bakın. macOS şu anda desteklenmemektedir.-### 🔨 Geliştirme İçin Kaynaktan Hizmet Başlatma+### 🔨 Kaynaktan Başlatma-#### 📝 Kaynaktan Derleme Ön Koşulları+#### 📝 Ön Koşullar-1. `go.mod` dosyasında belirtilen Go sürümünü (şu anda Go 1.27), Clang 20, LLD 20, CMake 4.0 veya üzerini ve PCRE2 geliştirme dosyalarını yükleyin. Go hizmetleri CGO ve yerel kitaplıklara bağlıdır; [build.sh](./build.sh) gerekli derleme parametrelerini ayarlar.-2. Depoyu klonlayın, gerekli yerel kitaplıkları ve model dosyalarını hazırlayın, ardından Go hizmetlerini derleyin:+1. Depoyu klonlayın ve `go.mod` içindeki Go sürümünü, Clang 20, LLD 20, CMake ≥ 4.0, PCRE2 ve CGO için gereken yerel kitaplıkları yükleyin.```bashgit clone https://github.com/infiniflow/ragflow.git- cd ragflow/+ cd ragflow```+2. Bağımlılıkları hazırlayın:+```bashpython3 -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```- Betik, Go derlemesi için gerekli yerel kitaplıkları ve model kaynaklarını hazırlar ve `requests` ile `huggingface-hub` gerektirir. Aynı kaynakları başka bir yöntemle hazırladıysanız bu adımı atlayabilirsiniz. Depo kökünden başlatıldığında Go hizmetleri `internal/rag/res/deepdoc` dizinini otomatik olarak bulur; başka bir dizinden başlatmak için `DEEPDOC_MODEL_DIR` değişkenini mutlak yola ayarlayın.-3. Gerekli bağımlılıkları (Elasticsearch, MySQL, MinIO, NATS, Kvrocks ve ClickHouse) Docker Compose ile başlatın:+3. Hizmetleri derleyin:```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```- Kaynaktan çalıştırılan Go hizmetleri Kvrocks'a `localhost:6379` üzerinden bağlanır; sağlanan yapılandırmada `/etc/hosts` değişikliği gerekmez.+4. Yerel bağımlılıkları başlatın:-4. Veritabanı geçişinden sonra hizmetleri belirtilen sırayla başlatın. Her komutu deponun kök dizininden ayrı bir terminalde çalıştırın ve dört hizmet terminalini açık bırakın:+ ```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. Veritabanını geçirin:```bash./bin/ragflow_server --migrate- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --ingestor- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer- RAGFLOW_DEV_MODE=true ./bin/ragflow_server --api```- Başlatma modları şu şekilde çalışır:+6. Dört hizmeti dört terminalde başlatın:- - `--migrate`: Veritabanı geçişlerini çalıştırır ve tamamlanınca çıkar.- - `--admin`: Yönetim ve başlatma işlemleri için Admin hizmetini başlatır.- - `--ingestor`: Veri alımı ve ayrıştırma görevleri için Ingestor hizmetini başlatır.- - `--syncer`: Veri eşitleme görevleri için Syncer hizmetini başlatır.- - `--api`: Web UI, SDK'lar ve harici istemciler için API hizmetini başlatır.+ Terminal 1: Admin (`9381`).- `RAGFLOW_DEV_MODE=true` yalnızca geliştirme içindir. Kod sürümü ile veritabanı geçiş sürümü arasındaki sürüm düşürme denetimini devre dışı bırakır ancak geçiş çalıştırmaz veya şemayı değiştirmez. Üretimde kullanmayın. Admin'i diğer hizmetlerden önce başlatın. Geçişten sonra `RAGFLOW_DEV_MODE=true bash build.sh --run` Admin, Ingestor ve API'yi başlatır ancak Syncer'ı başlatmaz; tam hizmet zinciri için `RAGFLOW_DEV_MODE=true ./bin/ragflow_server --syncer` komutunu ayrıca çalıştırın.-5. Yalnızca ön yüz geliştirirken Node.js ve npm'i yükleyin, ardından React ön yüzünü başlatın:+ ```bash+ ./bin/ragflow_server --admin+ ``````bash- cd web- npm install- API_PROXY_SCHEME=go npm run dev+ ./bin/ragflow_server --ingestor+ ```++ Terminal 3: Syncer.++ ```bash+ ./bin/ragflow_server --syncer```- Başka bir terminalde Go API'nin hazır olduğunu doğrulayın:+ Terminal 4: API (`9380`).```bash+ ./bin/ragflow_server --api+ ```++7. Yalnızca ön yüz geliştirmede Node.js ve npm'i yükleyip API'yi doğrulayın:++ ```bash+ cd web+ npm installcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- HTTP 200 yanıtı API'nin yanıt verdiğini gösterir. Geliştirme tamamlandığında her hizmet terminalinde `Ctrl+C` tuşlarına basın. Kapsayıcıları koruyarak bağımlılıkları durdurmak için `docker compose --env-file docker/.env -f docker/docker-compose-base.yml stop es01 mysql minio nats kvrocks clickhouse` komutunu çalıştırın. Adlandırılmış birimleri koruyarak bağımlılık kapsayıcılarını ve Compose ağını kaldırmak için `docker compose --env-file docker/.env -f docker/docker-compose-base.yml down` komutunu çalıştırın.+Ayrıntılar için [Kaynaktan Başlatma](./docs/develop/launch_ragflow_from_source.md) belgesine bakın.-Ayrıntılar için [Hizmeti Kaynaktan Başlatma](./docs/develop/launch_ragflow_from_source.md) belgesine bakın.+> **İşletim notları:** Elasticsearch ayarını kalıcı yapmak için `/etc/sysctl.conf` dosyasına `vm.max_map_count=262144` ekleyin. Varsayılan MySQL yapılandırmasında Docker giriş noktası Admin, Syncer, Ingestor ve API'den önce geçişi çalıştırır. Açık kaynak 1.0'da DeepDoc düzen, OCR ve tablo tanıma için CPU kullanır. Docker değişikliklerinden sonra hizmetleri yeniden başlatın ve verileri korumak veya kaldırmak için [Docker kılavuzunu](./docker/README.md) izleyin. `download_deps.py` yerel kitaplıkları ve modelleri hazırlar; `requests` ve `huggingface-hub` gerektirir. `--migrate` geçişi çalıştırıp çıkar; `--admin` yönetim hizmetini, `--ingestor` veri alma hizmetini, `--syncer` harici veri kaynağı eşitleme hizmetini ve `--api` Web UI ile SDK'lara yönelik API hizmetini başlatır. HTTP 200 API'nin hazır olduğunu gösterir.## 📚 Dokümantasyon@@ -346,5 +283,4 @@ Ayrıntılar için [Hizmeti Kaynaktan Başlatma](./docs/develop/launch_ragflow_f## 🙌 Katkıda Bulunma-RAGFlow, açık kaynak iş birliği sayesinde gelişmektedir. Bu anlayışla, topluluktan gelen çeşitli katkıları benimsiyoruz.-Bir parçası olmak istiyorsanız, önce [Katkıda Bulunma Kılavuzumuzu](https://ragflow.io/docs/dev/contributing) inceleyin.+RAGFlow, açık kaynak iş birliği sayesinde gelişmektedir. Bu anlayışla, topluluktan gelen çeşitli katkıları benimsiyoruz. Bir parçası olmak istiyorsanız, önce [Katkıda Bulunma Kılavuzumuzu](https://ragflow.io/docs/dev/contributing) inceleyin.diff --git a/README_tzh.md b/README_tzh.mdindex 04069c6003..44e1270342 100644--- a/README_tzh.md+++ b/README_tzh.md@@ -6,7 +6,7 @@<p align="center"><a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-DFE0E5"></a>- <a href="./README_zh.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-DFE0E5"></a>+ <a href="./README_zh.md"><img alt="簡體中文版自述文件" src="https://img.shields.io/badge/簡體中文-DFE0E5"></a><a href="./README_tzh.md"><img alt="繁體版中文自述文件" src="https://img.shields.io/badge/繁體中文-DBEDFA"></a><a href="./README_ja.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-DFE0E5"></a><a href="./README_ko.md"><img alt="한국어" src="https://img.shields.io/badge/한국어-DFE0E5"></a>@@ -54,31 +54,30 @@<details open><summary><b>📕 目錄</b></summary>-- 💡 [RAGFlow 是什麼?](#-RAGFlow-是什麼)+- 💡 [RAGFlow 是甚麼?](#-ragflow-是甚麼)- 🎮 [快速開始](#-快速開始)-- 📌 [近期更新](#-近期更新)+- 🔥 [近期更新](#-近期更新)- 🌟 [主要功能](#-主要功能)- 🔎 [系統架構](#-系統架構)-- 🎬 [自行架設](#-自行架設)-- 🔧 [系統配置](#-系統配置)-- 🔨 [以原始碼啟動服務](#-以原始碼啟動服務)+- 🏠 [本地部署](#-本地部署)- 📚 [技術文檔](#-技術文檔)- 📜 [路線圖](#-路線圖)-- 🏄 [貢獻指南](#-貢獻指南)-- 🙌 [加入社區](#-加入社區)+- 🏄 [開源社區](#-開源社區)+- 🙌 [貢獻指南](#-貢獻指南)- 🤝 [商務合作](#-商務合作)+- 👥 [加入社區](#-加入社區)</details>-## 💡 RAGFlow 是什麼?+## 💡 RAGFlow 是甚麼?-[RAGFlow](https://ragflow.io/) 是一款領先的開源 [RAG](https://ragflow.io/basics/what-is-rag)(Retrieval-Augmented Generation)引擎,通過融合前沿的 RAG 技術與 Agent 能力,為大型語言模型提供卓越的上下文層。它提供可適配任意規模企業的端到端 RAG 工作流,憑藉融合式[上下文引擎](https://ragflow.io/basics/what-is-agent-context-engine)與預置的 Agent 模板,助力開發者以極致效率與精度將複雜數據轉化為高可信、生產級的人工智能系統。+[RAGFlow](https://ragflow.io/) 是一款領先的開源檢索增強生成([RAG](https://ragflow.io/basics/what-is-rag))引擎,通過融合前沿的 RAG 技術與 Agent 能力,為大型語言模型提供卓越的上下文層。它提供可適配任意規模企業的端到端 RAG 工作流,憑借融合式[上下文引擎](https://ragflow.io/basics/what-is-agent-context-engine)與預置的 Agent 模板,助力開發者以極致效率與精度將複雜數據轉化為高可信、生產級的人工智能系統。## 🎮 快速開始-請登入網址 [https://cloud.ragflow.io](https://cloud.ragflow.io) 試用雲服務。+請登錄網址 [https://cloud.ragflow.io](https://cloud.ragflow.io) 體驗雲服務。-如需本機部署,請參閱[本機部署](#-自行架設)。+如果想在本地部署,請參閱[本地部署](#-本地部署)。<div align="center" style="margin-top:20px;margin-bottom:20px;"><img alt="Chunking demonstration" src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/chunking.gif" width="1200"/>@@ -87,24 +86,17 @@## 🔥 近期更新-- 2026-09-29 發布 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 應用程式發布、Sandbox 程式碼執行與圖表產生。-- 2026-04-21 支援使用者級記憶儲存和檢索。--更多更新請參閱[完整發布記錄](./docs/release_notes.md)。+- 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 數據源接入與增量同步。+更多更新請參閱[完整發佈記錄](https://ragflow.io/docs/dev/release_notes)。## 🎉 關注項目-⭐️ 點擊右上角的 Star 追蹤 RAGFlow,可以取得最新發布的即時通知 !🌟+⭐️ 點擊右上角的 Star 關注 RAGFlow,可以獲取最新發佈的實時通知!🌟<div align="center" style="margin-top:20px;margin-bottom:20px;"><img alt="RAGFlow feature updates" src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>@@ -114,66 +106,64 @@### 🍭 **"Quality in, quality out"**-- 基於深度文件理解,能夠從各類複雜格式的非結構化資料中提取真知灼見。+- 基於深度文檔理解,能夠從各類複雜格式的非結構化數據中提取真知灼見。- 真正在無限上下文(token)的場景下快速完成大海撈針測試。-### 🍱 **基於模板的文字切片**+### 🍱 **基於模板的文本切片**-- 不只是智能,更重要的是可控可解釋。-- 多種文字範本可供選擇+- 不僅僅是智能,更重要的是可控可解釋。+- 多種文本模板可供選擇。### 🧩 **知識編譯(Knowledge Compilation)**-- 支援文件級和知識庫級編譯,將原始內容整理為結構化知識產物。-- 透過編譯範本產生 Wiki、Graph、Tree、PageIndex、Mind Map、Timeline 及 Skills,滿足不同的知識組織與重用需求。-- 支援設定編譯模型與處理規則,並檢視、更新和重新產生知識產物。+- 支持文檔級和知識庫級編譯,將原始內容組織為結構化的知識產物。+- 通過編譯模板生成 Wiki、Graph、Tree、PageIndex、Mind Map、Timeline 及 Skills,滿足不同的知識組織和復用需求。+- 支持配置編譯模型與處理規則,並查看、更新和重新生成知識產物。### 🧠 **Agentic Retrieval**-- 針對複雜問題進行多步檢索:模型會分析問題,並在需要時執行問題拆解、知識檢索和證據核驗。-- 透過多輪檢索與推理取得更完整的上下文,協助產生有依據的回答。-- 支援 Low、Medium、High、Ultra 思考模式,可依問題複雜度控制檢索和推理深度。+- 面向複雜問題進行多步檢索:模型會分析問題,並在需要時執行問題拆解、知識檢索和證據核驗。+- 通過多輪檢索與推理獲取更完整的上下文,幫助生成有依據的回答。+- 支持 Low、Medium、High、Ultra 思考模式,可按問題複雜度控制檢索和推理深度。### 🌱 **有理有據、最大程度降低幻覺(hallucination)**-- 文字切片過程視覺化,支援手動調整。+- 文本切片過程可視化,支持手動調整。- 有理有據:答案提供關鍵引用的快照並支持追根溯源。-### 🍔 **相容各類異質資料來源**+### 🍔 **兼容各類異構數據源**-- 支援豐富的文件類型,包括 Word 文件、PPT、excel 表格、txt 檔案、圖片、PDF、影印件、複印件、結構化資料、網頁等。+- 支持豐富的文件類型,包括 Word 文檔、PPT、Excel 表格、TXT 文件、圖片、PDF、影印件、復印件、結構化數據、網頁等。-### 🛀 **全程無憂、自動化的 RAG 工作流程**+### 🛀 **全程無憂、自動化的 RAG 工作流**-- 全面優化的 RAG 工作流程可以支援從個人應用乃至超大型企業的各類生態系統。-- 大語言模型 LLM 以及向量模型皆支援配置。+- 自動化的 RAG 工作流可以支持從個人應用乃至超大型企業的各類生態系統。+- 大語言模型 LLM 以及向量模型均支持配置。- 基於多路召回、融合重排序。-- 提供易用的 API,可輕鬆整合到各類企業系統。+- 提供易用的 API,可以輕鬆集成到各類企業系統。## 🔎 系統架構<div align="center" style="margin-top:20px;margin-bottom:20px;">-<img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow 系統架構" width="1000" />+ <img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/structure.jpg" alt="RAGFlow system architecture" width="1000" /></div>-## 🎬 自行架設+## 🏠 本地部署++本地部署提供 Docker 部署和源碼啓動兩種方式:Docker 適合快速體驗、集成測試和生產部署;源碼啓動適合 RAGFlow 開發和調試。Docker 部署無需安裝 Go 編譯器,源碼啓動需要安裝 `go.mod` 指定版本的 Go 編譯器;前端開發還需要 Node.js 和 npm。### 🐳 Docker 部署#### 📝 Docker 部署前提條件-- 建議起步配置: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 時需要安裝和設定。+- 建議起步配置:4 核 CPU、16 GB 內存和 50 GB 可用磁盤。實際資源需求取決於文檔引擎、數據規模、解析任務和併發量;啓用本地模型或其他額外組件時,請同時滿足相應組件的資源要求。+- Docker ≥ 24.0.0,Docker Compose ≥ v2.26.1。-Docker 部署無需在主機安裝 Go。使用 Self-Managed 容器 Sandbox 時需要額外安裝和設定 gVisor,其他 Sandbox Provider 不要求在 RAGFlow 主機安裝 gVisor。+> ⚠️ **提示:** 如果你尚未在本機安裝 Docker(Windows、macOS 或 Linux),可以參考 [Install Docker Engine](https://docs.docker.com/engine/install/) 自行安裝。-> [!TIP]-> 如果你並沒有在本機安裝 Docker(Windows、Mac,或 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` 的大小:>@@ -181,167 +171,175 @@ Docker 部署無需在主機安裝 Go。使用 Self-Managed 容器 Sandbox 時> sysctl vm.max_map_count> ```>- > 如果 `vm.max_map_count` 的值小於 262144,可以進行重設:+ > 如果使用 Elasticsearch 且 `vm.max_map_count` 的值小於 262144,可以進行重置:>> ```bash> # 這裡我們設為 262144:> sudo sysctl -w vm.max_map_count=262144> ```>- > 你的改動會在下次系統重新啟動時被重置。如果希望做永久改動,還需要在 **/etc/sysctl.conf** 檔案裡把 `vm.max_map_count` 的值再相應更新一遍:+ > 你的改動會在下次系統重啓時被重置。如果希望做永久改動,還需要在 **/etc/sysctl.conf** 文件里把 `vm.max_map_count` 的值再相應更新一遍:>> ```bash> vm.max_map_count=262144> ```- >+2. 克隆倉庫:```bashgit clone https://github.com/infiniflow/ragflow.git```-3. 切換至 Go 版發布標籤,並使用 Docker Compose 啟動伺服器:-> [!NOTE]-> Go 映像的正式建置目標為 `linux/amd64`。平台支援(注意:macOS 暫不受 Go 後端支援,請使用 Linux x86_64 主機)請參閱[Go Docker 映像建置與平台支援指南](./docs/develop/build_docker_image.mdx)。+3. 切換到發佈標籤並使用 Docker Compose 啓動服務器:- 進入 Docker 部署目錄。+ 進入倉庫中的 Docker 部署目錄。```bashcd ragflow/docker```- 切換至 Go v1.0.0-rc1 發布標籤。+ 切換到 `v1.0.0-rc1` 發佈標籤。```bashgit checkout v1.0.0-rc1```- 在背景啟動 Go 服務及其相依服務。+ 在啓動 RAGFlow 服務及其依賴服務。```bashdocker compose -f docker-compose.yml up -d```-預設 MySQL 設定下,Go 映像入口會先執行資料庫遷移,再透過 `bin/ragflow_server` 啟動 Syncer、Admin、API 和 Ingestor。+ > 💡 **鏡像下載提示:** 如果無法從默認倉庫拉取鏡像,請先在 `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 配置下,鏡像入口會先執行數據庫遷移,再啓動 Admin、Syncer、Ingestor 和 API 等服務。++ > RAGFlow 開源版 1.0 的 DeepDoc 版面分析、OCR 和表格識別使用 CPU 推理。-> RAGFlow 開源版 1.0 的 DeepDoc 版面分析、OCR 和表格辨識使用 CPU 推理。+4. 服務器啓動成功後再次確認服務器狀態:-4. 啟動後檢查服務狀態和 API 是否就緒:+ 使用 `docker ps` 檢查依賴服務狀態;依賴服務顯示 `healthy` 且 RAGFlow 容器持續運行後,通過 HTTP 接口判斷 RAGFlow 是否就緒(RAGFlow 容器本身未定義 Compose healthcheck):```bash- docker ps+ curl -f http://localhost/api/v1/system/healthz```- 上述命令會顯示相依服務的狀態。RAGFlow 本身未定義 Compose healthcheck;請透過 API 確認是否就緒:+ 返回 HTTP 200 後,再訪問 Web 頁面。如果修改了 `SVR_WEB_HTTP_PORT`,請將健康檢查地址中的端口替換為對應值。++ 如果服務啓動異常,再查看對應容器日誌:```bash- curl -f http://localhost/api/v1/system/healthz+ docker logs --tail 50 ragflow-cpu```- 返回 HTTP 200 表示 RAGFlow 已就緒。若修改了 `SVR_WEB_HTTP_PORT`,請在健康檢查網址中使用對應的連接埠。啟動失敗時,請使用 `docker logs --tail 50 <service>` 查看對應服務日誌。-5. 在你的瀏覽器中輸入你的伺服器對應的 IP 位址並登入 RAGFlow。+5. 在你的瀏覽器中輸入你的服務器對應的 IP 地址並登錄 RAGFlow。+ > 上面這個例子中,您只需輸入 http://IP_OF_YOUR_MACHINE 即可:未改動過配置則無需輸入端口(默認的 HTTP 服務端口 80)。- > 上面這個範例中,您只需輸入 http://IP_OF_YOUR_MACHINE 即可:未改動過設定則無需輸入連接埠(預設的 HTTP 服務連接埠 80)。- >-6. 登入 RAGFlow 後,在模型提供商頁面新增 LLM、Embedding 和 Reranker,並填寫對應的模型名稱、服務位址和 API key。+6. 登錄 RAGFlow 後,在模型提供商頁面添加 LLM、Embedding 和 Reranker,並填寫對應的模型名稱、服務地址和 API key。++ > 詳見 [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)。- _好戲開始,接著奏樂接著舞! _+ _好戲開始,接著奏樂接著舞!_-#### ⚙️ Docker 設定與調整+詳情請見 [快速入門指南](./docs/quickstart.mdx)。-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 配置與調整-切換文件引擎、更新設定、重新啟動服務,以及保留或清除既有資料等操作,也請依照上述 Docker 設定文件執行。+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)。-### 🔨 以原始碼啟動 Go 服務+切換文檔引擎、修改配置後重啓服務,以及保留或清理已有數據的操作,也請按照上述 Docker 配置文檔執行。-#### 📝 原始碼啟動前提條件+### 🔨 以源代碼啓動-原始碼啟動需要安裝 `go.mod` 指定的 Go 版本(目前為 Go 1.27)、Clang 20、LLD 20、CMake >= 4.0、PCRE2 開發檔案,以及 CGO 所需的原生程式庫。僅開發 React 前端時需要 Node.js 和 npm。+#### 📝 源碼啓動前提條件-1. 複製倉庫,並安裝上述建置工具:+1. 克隆倉庫,並安裝 `go.mod` 中指定版本的 Go 編譯器(當前為 Go 1.27)、Clang 20、LLD 20、CMake ≥ 4.0、PCRE2 開發文件 CGO 依賴的靜態庫;[build.sh](./build.sh) 會設置所需的構建參數。```bashgit clone https://github.com/infiniflow/ragflow.gitcd ragflow```-2. 使用 [Go 依賴下載腳本](./ragflow_deps/download_deps.py)準備原生程式庫、模型檔案和 tokenizer 資源,再編譯 Go 服務:++2. 運行 [依賴下載腳本](./ragflow_deps/download_deps.py) 下載靜態庫和模型文件:```bashpython3 -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```- 下載腳本使用 `requests` 和 `huggingface-hub` 來準備 Go 建置所需的原生程式庫和模型資源;如已透過其他方式準備好相同資源,可略過此步驟。從倉庫根目錄啟動時,Go 服務會自動尋找 `internal/rag/res/deepdoc`;如需從其他目錄啟動,請將 `DEEPDOC_MODEL_DIR` 設為該目錄的絕對路徑。-3. 啟動本機依賴服務,並確認 **conf/service_conf.yaml** 中的主機與連接埠可從主機存取:+ 下載腳本準備構建所需的靜態庫和模型資源,並需要 `requests` 和 `huggingface-hub`。如果已通過其他方式準備好相同資源,可跳過這一步。Go 服務從倉庫根目錄啓動時會自動查找 `internal/rag/res/deepdoc`;如需從其他目錄啓動,請將 `DEEPDOC_MODEL_DIR` 設為該目錄的絕對路徑。++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```- 從原始碼啟動的 Go 服務透過 `localhost:6379` 連線到 Compose 暴露的 Kvrocks;Docker 服務則使用容器網路中的主機名稱。使用提供的設定無需修改 `/etc/hosts`。-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 和外部用戶端提供介面。+ - `--migrate`:執行數據庫遷移,完成後即可退出。+ - `--admin`:啓動 Admin 服務,負責管理和初始化操作。+ - `--ingestor`:啓動 Ingestor 服務,負責數據攝取和解析任務。+ - `--syncer`:啓動 Syncer 服務,負責外部數據源的數據同步任務。+ - `--api`:啓動 API 服務,為 Web 和 SDK 提供 API 接口。- `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`。-5. 僅在開發前端時安裝 Node.js 和 npm,並啟動 React 前端:+7. 僅在前端開發時安裝 Node.js 和 npm,然後啓動 React 前端:```bashcd webnpm install- API_PROXY_SCHEME=go npm run dev```- 在另一個終端機確認 Go API 已就緒:+ 服務啓動後,運行下面命令來確認 API 服務已就緒:```bashcurl -f http://127.0.0.1:9380/api/v1/system/healthz```- 返回 HTTP 200 表示 API 可以正常回應。開發結束時,在各服務終端機按 `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)。+詳情請見 [從源代碼啓動服務](./docs/develop/launch_ragflow_from_source.md)。## 📚 技術文檔@@ -357,7 +355,7 @@ Go 版 Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`,以 K詳見 [RAGFlow Roadmap 2026](https://github.com/infiniflow/ragflow/issues/12241) 。-## 🏄 開源社群+## 🏄 開源社區- [Discord](https://discord.gg/NjYzJD3GM3)- [X](https://x.com/infiniflowai)@@ -365,15 +363,15 @@ Go 版 Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`,以 K## 🙌 貢獻指南-RAGFlow 只有透過開源協作才能蓬勃發展。秉持這項精神,我們歡迎來自社區的各種貢獻。如果您有意參與其中,請查閱我們的 [貢獻者指南](https://ragflow.io/docs/dev/contributing) 。+RAGFlow 只有通過開源協作才能蓬勃發展。秉持這一精神,我們歡迎來自社區的各種貢獻。如果您有意參與其中,請查閱我們的[貢獻者指南](https://ragflow.io/docs/dev/contributing)。## 🤝 商務合作-- [預約諮詢](https://aao615odquw.feishu.cn/share/base/form/shrcnjw7QleretCLqh1nuPo1xxh)+- [預約咨詢](https://aao615odquw.feishu.cn/share/base/form/shrcnjw7QleretCLqh1nuPo1xxh)## 👥 加入社區-掃二維碼加入 RAGFlow 小助手,進 RAGFlow 交流群。+掃二維碼添加 RAGFlow 小助手,進 RAGFlow 交流群。<p align="center"><img alt="RAGFlow assistant QR code" src="https://github.com/infiniflow/ragflow/assets/7248/bccf284f-46f2-4445-9809-8f1030fb7585" width=50% height=50%>diff --git a/README_zh.md b/README_zh.mdindex 61360a5b6d..49011c8c35 100644--- a/README_zh.md+++ b/README_zh.md@@ -56,15 +56,16 @@- 💡 [RAGFlow 是什么?](#-RAGFlow-是什么)- 🎮 [快速开始](#-快速开始)-- 📌 [近期更新](#-近期更新)+- 🔥 [近期更新](#-近期更新)- 🌟 [主要功能](#-主要功能)- 🔎 [系统架构](#-系统架构)- 🏠 [本地部署](#-本地部署)- 📚 [技术文档](#-技术文档)- 📜 [路线图](#-路线图)-- 🏄 [贡献指南](#-贡献指南)-- 🙌 [加入社区](#-加入社区)+- 🏄 [开源社区](#-开源社区)+- 🙌 [贡献指南](#-贡献指南)- 🤝 [商务合作](#-商务合作)+- 👥 [加入社区](#-加入社区)</details>@@ -268,7 +269,6 @@ Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`。镜像、端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- ./build.sh --all```下载脚本准备构建所需的静态库和模型资源,并需要 `requests` 和 `huggingface-hub`。如果已通过其他方式准备好相同资源,可跳过这一步。Go 服务从仓库根目录启动时会自动查找 `internal/rag/res/deepdoc`;如需从其他目录启动,请将 `DEEPDOC_MODEL_DIR` 设为该目录的绝对路径。diff --git a/docs/develop/launch_ragflow_from_source.md b/docs/develop/launch_ragflow_from_source.mdindex 8555aa2cd4..815a1de055 100644--- a/docs/develop/launch_ragflow_from_source.md+++ b/docs/develop/launch_ragflow_from_source.md@@ -168,10 +168,10 @@ In another terminal:```bashcd webnpm install-API_PROXY_SCHEME=go npm run dev+npm run dev```-With `API_PROXY_SCHEME=go`, the frontend routes requests to two Go backend ports: regular /api and /v1 requests use port 9380, while /api/v1/admin requests use port 9381.+The frontend routes requests to the Go backend by default: regular `/api` and `/v1` requests use port `9380`, while `/api/v1/admin` requests use port `9381`.Open http://127.0.0.1:9222/ unless Vite prints a different frontend port.## 5. Verify the startup