Skip to content

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

docs: update docker build in docs (#20345)

YanZhangdc7656eb9226
diff --git a/README.md b/README.md
index 65cc01cf7d..7b0cf72e75 100644
--- a/README.md
+++ b/README.md
@@ -202,24 +202,18 @@ Docker deployment does not require Go on the host. Self-Managed container Sandbo
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. Build the Go image and start the server with the Go Compose configuration:
+3. Check out the Go release tag and start the prebuilt Go image with Docker Compose:
> [!NOTE]
-> The official Go image build target is `linux/amd64`. See the [Go Docker image build and platform support guide](./docs/develop/build_docker_image.mdx) for platform, resource, and macOS requirements.
-
-> Build the Go image before the first deployment. Build time depends on network and machine performance.
-
-Set the locally built image in **docker/.env** before starting Compose:
-
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
+> 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.
```bash
-cd ragflow
-docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
-cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
+# 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
```
In the default MySQL configuration, the Go image entrypoint runs database migrations before starting Syncer, Admin, API, and Ingestor through `bin/ragflow_server`.
@@ -229,7 +223,7 @@ In the default MySQL configuration, the Go image entrypoint runs database migrat
4. Check service status and API readiness after startup:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
```
The command above displays dependency status. RAGFlow itself does not define a Compose healthcheck; confirm readiness through its API:
@@ -238,7 +232,7 @@ In the default MySQL configuration, the Go image entrypoint runs database migrat
curl -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 compose --env-file .env -f docker-compose.yml logs --tail 50 <service>`.
+ 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 compose -f docker-compose.yml logs --tail 50 <service>`.
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
diff --git a/README_ar.md b/README_ar.md
index a83d645e6e..8190fb0b6b 100644
--- a/README_ar.md
+++ b/README_ar.md
@@ -202,31 +202,29 @@
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. ابدأ تشغيل الخادم باستخدام صور Docker المعدة مسبقًا:
+3. انتقل إلى وسم إصدار Go وشغّل صورة Go الجاهزة باستخدام Docker Compose:
> [!CAUTION]
> جميع الصور Docker مصممة لمنصات x86. لا نعرض حاليًا صور Docker لـ ARM64.
> إذا كنت تستخدم نظامًا أساسيًا ARM64، فاتبع [هذا الدليل](https://ragflow.io/docs/dev/build_docker_image) لإنشاء صورة Docker متوافقة مع نظامك.
-> اكتب `RAGFLOW_IMAGE=ragflow:go-local` في **docker/.env** قبل التشغيل. هدف البناء الرسمي لصورة Go هو `linux/amd64`.
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
-```bash
-cd ragflow
-docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
-cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
-```
+ ```bash
+ # الدخول إلى دليل نشر Docker.
+ cd ragflow/docker
+ # التبديل إلى وسم إصدار Go v1.0.0-rc1.
+ git checkout v1.0.0-rc1
+ # تشغيل خدمات Go وتبعياتها في الخلفية.
+ docker compose -f docker-compose.yml up -d
+ ```
> يستخدم DeepDoc في الإصدار مفتوح المصدر 1.0 استدلال CPU لتحليل التخطيط وOCR والتعرف على الجداول.
4. التحقق من حالة الخادم بعد تشغيل الخادم:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
curl -f http://localhost/api/v1/system/healthz
```
@@ -293,7 +291,7 @@ docker compose --env-file .env -f docker-compose.yml up -d
- `--syncer`: يشغّل خدمة Syncer لمهام مزامنة البيانات.
- `--api`: يشغّل خدمة API لواجهة الويب وSDK والعملاء الخارجيين.
- يُستخدم `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` عند الحاجة إلى السلسلة الكاملة.
+ يُستخدم `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 فقط عند تطوير الواجهة الأمامية:
```bash
diff --git a/README_fr.md b/README_fr.md
index ec3f21c39e..7f50fc9630 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -197,24 +197,22 @@ Le déploiement Docker ne nécessite pas l’installation de Go sur l’hôte. L
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. Construisez l’image Go et démarrez le serveur avec la configuration Compose Go. La cible de construction officielle est `linux/amd64`. Consultez le [guide de construction de l’image Go et de prise en charge des plateformes](./docs/develop/build_docker_image.mdx) pour connaître les exigences détaillées.
+3. Passez à la balise de version Go et démarrez l’image Go préconstruite avec Docker Compose :
- Avant le premier déploiement, définissez `RAGFLOW_IMAGE=ragflow:go-local` dans **docker/.env**, puis exécutez depuis la racine du dépôt :
- ```dotenv
- RAGFLOW_IMAGE=ragflow:go-local
- ```
```bash
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ # Accédez au répertoire de déploiement Docker.
+ cd ragflow/docker
+ # Basculez vers la balise de version Go v1.0.0-rc1.
+ git checkout v1.0.0-rc1
+ # Démarrez les services Go et leurs dépendances en arrière-plan.
+ docker 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 dépendances avec `docker compose --env-file .env -f docker-compose.yml ps`, puis confirmez que RAGFlow est prêt avec l’interface HTTP (le conteneur RAGFlow ne définit pas de healthcheck Compose) :
+4. Vérifiez l’état des dépendances avec `docker compose -f docker-compose.yml ps`, puis confirmez que RAGFlow est prêt avec l’interface HTTP (le conteneur RAGFlow ne définit pas de healthcheck Compose) :
```bash
curl -f http://localhost/api/v1/system/healthz
@@ -292,7 +290,7 @@ Pour changer de moteur de documents, modifier la configuration, redémarrer les
- `--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.
+ `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 :
```bash
diff --git a/README_id.md b/README_id.md
index a8ccdd55a5..cf3e3835fa 100644
--- a/README_id.md
+++ b/README_id.md
@@ -198,31 +198,29 @@ Deployment Docker tidak memerlukan Go di host. Container Sandbox Self-Managed me
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. Bangun image Docker pre-built dan jalankan server:
+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).
-> Tulis `RAGFLOW_IMAGE=ragflow:go-local` ke **docker/.env** sebelum memulai. Target build resmi image Go adalah `linux/amd64`.
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
-```bash
-cd ragflow
-docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
-cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
-```
+ ```bash
+ # Masuk ke direktori deployment Docker.
+ cd ragflow/docker
+ # Beralih ke tag rilis Go v1.0.0-rc1.
+ git checkout v1.0.0-rc1
+ # Jalankan layanan Go dan dependensinya di latar belakang.
+ docker compose -f docker-compose.yml up -d
+ ```
> Pada RAGFlow open-source 1.0, DeepDoc menggunakan inferensi CPU untuk analisis tata letak, OCR, dan pengenalan tabel.
1. Periksa status server setelah server aktif dan berjalan:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
curl -f http://localhost/api/v1/system/healthz
```
@@ -289,7 +287,7 @@ Untuk mengganti mesin dokumen, mengubah konfigurasi, memulai ulang layanan, sert
- `--syncer`: Memulai layanan Syncer untuk sinkronisasi data.
- `--api`: Memulai layanan API untuk Web UI, SDK, dan klien eksternal.
- `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 rantai layanan lengkap.
+ `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:
```bash
diff --git a/README_ja.md b/README_ja.md
index bd726c67c2..bc3ff17f60 100644
--- a/README_ja.md
+++ b/README_ja.md
@@ -181,23 +181,21 @@ DockerデプロイではホストへのGoのインストールは不要です。
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
+3. Go リリースタグに切り替え、Docker Compose で事前ビルド済み Go イメージを起動します:
> [!CAUTION]
> 現在、公式に提供されているすべての Docker イメージは x86 アーキテクチャ向けにビルドされており、ARM64 用の Docker イメージは提供されていません。
> ARM64 アーキテクチャのオペレーティングシステムを使用している場合は、[このドキュメント](https://ragflow.io/docs/dev/build_docker_image)を参照して Docker イメージを自分でビルドしてください。
-> 起動前に **docker/.env** へ `RAGFLOW_IMAGE=ragflow:go-local` を設定してください。Go イメージの正式なビルド対象は `linux/amd64` です。
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
```bash
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ # Docker デプロイディレクトリに移動します。
+ cd ragflow/docker
+ # Go v1.0.0-rc1 リリースタグに切り替えます。
+ git checkout v1.0.0-rc1
+ # Go サービスと依存サービスをバックグラウンドで起動します。
+ docker compose -f docker-compose.yml up -d
```
> RAGFlow オープンソース 1.0 の DeepDoc は、レイアウト解析、OCR、表認識に CPU 推論を使用します。
@@ -205,7 +203,7 @@ RAGFLOW_IMAGE=ragflow:go-local
1. サーバーを立ち上げた後、サーバーの状態を確認する:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
curl -f http://localhost/api/v1/system/healthz
```
diff --git a/README_ko.md b/README_ko.md
index c9d8bd67af..f71f544bb8 100644
--- a/README_ko.md
+++ b/README_ko.md
@@ -183,23 +183,21 @@ Docker 배포에는 호스트에 Go를 설치할 필요가 없습니다. Self-Ma
git clone https://github.com/infiniflow/ragflow.git
```
-3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
+3. Go 릴리스 태그로 전환하고 사전 빌드된 Go 이미지를 Docker Compose로 시작하세요:
> [!CAUTION]
> 모든 Docker 이미지는 x86 플랫폼을 위해 빌드되었습니다. 우리는 현재 ARM64 플랫폼을 위한 Docker 이미지를 제공하지 않습니다.
> ARM64 플랫폼을 사용 중이라면, [시스템과 호환되는 Docker 이미지를 빌드하려면 이 가이드를 사용해 주세요](https://ragflow.io/docs/dev/build_docker_image).
- > 시작하기 전에 **docker/.env**에 `RAGFLOW_IMAGE=ragflow:go-local`을 설정하세요. Go 이미지의 공식 빌드 대상은 `linux/amd64`입니다.
- ```dotenv
- RAGFLOW_IMAGE=ragflow:go-local
- ```
```bash
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ # Docker 배포 디렉터리로 이동합니다.
+ cd ragflow/docker
+ # Go v1.0.0-rc1 릴리스 태그로 전환합니다.
+ git checkout v1.0.0-rc1
+ # Go 서비스와 종속 서비스를 백그라운드에서 시작합니다.
+ docker compose -f docker-compose.yml up -d
```
> RAGFlow 오픈 소스 1.0의 DeepDoc은 레이아웃 분석, OCR, 표 인식에 CPU 추론을 사용합니다.
@@ -207,7 +205,7 @@ Docker 배포에는 호스트에 Go를 설치할 필요가 없습니다. Self-Ma
1. 서버가 시작된 후 서버 상태를 확인하세요:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
curl -f http://localhost/api/v1/system/healthz
```
diff --git a/README_pt_br.md b/README_pt_br.md
index 305832e48f..034028bae3 100644
--- a/README_pt_br.md
+++ b/README_pt_br.md
@@ -197,24 +197,22 @@ A implantação Docker não exige a instalação do Go no host. O Sandbox de con
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. Construa a imagem Go e inicie o servidor com a configuração Compose Go. O destino oficial de build é `linux/amd64`. Consulte o [guia de build da imagem Go e suporte a plataformas](./docs/develop/build_docker_image.mdx) para obter detalhes.
+3. Mude para a tag de lançamento Go e inicie a imagem Go pré-criada com o Docker Compose:
- Antes da primeira implantação, defina `RAGFLOW_IMAGE=ragflow:go-local` em **docker/.env** e execute, a partir da raiz do repositório:
- ```dotenv
- RAGFLOW_IMAGE=ragflow:go-local
- ```
```bash
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ # Entre no diretório de implantação do Docker.
+ cd ragflow/docker
+ # Mude para a tag de lançamento Go v1.0.0-rc1.
+ git checkout v1.0.0-rc1
+ # Inicie os serviços Go e suas dependências em segundo plano.
+ docker 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 das dependências com `docker compose --env-file .env -f docker-compose.yml ps` e confirme se o RAGFlow está pronto pela interface HTTP (o contêiner do RAGFlow não define um healthcheck do Compose):
+4. Verifique o estado das dependências com `docker compose -f docker-compose.yml ps` e confirme se o RAGFlow está pronto pela interface HTTP (o contêiner do RAGFlow não define um healthcheck do Compose):
```bash
curl -f http://localhost/api/v1/system/healthz
@@ -288,7 +286,7 @@ Para trocar o mecanismo de documentos, alterar configurações, reiniciar servi
- `--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.
+ `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:
```bash
diff --git a/README_ru.md b/README_ru.md
index 0ecc25912f..d037ecee00 100644
--- a/README_ru.md
+++ b/README_ru.md
@@ -199,31 +199,27 @@
git clone https://github.com/infiniflow/ragflow.git
```
-3. Запустите сервер с помощью готовых Docker-образов:
+3. Переключитесь на тег релиза Go и запустите готовый образ Go с помощью Docker Compose:
> [!CAUTION]
> Все образы собраны под x86. Образов для ARM64 пока нет.
> Если вы на ARM64, следуйте [этому руководству](https://ragflow.io/docs/dev/build_docker_image), чтобы собрать образ самостоятельно.
-> Перед запуском укажите локально собранный образ в файле **docker/.env**. Официальная целевая платформа сборки Go-образа — `linux/amd64`.
-
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
-
-```bash
-cd ragflow
-docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
-cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
-```
+ ```bash
+ # Перейдите в каталог развертывания Docker.
+ cd ragflow/docker
+ # Переключитесь на тег релиза Go v1.0.0-rc1.
+ git checkout v1.0.0-rc1
+ # Запустите службы Go и их зависимости в фоновом режиме.
+ docker compose -f docker-compose.yml up -d
+ ```
> В открытой версии RAGFlow 1.0 DeepDoc использует CPU для анализа макета, OCR и распознавания таблиц.
4. Проверьте статус после запуска:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
curl -f http://localhost/api/v1/system/healthz
```
diff --git a/README_tr.md b/README_tr.md
index 506c349874..0a11e04038 100644
--- a/README_tr.md
+++ b/README_tr.md
@@ -200,31 +200,27 @@ Docker dağıtımı ana makineye Go kurulmasını gerektirmez. Self-Managed kaps
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. Önceden oluşturulmuş Docker imajlarını kullanarak sunucuyu başlatın:
+3. Go sürüm etiketine geçin ve önceden oluşturulmuş Go imajını Docker Compose ile başlatın:
> [!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.
-> Başlatmadan önce yerel olarak oluşturulan imajı **docker/.env** dosyasında seçin. Go imajının resmi derleme hedefi `linux/amd64` platformudur.
-
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
-
-```bash
-cd ragflow
-docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
-cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
-```
+ ```bash
+ # Docker dağıtım dizinine girin.
+ cd ragflow/docker
+ # Go v1.0.0-rc1 sürüm etiketine geçin.
+ git checkout v1.0.0-rc1
+ # Go hizmetlerini ve bağımlılıklarını arka planda başlatın.
+ docker compose -f docker-compose.yml up -d
+ ```
> 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. Sunucu çalışır duruma geldikten sonra sunucu durumunu kontrol edin:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
curl -f http://localhost/api/v1/system/healthz
```
diff --git a/README_tzh.md b/README_tzh.md
index b095cb75a4..1a4fd65241 100644
--- a/README_tzh.md
+++ b/README_tzh.md
@@ -204,25 +204,19 @@ Docker 部署無需在主機安裝 Go。使用 Self-Managed 容器 Sandbox 時
```bash
git clone https://github.com/infiniflow/ragflow.git
```
-3. 建置 Go 版映像,並使用 Go 版 Compose 設定啟動伺服器:
+3. 切換至 Go 版發布標籤,並使用 Docker Compose 啟動伺服器:
> [!NOTE]
> Go 映像的正式建置目標為 `linux/amd64`。平台限制和 macOS 要求請參閱[Go Docker 映像建置與平台支援指南](./docs/develop/build_docker_image.mdx)。
-> 首次部署前需要先建置 Go 映像,建置時間取決於網路和機器效能。
-
-將以下值寫入 `docker/.env`:
-
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
-```
-
-```bash
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
-```
+ ```bash
+ # 進入 Docker 部署目錄。
+ cd ragflow/docker
+ # 切換至 Go v1.0.0-rc1 發布標籤。
+ git checkout v1.0.0-rc1
+ # 在背景啟動 Go 服務及其相依服務。
+ docker compose -f docker-compose.yml up -d
+ ```
預設 MySQL 設定下,Go 映像入口會先執行資料庫遷移,再透過 `bin/ragflow_server` 啟動 Syncer、Admin、API 和 Ingestor。
@@ -231,7 +225,7 @@ RAGFLOW_IMAGE=ragflow:go-local
4. 檢查相依服務狀態及 API 是否就緒:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
+ docker compose -f docker-compose.yml ps
```
相依服務顯示健康且 RAGFlow 容器持續執行後,請透過 HTTP 介面確認 RAGFlow 是否就緒(RAGFlow 容器本身未定義 Compose healthcheck):
@@ -313,7 +307,7 @@ Go 版 Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`,以 K
- `--syncer`:啟動 Syncer 服務,負責資料同步任務。
- `--api`:啟動 API 服務,為 Web、SDK 和外部用戶端提供介面。
- `RAGFLOW_DEV_MODE=true` 僅供開發環境使用。它會停用程式碼版本與資料庫遷移版本之間的降級檢查,但不會執行遷移或變更資料庫結構,正式環境請勿設定。Admin 應先於其他服務啟動。遷移完成後,`RAGFLOW_DEV_MODE=true bash build.sh --run` 可啟動 Admin、Ingestor 和 API,但不會啟動 Syncer。
+ `RAGFLOW_DEV_MODE=true` 僅供開發環境使用。它會停用程式碼版本與資料庫遷移版本之間的降級檢查,但不會執行遷移或變更資料庫結構,正式環境請勿設定。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
diff --git a/README_zh.md b/README_zh.md
index 3dcd4fc5ce..6ace19f8d5 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -203,32 +203,31 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
git clone https://github.com/infiniflow/ragflow.git
```
-3. 构建 Go 版镜像并使用 Go 版 Compose 配置启动服务器:
+3. 切换到 Go 版发布标签并使用 Docker Compose 启动服务器:
- > ⚠️ **提示:** Go 镜像的正式构建目标为 `linux/amd64`。详细平台、资源和 macOS 要求请参阅[Go Docker 镜像构建与平台支持说明](./docs/develop/build_docker_image.mdx)。
-
- > 首次部署需要先构建 Go 镜像,构建时间取决于网络和机器性能。
-
- 将以下值写入 `docker/.env`:
-
- ```dotenv
- RAGFLOW_IMAGE=ragflow:go-local
- ```
+ > ⚠️ **提示:** `v1.0.0-rc1` 及之后的发布标签使用 Go 实现。详细平台和 macOS 要求请参阅[Go Docker 镜像构建与平台支持说明](./docs/develop/build_docker_image.mdx)。
```bash
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ # 进入仓库中的 Docker 部署目录
+ cd ragflow/docker
+ # 切换到 Go 版 v1.0.0-rc1 发布标签
+ git checkout v1.0.0-rc1
+ # 在后台启动 Go 服务及其依赖服务
+ docker compose -f docker-compose.yml up -d
```
+ > 💡 **镜像下载提示:** 如果无法从默认仓库拉取 Go 镜像,请先在 `docker/.env` 中将 `RAGFLOW_IMAGE` 设置为以下镜像源之一,并保留 `v1.0.0-rc1` 标签:
+ >
+ > - 华为云:`swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:v1.0.0-rc1`
+ > - 阿里云:`registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:v1.0.0-rc1`
+
默认 MySQL 配置下,Go 镜像入口会先执行数据库迁移,再通过 `bin/ragflow_server` 启动 Syncer、Admin、API 和 Ingestor。
> RAGFlow 开源版 1.0 的 DeepDoc 版面分析、OCR 和表格识别使用 CPU 推理。
4. 服务器启动成功后再次确认服务器状态:
- 使用 `docker compose --env-file .env -f docker-compose.yml ps` 检查依赖服务状态;依赖服务显示 `healthy` 且 RAGFlow 容器持续运行后,通过 HTTP 接口判断 RAGFlow 是否就绪(RAGFlow 容器本身未定义 Compose healthcheck):
+ 使用 `docker compose -f docker-compose.yml ps` 检查依赖服务状态;依赖服务显示 `healthy` 且 RAGFlow 容器持续运行后,通过 HTTP 接口判断 RAGFlow 是否就绪(RAGFlow 容器本身未定义 Compose healthcheck):
```bash
curl -f http://localhost/api/v1/system/healthz
@@ -240,7 +239,7 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
```bash
# CPU 部署
- docker compose --env-file .env -f docker-compose.yml logs --tail 50 ragflow-cpu
+ docker compose -f docker-compose.yml logs --tail 50 ragflow-cpu
```
@@ -256,7 +255,7 @@ Docker 部署无需在宿主机安装 Go。使用 Self-Managed 容器 Sandbox
#### ⚙️ Docker 配置与调整
-Go 版 Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`,使用 Kvrocks 存储缓存和 Checkpoint,并使用 NATS JetStream 作为消息队列。镜像、端口、密码、文档引擎及模型镜像源请按[Docker 配置说明](./docker/README.md)修改;平台限制和 macOS 运行要求请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。
+Go 版 Docker 部署使用 `docker/.env` 和 `docker/docker-compose.yml`,使用 Kvrocks 存储缓存和 Checkpoint,并使用 NATS JetStream 作为消息队列。镜像、端口、密码、文档引擎及模型镜像源请按[Docker 配置说明](./docker/README.md)修改;平台限制和 macOS 运行要求请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。源码构建 Docker 镜像请参阅[Go Docker 镜像构建与平台支持指南](./docs/develop/build_docker_image.mdx)。
切换文档引擎、修改配置后重启服务,以及保留或清理已有数据的操作,也请按照上述 Docker 配置文档执行。
diff --git a/docker/README.md b/docker/README.md
index 8019d99e05..9e33bca93f 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -25,16 +25,15 @@ The Go image runs the API, Admin, Ingestor, and Syncer modes from the single `bi
### Quick start
-Run these commands from the repository root. The `.git` directory must remain in the build context because `Dockerfile` uses it to stamp the image version.
+Run the Go release deployment from the repository checkout:
```bash
-docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
-```
-
-Set the image in `docker/.env`:
-
-```dotenv
-RAGFLOW_IMAGE=ragflow:go-local
+# 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
```
If you use the default Elasticsearch document engine on Linux, set `vm.max_map_count` to at least `262144` on the Docker host:
@@ -45,20 +44,15 @@ sudo sysctl -w vm.max_map_count=262144
This change is temporary. To preserve it after a reboot, add `vm.max_map_count=262144` to `/etc/sysctl.conf`. On Docker Desktop, apply the setting inside its Linux virtual machine as described in the [Go image build guide](../docs/develop/build_docker_image.mdx#macos-with-docker-desktop).
-Start the default CPU stack:
+The `v1.0.0-rc1` tag and later release tags use the Go implementation. The entrypoint migrates the default MySQL metadata database first, then starts the Go Syncer, Admin server, API server, and Ingestor. Open `http://localhost` after the HTTP health check succeeds.
-```bash
-cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
-```
-
-The entrypoint migrates the default MySQL metadata database first, then starts the Go Syncer, Admin server, API server, and Ingestor. Open `http://localhost` after the HTTP health check succeeds.
+For local image builds, use the [Go image build guide](../docs/develop/build_docker_image.mdx).
Verify the deployment with:
```bash
-docker compose --env-file .env -f docker-compose.yml ps
-docker compose --env-file .env -f docker-compose.yml logs --tail 100 ragflow-cpu
+docker compose -f docker-compose.yml ps
+docker compose -f docker-compose.yml logs --tail 100 ragflow-cpu
curl -f http://localhost/api/v1/system/healthz
```
@@ -158,12 +152,6 @@ The Go services use NATS JetStream for ingestion, synchronization, memory, and k
The optional `tei-cpu` and `tei-gpu` profiles start a local text-embeddings-inference service. Its memory requirement depends on the model, runtime backend, precision, batch-token limit, and concurrency. The `tei-cpu` profile uses system RAM; the `tei-gpu` profile primarily uses GPU memory and also consumes system RAM. Verify model loading and peak request usage on the target hardware, and leave additional host memory for RAGFlow, the document engine, databases, and operating system.
-> 💡 **Tip:** If you cannot download a Go RAGFlow Docker image, try the following mirrors.
->
-> - For the `nightly` edition:
-> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly` or,
-> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:nightly`.
-
### DeepDoc (in-process)
DeepDoc layout analysis (DLA), OCR (text detection/recognition), and table structure recognition (TSR) run **in-process** inside the RAGFlow server using ONNX Runtime — there is no separate DeepDoc service to deploy. ONNX Runtime is statically linked into the server binary (resolved at runtime via dlopen(NULL); no `libonnxruntime.so` is required) and the models are loaded at runtime; `DEEPDOC_MODEL_DIR` overrides the default model directory. `Dockerfile` copies the required model assets into `/ragflow/rag/res/deepdoc`.
@@ -305,8 +293,8 @@ If you want your instance to be available under `https`, follow these steps:
5. **Restart the services**
```bash
- docker compose --env-file .env -f docker-compose.yml down
- docker compose --env-file .env -f docker-compose.yml up -d
+ docker compose -f docker-compose.yml down
+ docker compose -f docker-compose.yml up -d
```
diff --git a/docs/administrator/configurations/sandbox_quickstart.md b/docs/administrator/configurations/sandbox_quickstart.md
index b5216fc0bc..14d2d1af29 100644
--- a/docs/administrator/configurations/sandbox_quickstart.md
+++ b/docs/administrator/configurations/sandbox_quickstart.md
@@ -110,7 +110,9 @@ docker tag infiniflow/sandbox-base-nodejs:latest sandbox-base-nodejs:latest
Then restart the standalone sandbox services:
```bash
+# Stop the standalone Sandbox services before applying the changes.
docker compose -f docker-compose.yml down
+# Start the standalone Sandbox services in the background.
docker compose -f docker-compose.yml up -d
```
diff --git a/docs/develop/build_docker_image.mdx b/docs/develop/build_docker_image.mdx
index dad1e4c7d8..0476682e29 100644
--- a/docs/develop/build_docker_image.mdx
+++ b/docs/develop/build_docker_image.mdx
@@ -53,7 +53,7 @@ Set `RAGFLOW_IMAGE=ragflow:go-local` in `docker/.env`. That file also controls t
```bash
cd docker
-docker compose --env-file .env -f docker-compose.yml up -d
+docker compose -f docker-compose.yml up -d
```
The Compose deployment starts the `ragflow-cpu` service. The open-source 1.0 Go DeepDoc backend uses CPU inference.
@@ -61,8 +61,8 @@ The Compose deployment starts the `ragflow-cpu` service. The open-source 1.0 Go
## Verify the service
```bash
-docker compose --env-file .env -f docker-compose.yml ps
-docker compose --env-file .env -f docker-compose.yml logs --tail 50 ragflow-cpu
+docker compose -f docker-compose.yml ps
+docker compose -f docker-compose.yml logs --tail 50 ragflow-cpu
curl -f http://localhost/api/v1/system/healthz
```
@@ -94,7 +94,7 @@ The same Go image and Compose file work on macOS. On Apple Silicon, keep `--plat
```bash
cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ docker compose -f docker-compose.yml up -d
curl -f http://localhost/api/v1/system/healthz
```
diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx
index 18e709b15f..b200e37369 100644
--- a/docs/quickstart.mdx
+++ b/docs/quickstart.mdx
@@ -36,34 +36,36 @@ If Docker is not installed, see [Install Docker Engine](https://docs.docker.com/
The change made with `sysctl -w` is temporary. To keep it after a reboot, set `vm.max_map_count=262144` in `/etc/sysctl.conf`. On Docker Desktop, apply the setting to its Linux VM.
-2. Clone the repository and build the Go image from its root:
+2. Clone the repository:
```bash
git clone https://github.com/infiniflow/ragflow.git
- cd ragflow
- docker build --platform linux/amd64 -f Dockerfile -t ragflow:go-local .
```
-3. Set `RAGFLOW_IMAGE=ragflow:go-local` in `docker/.env`. The same file controls `DOC_ENGINE`, service ports, and dependency credentials. Change the default passwords before deploying to a network-accessible host.
-
-4. Start the Go service and its dependencies:
+3. Check out the Go release tag and start the prebuilt Go image with Docker Compose:
```bash
- cd docker
- docker compose --env-file .env -f docker-compose.yml up -d
+ # 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
```
+ The `docker/.env` file controls `DOC_ENGINE`, service ports, and dependency credentials. Change the default passwords before deploying to a network-accessible host.
+
In the RAGFlow open-source 1.0 release, DeepDoc layout analysis, OCR, and table recognition use CPU inference.
:::caution Development checkouts
A development checkout can report a code version older than the database migration version, including immediately after its own migrations. In that case, the Go server refuses to start with `Refusing to start: database was migrated by a newer version`. For local development with this checkout, set `RAGFLOW_DEV_MODE=true` in `.env` and run the Compose command again. This disables the database downgrade check; leave `RAGFLOW_DEV_MODE=false` for production, and use a binary whose version is at least the database migration version.
:::
-5. Check that the service is running:
+4. Check that the service is running:
```bash
- docker compose --env-file .env -f docker-compose.yml ps
- docker compose --env-file .env -f docker-compose.yml logs -f ragflow-cpu
+ docker compose -f docker-compose.yml ps
+ docker compose -f docker-compose.yml logs -f ragflow-cpu
```
After initialization, check the Go API and its dependencies through the web port from another terminal:
@@ -74,7 +76,7 @@ If Docker is not installed, see [Install Docker Engine](https://docs.docker.com/
A successful response has HTTP status 200. If you changed `SVR_WEB_HTTP_PORT` in `.env`, include that port in the URL. Wait for this check to pass before opening the web interface.
-6. Open `http://IP_OF_YOUR_MACHINE` in a browser and log in. If you changed `SVR_WEB_HTTP_PORT` in `.env`, include that port in the URL.
+5. Open `http://IP_OF_YOUR_MACHINE` in a browser and log in. If you changed `SVR_WEB_HTTP_PORT` in `.env`, include that port in the URL.
The Go container runs the API server, ingestion workers, and data synchronization. Its startup script runs the Go database migrations before starting the services.