From dccc0a4beed82271e482b3f00ab5b1520846f1dd Mon Sep 17 00:00:00 2001 From: deadtrickster Date: Wed, 22 Jul 2026 16:47:58 +0300 Subject: [PATCH] docs: fix markdownlint and command issues across READMEs (#17261) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes markdownlint findings and two carried-over command bugs that exist identically across `README.md` and all translations (markdownlint just never ran on them): - **MD045** — alt text on documentation images. - **MD014** — drop `$ ` prompts from command blocks with no output. - **MD040** — language on the `/etc/hosts` fenced block; remove a stray empty code block in `README_tzh.md`. - `sudo brew install jemalloc` → `brew install jemalloc` (brew rejects sudo). - Infinity migration: the `up` command now uses `docker/docker-compose.yml`, matching its `down`. MD028 is intentionally left: its only fix folds a note into the preceding `[!CAUTION]`/`[!WARNING]` admonition. Split out of #17240 to keep that PR scoped to the Russian translation. Co-authored-by: Claude Opus 4.8 --- README.md | 34 +++++++++++++++++----------------- README_ar.md | 34 +++++++++++++++++----------------- README_fr.md | 34 +++++++++++++++++----------------- README_id.md | 30 +++++++++++++++--------------- README_ja.md | 34 +++++++++++++++++----------------- README_ko.md | 30 +++++++++++++++--------------- README_pt_br.md | 34 +++++++++++++++++----------------- README_tr.md | 34 +++++++++++++++++----------------- README_tzh.md | 39 ++++++++++++++++++--------------------- README_zh.md | 36 ++++++++++++++++++------------------ 10 files changed, 168 insertions(+), 171 deletions(-) diff --git a/README.md b/README.md index 0ed47a8050..e294196e42 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ Try our cloud service at [https://cloud.ragflow.io](https://cloud.ragflow.io).
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 Latest Updates @@ -107,7 +107,7 @@ Try our cloud service at [https://cloud.ragflow.io](https://cloud.ragflow.io). releases! 🌟
- +RAGFlow feature updates
## 🌟 Key Features @@ -142,7 +142,7 @@ releases! 🌟 ## 🔎 System Architecture
- +RAGFlow system architecture
## 🎬 Self-Hosting @@ -166,14 +166,14 @@ releases! 🌟 > To check the value of `vm.max_map_count`: > > ```bash - > $ sysctl vm.max_map_count + > sysctl vm.max_map_count > ``` > > Reset `vm.max_map_count` to a value at least 262144 if it is not. > > ```bash > # In this case, we set it to 262144: - > $ sudo sysctl -w vm.max_map_count=262144 + > 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 @@ -186,7 +186,7 @@ releases! 🌟 2. Clone the repo: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. Start up the server using the pre-built Docker images: @@ -197,14 +197,14 @@ releases! 🌟 > The command below downloads the `v0.26.4` edition of the RAGFlow Docker image. See the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.26.4`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # Optional: use a stable tag (see releases: https://github.com/infiniflow/ragflow/releases) # This step ensures the **entrypoint.sh** file in the code matches the Docker image version. # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -223,7 +223,7 @@ releases! 🌟 4. Check the server status after having the server up and running: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _The following output confirms a successful launch of the system:_ @@ -273,7 +273,7 @@ to `:80`. Updates to the above configurations require a reboot of all containers to take effect: > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### Switch doc engine from Elasticsearch to Infinity @@ -283,7 +283,7 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit 1. Stop all running containers: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` > [!WARNING] @@ -293,7 +293,7 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit 3. Start the containers: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -347,7 +347,7 @@ docker build --platform linux/amd64 \ Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/.env** to `127.0.0.1`: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site: @@ -365,7 +365,7 @@ docker build --platform linux/amd64 \ # OpenSUSE sudo zypper install jemalloc # macOS - sudo brew install jemalloc + brew install jemalloc ``` 6. Launch backend service: @@ -388,7 +388,7 @@ docker build --platform linux/amd64 \ _The following output confirms a successful launch of the system:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. Stop RAGFlow front-end and back-end service after development is complete: ```bash diff --git a/README_ar.md b/README_ar.md index b705f87ecf..ba7f4d6b37 100644 --- a/README_ar.md +++ b/README_ar.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ جرّب النسخة التجريبية على [https://cloud.ragflow.io](https://cloud.ragflow.io).
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 آخر التحديثات @@ -107,7 +107,7 @@ الإصدارات! 🌟
- +RAGFlow feature updates
## 🌟 الميزات الرئيسية @@ -142,7 +142,7 @@ ## 🔎 هندسة النظام
- +RAGFlow system architecture
## 🎬 الاستضافة الذاتية @@ -166,14 +166,14 @@ > للتحقق من قيمة `vm.max_map_count`: > > ```bash - > $ sysctl vm.max_map_count + > 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 + > sudo sysctl -w vm.max_map_count=262144 > ``` > > سيتم إعادة ضبط هذا التغيير بعد إعادة تشغيل النظام. لضمان بقاء التغيير دائمًا، قم بإضافة أو تحديث @@ -186,7 +186,7 @@ 2. استنساخ الريبو: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. ابدأ تشغيل الخادم باستخدام صور Docker المعدة مسبقًا: @@ -197,14 +197,14 @@ > يقوم الأمر أدناه بتنزيل إصدار `v0.26.4` من الصورة RAGFlow Docker. راجع الجدول التالي للحصول على أوصاف لإصدارات RAGFlow المختلفة. لتنزيل إصدار RAGFlow مختلف عن `v0.26.4`، قم بتحديث المتغير `RAGFLOW_IMAGE` وفقًا لذلك في **docker/.env** قبل استخدام `docker compose` لبدء تشغيل الخادم. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # Optional: use a stable tag (see releases: https://github.com/infiniflow/ragflow/releases) # This step ensures the **entrypoint.sh** file in the code matches the Docker image version. # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -223,7 +223,7 @@ 4. التحقق من حالة الخادم بعد تشغيل الخادم: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _النتيجة التالية تؤكد الإطلاق الناجح للنظام:_ @@ -273,7 +273,7 @@ تتطلب تحديثات التكوينات المذكورة أعلاه إعادة تشغيل جميع الحاويات لتصبح سارية المفعول: > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### تبديل محرك المستندات من Elasticsearch إلى Infinity @@ -283,7 +283,7 @@ RAGFlow يستخدم Elasticsearch بشكل افتراضي لتخزين النص 1. إيقاف كافة الحاويات قيد التشغيل: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` > [!WARNING] @@ -293,7 +293,7 @@ RAGFlow يستخدم Elasticsearch بشكل افتراضي لتخزين النص 3. ابدأ الحاويات: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -344,7 +344,7 @@ docker build --platform linux/amd64 \ أضف السطر التالي إلى `/etc/hosts` لحل كافة المضيفين المحددين في **docker/.env** إلى `127.0.0.1`: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. إذا لم تتمكن من الوصول إلى HuggingFace، فقم بتعيين متغير البيئة `HF_ENDPOINT` لاستخدام موقع مرآة: @@ -362,7 +362,7 @@ docker build --platform linux/amd64 \ # OpenSUSE sudo zypper install jemalloc # macOS - sudo brew install jemalloc + brew install jemalloc ``` 6. إطلاق الخدمة الخلفية: @@ -385,7 +385,7 @@ docker build --platform linux/amd64 \ _النتيجة التالية تؤكد الإطلاق الناجح للنظام:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. أوقف خدمة الواجهة الأمامية والخلفية RAGFlow بعد اكتمال التطوير: ```bash diff --git a/README_fr.md b/README_fr.md index 57a711e4a2..c82996469d 100644 --- a/README_fr.md +++ b/README_fr.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow.io).
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 Dernières mises à jour @@ -106,7 +106,7 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow ⭐️ Mettez une étoile à notre dépôt pour rester informé des nouvelles fonctionnalités et améliorations passionnantes ! Recevez des notifications instantanées pour les nouvelles versions ! 🌟
- +RAGFlow feature updates
## 🌟 Fonctionnalités clés @@ -140,7 +140,7 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow ## 🔎 Architecture du système
- +RAGFlow system architecture
## 🎬 Auto-hébergement @@ -164,14 +164,14 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow > Pour vérifier la valeur de `vm.max_map_count` : > > ```bash - > $ sysctl vm.max_map_count + > 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 + > 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** : @@ -183,7 +183,7 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow 2. Clonez le dépôt : ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. Démarrez le serveur en utilisant les images Docker préconstruites : @@ -194,14 +194,14 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow > La commande ci-dessous télécharge l'édition `v0.26.4` de l'image Docker RAGFlow. Consultez le tableau suivant pour les descriptions des différentes éditions de RAGFlow. Pour télécharger une édition de RAGFlow différente de `v0.26.4`, mettez à jour la variable `RAGFLOW_IMAGE` dans **docker/.env** avant d'utiliser `docker compose` pour démarrer le serveur. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # Optionnel : utiliser un tag stable (voir les versions : https://github.com/infiniflow/ragflow/releases) # Cette étape garantit que le fichier **entrypoint.sh** dans le code correspond à la version de l'image Docker. # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -220,7 +220,7 @@ Essayez notre service cloud sur [https://cloud.ragflow.io](https://cloud.ragflow 4. Vérifiez l'état du serveur après son démarrage : ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _La sortie suivante confirme un lancement réussi du système :_ @@ -264,7 +264,7 @@ Pour mettre à jour le port HTTP de service par défaut (80), accédez à [docke Les mises à jour des configurations ci-dessus nécessitent un redémarrage de tous les conteneurs pour prendre effet : > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### Passer du moteur de documents Elasticsearch à Infinity @@ -274,7 +274,7 @@ RAGFlow utilise Elasticsearch par défaut pour stocker le texte intégral et les 1. Arrêtez tous les conteneurs en cours d'exécution : ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` > [!WARNING] @@ -284,7 +284,7 @@ RAGFlow utilise Elasticsearch par défaut pour stocker le texte intégral et les 3. Démarrez les conteneurs : ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -335,7 +335,7 @@ docker build --platform linux/amd64 \ Ajoutez la ligne suivante à `/etc/hosts` pour résoudre tous les hôtes spécifiés dans **docker/.env** vers `127.0.0.1` : - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. Si vous ne pouvez pas accéder à HuggingFace, définissez la variable d'environnement `HF_ENDPOINT` pour utiliser un site miroir : @@ -353,7 +353,7 @@ docker build --platform linux/amd64 \ # OpenSUSE sudo zypper install jemalloc # macOS - sudo brew install jemalloc + brew install jemalloc ``` 6. Lancez le service back-end : @@ -376,7 +376,7 @@ docker build --platform linux/amd64 \ _La sortie suivante confirme un lancement réussi du système :_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. Arrêtez les services front-end et back-end de RAGFlow une fois le développement terminé : ```bash diff --git a/README_id.md b/README_id.md index 5e4084de8b..8807d0b1ab 100644 --- a/README_id.md +++ b/README_id.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io).
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 Pembaruan Terbaru @@ -106,7 +106,7 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io). ⭐️ Star repositori kami untuk tetap mendapat informasi tentang fitur baru dan peningkatan menarik! 🌟
- +RAGFlow feature updates
## 🌟 Fitur Utama @@ -140,7 +140,7 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io). ## 🔎 Arsitektur Sistem
- +RAGFlow system architecture
## 🎬 Pengelolaan Mandiri @@ -164,14 +164,14 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io). > Untuk memeriksa nilai `vm.max_map_count`: > > ```bash - > $ sysctl vm.max_map_count + > 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 + > sudo sysctl -w vm.max_map_count=262144 > ``` > > Perubahan ini akan hilang setelah sistem direboot. Untuk membuat perubahan ini permanen, tambahkan atau perbarui nilai @@ -184,7 +184,7 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io). 2. Clone repositori: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. Bangun image Docker pre-built dan jalankan server: @@ -195,14 +195,14 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io). > Perintah di bawah ini mengunduh edisi v0.26.4 dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.26.4, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # Opsional: gunakan tag stabil (lihat releases: https://github.com/infiniflow/ragflow/releases) # This steps ensures the **entrypoint.sh** file in the code matches the Docker image version. # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -221,7 +221,7 @@ Coba layanan cloud kami di [https://cloud.ragflow.io](https://cloud.ragflow.io). 1. Periksa status server setelah server aktif dan berjalan: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _Output berikut menandakan bahwa sistem berhasil diluncurkan:_ @@ -268,7 +268,7 @@ menjadi `:80`. Pembaruan konfigurasi ini memerlukan reboot semua kontainer agar efektif: > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ## 🔧 Membangun Docker Image @@ -316,7 +316,7 @@ docker build --platform linux/amd64 \ Tambahkan baris berikut ke `/etc/hosts` untuk memetakan semua host yang ditentukan di **conf/service_conf.yaml** ke `127.0.0.1`: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. Jika Anda tidak dapat mengakses HuggingFace, atur variabel lingkungan `HF_ENDPOINT` untuk menggunakan situs mirror: @@ -332,7 +332,7 @@ docker build --platform linux/amd64 \ # centos sudo yum install jemalloc # mac - sudo brew install jemalloc + brew install jemalloc ``` 6. Jalankan aplikasi backend: @@ -355,7 +355,7 @@ docker build --platform linux/amd64 \ _Output berikut menandakan bahwa sistem berhasil diluncurkan:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. Hentikan layanan front-end dan back-end RAGFlow setelah pengembangan selesai: ```bash diff --git a/README_ja.md b/README_ja.md index 04daccab62..388c7e8a0a 100644 --- a/README_ja.md +++ b/README_ja.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -63,8 +63,8 @@ 当社のクラウドサービスをぜひお試しください:[https://cloud.ragflow.io](https://cloud.ragflow.io)。
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 最新情報 @@ -88,7 +88,7 @@ ⭐️ リポジトリをスター登録して、エキサイティングな新機能やアップデートを最新の状態に保ちましょう!すべての新しいリリースに関する即時通知を受け取れます! 🌟
- +RAGFlow feature updates
## 🌟 主な特徴 @@ -122,7 +122,7 @@ ## 🔎 システム構成
- +RAGFlow system architecture
## 🎬 セルフホスティング @@ -146,14 +146,14 @@ > `vm.max_map_count` の値をチェックするには: > > ```bash - > $ sysctl vm.max_map_count + > 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 + > sudo sysctl -w vm.max_map_count=262144 > ``` > > この変更はシステム再起動後にリセットされる。変更を恒久的なものにするには、**/etc/sysctl.conf** の `vm.max_map_count` 値を適宜追加または更新する: @@ -165,7 +165,7 @@ 2. リポジトリをクローンする: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. ビルド済みの Docker イメージをビルドし、サーバーを起動する: @@ -176,14 +176,14 @@ > 以下のコマンドは、RAGFlow Docker イメージの v0.26.4 エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.26.4 とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。 ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # 任意: 安定版タグを利用 (一覧: https://github.com/infiniflow/ragflow/releases) # この手順は、コード内の entrypoint.sh ファイルが Docker イメージのバージョンと一致していることを確認します。 # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -202,7 +202,7 @@ 1. サーバーを立ち上げた後、サーバーの状態を確認する: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _以下の出力は、システムが正常に起動したことを確認するものです:_ @@ -247,7 +247,7 @@ > すべてのシステム設定のアップデートを有効にするには、システムの再起動が必要です: > > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### Elasticsearch から Infinity にドキュメントエンジンを切り替えます @@ -257,7 +257,7 @@ RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトル 1. 実行中のすべてのコンテナを停止するには: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` Note: `-v` は docker コンテナのボリュームを削除し、既存のデータをクリアします。 @@ -265,7 +265,7 @@ RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトル 3. 起動コンテナ: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -317,7 +317,7 @@ docker build --platform linux/amd64 \ `/etc/hosts` に以下の行を追加して、**conf/service_conf.yaml** に指定されたすべてのホストを `127.0.0.1` に解決します: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. HuggingFace にアクセスできない場合は、`HF_ENDPOINT` 環境変数を設定してミラーサイトを使用してください: @@ -333,7 +333,7 @@ docker build --platform linux/amd64 \ # centos sudo yum install jemalloc # mac - sudo brew install jemalloc + brew install jemalloc ``` 6. バックエンドサービスを起動する: @@ -356,7 +356,7 @@ docker build --platform linux/amd64 \ _以下の画面で、システムが正常に起動したことを示します:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. 開発が完了したら、RAGFlow のフロントエンド サービスとバックエンド サービスを停止します: ```bash diff --git a/README_ko.md b/README_ko.md index 3751379af5..1f9fedd34a 100644 --- a/README_ko.md +++ b/README_ko.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -64,8 +64,8 @@ [https://cloud.ragflow.io](https://cloud.ragflow.io)에서 저희 클라우드 서비스를 이용해 보세요.
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 업데이트 @@ -89,7 +89,7 @@ ⭐️우리의 저장소를 즐겨찾기에 등록하여 흥미로운 새로운 기능과 업데이트를 최신 상태로 유지하세요! 모든 새로운 릴리스에 대한 즉시 알림을 받으세요! 🌟
- +RAGFlow feature updates
## 🌟 주요 기능 @@ -123,7 +123,7 @@ ## 🔎 시스템 아키텍처
- +RAGFlow system architecture
## 🎬 자체 호스팅 @@ -147,14 +147,14 @@ > `vm.max_map_count`의 값을 아래 명령어를 통해 확인하세요: > > ```bash - > $ sysctl vm.max_map_count + > sysctl vm.max_map_count > ``` > > 만약 `vm.max_map_count` 이 262144 보다 작다면 값을 쟈설정하세요. > > ```bash > # 이 경우에 262144로 설정했습니다.: - > $ sudo sysctl -w vm.max_map_count=262144 + > sudo sysctl -w vm.max_map_count=262144 > ``` > > 이 변경 사항은 시스템 재부팅 후에 초기화됩니다. 변경 사항을 영구적으로 적용하려면 /etc/sysctl.conf 파일에 vm.max_map_count 값을 추가하거나 업데이트하세요: @@ -166,7 +166,7 @@ 2. 레포지토리를 클론하세요: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요: @@ -178,14 +178,14 @@ > 아래 명령어는 RAGFlow Docker 이미지의 v0.26.4 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.26.4와 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 후 docker compose를 사용하여 서버를 시작하십시오. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # Optional: use a stable tag (see releases: https://github.com/infiniflow/ragflow/releases) # 이 단계는 코드의 entrypoint.sh 파일이 Docker 이미지 버전과 일치하도록 보장합니다. # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -204,7 +204,7 @@ 1. 서버가 시작된 후 서버 상태를 확인하세요: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _다음 출력 결과로 시스템이 성공적으로 시작되었음을 확인합니다:_ @@ -246,7 +246,7 @@ > 모든 시스템 구성 업데이트는 적용되기 위해 시스템 재부팅이 필요합니다. > > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### Elasticsearch 에서 Infinity 로 문서 엔진 전환 @@ -313,7 +313,7 @@ docker build --platform linux/amd64 \ `/etc/hosts` 에 다음 줄을 추가하여 **conf/service_conf.yaml** 에 지정된 모든 호스트를 `127.0.0.1` 로 해결합니다: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` @@ -331,7 +331,7 @@ docker build --platform linux/amd64 \ # centos sudo yum install jemalloc # mac - sudo brew install jemalloc + brew install jemalloc ``` 6. 백엔드 서비스를 시작합니다: @@ -357,7 +357,7 @@ docker build --platform linux/amd64 \ _다음 인터페이스는 시스템이 성공적으로 시작되었음을 나타냅니다:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. 개발이 완료된 후 RAGFlow 프론트엔드 및 백엔드 서비스를 중지합니다. diff --git a/README_pt_br.md b/README_pt_br.md index c3ee25ccf6..c65bd01382 100644 --- a/README_pt_br.md +++ b/README_pt_br.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -83,8 +83,8 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://cloud.ragflow.io).
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 Últimas Atualizações @@ -107,7 +107,7 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou ⭐️ Dê uma estrela no nosso repositório para se manter atualizado com novas funcionalidades e melhorias empolgantes! Receba notificações instantâneas sobre novos lançamentos! 🌟
- +RAGFlow feature updates
## 🌟 Principais Funcionalidades @@ -141,7 +141,7 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou ## 🔎 Arquitetura do Sistema
- +RAGFlow system architecture
## 🎬 Auto-hospedagem @@ -165,14 +165,14 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou > Para verificar o valor de `vm.max_map_count`: > > ```bash - > $ sysctl vm.max_map_count + > sysctl vm.max_map_count > ``` > > Se necessário, redefina `vm.max_map_count` para um valor de pelo menos 262144: > > ```bash > # Neste caso, defina para 262144: - > $ sudo sysctl -w vm.max_map_count=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**: @@ -184,7 +184,7 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou 2. Clone o repositório: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. Inicie o servidor usando as imagens Docker pré-compiladas: @@ -195,14 +195,14 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou > O comando abaixo baixa a edição`v0.26.4` da imagem Docker do RAGFlow. Consulte a tabela a seguir para descrições de diferentes edições do RAGFlow. Para baixar uma edição do RAGFlow diferente da `v0.26.4`, atualize a variável `RAGFLOW_IMAGE` conforme necessário no **docker/.env** antes de usar `docker compose` para iniciar o servidor. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # Opcional: use uma tag estável (veja releases: https://github.com/infiniflow/ragflow/releases) # Esta etapa garante que o arquivo entrypoint.sh no código corresponda à versão da imagem do Docker. # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -221,7 +221,7 @@ Experimente o nosso serviço na nuvem em [https://cloud.ragflow.io](https://clou 4. Verifique o status do servidor após tê-lo iniciado: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _O seguinte resultado confirma o lançamento bem-sucedido do sistema:_ @@ -264,7 +264,7 @@ Para atualizar a porta HTTP de serviço padrão (80), vá até [docker-compose.y Atualizações nas configurações acima exigem um reinício de todos os contêineres para que tenham efeito: > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### Mudar o mecanismo de documentos de Elasticsearch para Infinity @@ -274,7 +274,7 @@ O RAGFlow usa o Elasticsearch por padrão para armazenar texto completo e vetore 1. Pare todos os contêineres em execução: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` Note: `-v` irá deletar os volumes do contêiner, e os dados existentes serão apagados. @@ -282,7 +282,7 @@ O RAGFlow usa o Elasticsearch por padrão para armazenar texto completo e vetore 3. Inicie os contêineres: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!ATENÇÃO] @@ -333,7 +333,7 @@ docker build --platform linux/amd64 \ Adicione a seguinte linha ao arquivo `/etc/hosts` para resolver todos os hosts especificados em **docker/.env** para `127.0.0.1`: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. Se não conseguir acessar o HuggingFace, defina a variável de ambiente `HF_ENDPOINT` para usar um site espelho: @@ -349,7 +349,7 @@ docker build --platform linux/amd64 \ # centos sudo yum instalar jemalloc # mac - sudo brew install jemalloc + brew install jemalloc ``` 6. Lance o serviço de back-end: @@ -372,7 +372,7 @@ docker build --platform linux/amd64 \ _O seguinte resultado confirma o lançamento bem-sucedido do sistema:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. Pare os serviços de front-end e back-end do RAGFlow após a conclusão do desenvolvimento: ```bash diff --git a/README_tr.md b/README_tr.md index 38c9d26eda..2aa9a53e39 100644 --- a/README_tr.md +++ b/README_tr.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinden deneyin.
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 Son Güncellemeler @@ -106,7 +106,7 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinde ⭐️ Heyecan verici yeni özellikler ve iyileştirmelerden haberdar olmak için depomuzı yıldızlayın! Yeni sürümler için anında bildirim alın! 🌟
- +RAGFlow feature updates
## 🌟 Temel Özellikler @@ -140,7 +140,7 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinde ## 🔎 Sistem Mimarisi
- +RAGFlow system architecture
## 🎬 Kendi Sunucusunda Barındırma @@ -164,14 +164,14 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinde > `vm.max_map_count` değerini kontrol etmek için: > > ```bash - > $ sysctl vm.max_map_count + > 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 + > 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 @@ -184,7 +184,7 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinde 2. Depoyu klonlayın: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. Önceden oluşturulmuş Docker imajlarını kullanarak sunucuyu başlatın: @@ -195,14 +195,14 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinde > Aşağıdaki komut RAGFlow Docker imajının `v0.26.4` sürümünü indirir. Farklı RAGFlow sürümleri için aşağıdaki tabloya bakın. `v0.26.4` dışında bir sürüm indirmek için, `docker compose` ile sunucuyu başlatmadan önce **docker/.env** dosyasındaki `RAGFLOW_IMAGE` değişkenini güncelleyin. ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # İsteğe bağlı: Kararlı bir etiket kullanın (sürümler: https://github.com/infiniflow/ragflow/releases) # Bu adım, koddaki **entrypoint.sh** dosyasının Docker imaj sürümüyle eşleşmesini sağlar. # DeepDoc görevleri için CPU kullanımı: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # DeepDoc görevlerini hızlandırmak için GPU kullanımı: # sed -i '1i DEVICE=gpu' .env @@ -221,7 +221,7 @@ Bulut hizmetimizi [https://cloud.ragflow.io](https://cloud.ragflow.io) adresinde 4. Sunucu çalışır duruma geldikten sonra sunucu durumunu kontrol edin: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _Aşağıdaki çıktı, sistemin başarıyla başlatıldığını onaylar:_ @@ -268,7 +268,7 @@ Varsayılan HTTP sunucu portunu (80) değiştirmek için [docker-compose.yml](./ Yukarıdaki yapılandırma değişikliklerinin etkili olması için tüm konteynerlerin yeniden başlatılması gerekir: > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### Doküman Motorunu Elasticsearch'ten Infinity'ye Geçirme @@ -278,7 +278,7 @@ RAGFlow varsayılan olarak tam metin ve vektörlerin depolanması için Elastics 1. Çalışan tüm konteynerleri durdurun: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` > [!WARNING] @@ -288,7 +288,7 @@ RAGFlow varsayılan olarak tam metin ve vektörlerin depolanması için Elastics 3. Konteynerleri başlatın: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -339,7 +339,7 @@ docker build --platform linux/amd64 \ **docker/.env** dosyasında belirtilen tüm ana bilgisayar adlarını `127.0.0.1`'e çözümlemek için `/etc/hosts` dosyasına aşağıdaki satırı ekleyin: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. HuggingFace'e erişemiyorsanız, bir ayna site kullanmak için `HF_ENDPOINT` ortam değişkenini ayarlayın: @@ -357,7 +357,7 @@ docker build --platform linux/amd64 \ # OpenSUSE sudo zypper install jemalloc # macOS - sudo brew install jemalloc + brew install jemalloc ``` 6. Arka uç hizmetini başlatın: @@ -380,7 +380,7 @@ docker build --platform linux/amd64 \ _Aşağıdaki çıktı, sistemin başarıyla başlatıldığını onaylar:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. Geliştirme tamamlandıktan sonra RAGFlow ön yüz ve arka uç hizmetini durdurun: ```bash diff --git a/README_tzh.md b/README_tzh.md index a5555cdab8..0f685ce5dc 100644 --- a/README_tzh.md +++ b/README_tzh.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ 請登入網址 [https://cloud.ragflow.io](https://cloud.ragflow.io) 試用雲服務。
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 近期更新 @@ -107,7 +107,7 @@ ⭐️ 點擊右上角的 Star 追蹤 RAGFlow,可以取得最新發布的即時通知 !🌟
- +RAGFlow feature updates
## 🌟 主要功能 @@ -141,7 +141,7 @@ ## 🔎 系統架構
- +RAGFlow system architecture
## 🎬 自行架設 @@ -165,14 +165,14 @@ > 如需確認 `vm.max_map_count` 的大小: > > ```bash - > $ sysctl vm.max_map_count + > sysctl vm.max_map_count > ``` > > 如果 `vm.max_map_count` 的值小於 262144,可以進行重設: > > ```bash > # 這裡我們設為 262144: - > $ sudo sysctl -w vm.max_map_count=262144 + > sudo sysctl -w vm.max_map_count=262144 > ``` > > 你的改動會在下次系統重新啟動時被重置。如果希望做永久改動,還需要在 **/etc/sysctl.conf** 檔案裡把 `vm.max_map_count` 的值再相應更新一遍: @@ -184,7 +184,7 @@ 2. 克隆倉庫: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. 進入 **docker** 資料夾,利用事先編譯好的 Docker 映像啟動伺服器: @@ -195,14 +195,14 @@ > 執行以下指令會自動下載 RAGFlow Docker 映像 `v0.26.4`。請參考下表查看不同 Docker 發行版的說明。如需下載不同於 `v0.26.4` 的 Docker 映像,請在執行 `docker compose` 啟動服務之前先更新 **docker/.env** 檔案內的 `RAGFLOW_IMAGE` 變數。 ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # 可選:使用穩定版標籤(查看發佈:https://github.com/infiniflow/ragflow/releases) # 此步驟確保程式碼中的 entrypoint.sh 檔案與 Docker 映像版本一致。 # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -227,7 +227,7 @@ 4. 伺服器啟動成功後再次確認伺服器狀態: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _出現以下介面提示說明伺服器啟動成功:_ @@ -274,7 +274,7 @@ > 所有系統配置都需要透過系統重新啟動生效: > > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ###把文檔引擎從 Elasticsearch 切換成為 Infinity @@ -284,7 +284,7 @@ RAGFlow 預設使用 Elasticsearch 儲存文字和向量資料. 如果要切換 1. 停止所有容器運作: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` Note: `-v` 將會刪除 docker 容器的 volumes,已有的資料會被清空。 @@ -292,7 +292,7 @@ RAGFlow 預設使用 Elasticsearch 儲存文字和向量資料. 如果要切換 3. 啟動容器: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -344,7 +344,7 @@ docker build --platform linux/amd64 \ 在 `/etc/hosts` 中加入以下程式碼,將 **conf/service_conf.yaml** 檔案中的所有 host 位址都解析為 `127.0.0.1`: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. 如果無法存取 HuggingFace,可以把環境變數 `HF_ENDPOINT` 設為對應的鏡像網站: @@ -360,7 +360,7 @@ docker build --platform linux/amd64 \ # centos sudo yum install jemalloc # mac - sudo brew install jemalloc + brew install jemalloc ``` 6. 啟動後端服務: @@ -383,11 +383,8 @@ docker build --platform linux/amd64 \ 以下界面說明系統已成功啟動:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) - ``` - - ``` 9. 開發完成後停止 RAGFlow 前端和後端服務: ```bash @@ -427,5 +424,5 @@ RAGFlow 只有透過開源協作才能蓬勃發展。秉持這項精神,我們 掃二維碼加入 RAGFlow 小助手,進 RAGFlow 交流群。

- + RAGFlow assistant QR code

diff --git a/README_zh.md b/README_zh.md index 23793dc074..42305883d8 100644 --- a/README_zh.md +++ b/README_zh.md @@ -47,7 +47,7 @@
- +RAGFlow in the GitHub Octoverse
@@ -82,8 +82,8 @@ 请登录网址 [https://cloud.ragflow.io](https://cloud.ragflow.io) 体验云服务。
- - +Chunking demonstration +Agentic workflow demonstration
## 🔥 近期更新 @@ -107,7 +107,7 @@ ⭐️ 点击右上角的 Star 关注 RAGFlow,可以获取最新发布的实时通知 !🌟
- +RAGFlow feature updates
## 🌟 主要功能 @@ -141,7 +141,7 @@ ## 🔎 系统架构
- +RAGFlow system architecture
## 🎬 自主托管 @@ -165,14 +165,14 @@ > 如需确认 `vm.max_map_count` 的大小: > > ```bash - > $ sysctl vm.max_map_count + > sysctl vm.max_map_count > ``` > > 如果 `vm.max_map_count` 的值小于 262144,可以进行重置: > > ```bash > # 这里我们设为 262144: - > $ sudo sysctl -w vm.max_map_count=262144 + > sudo sysctl -w vm.max_map_count=262144 > ``` > > 你的改动会在下次系统重启时被重置。如果希望做永久改动,还需要在 **/etc/sysctl.conf** 文件里把 `vm.max_map_count` 的值再相应更新一遍: @@ -184,7 +184,7 @@ 2. 克隆仓库: ```bash - $ git clone https://github.com/infiniflow/ragflow.git + git clone https://github.com/infiniflow/ragflow.git ``` 3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器: @@ -196,14 +196,14 @@ > 运行以下命令会自动下载 RAGFlow Docker 镜像 `v0.26.4`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.26.4` 的 Docker 镜像,请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。 ```bash - $ cd ragflow/docker + cd ragflow/docker git checkout v0.26.4 # 可选:使用稳定版本标签(查看发布:https://github.com/infiniflow/ragflow/releases) # 这一步确保代码中的 entrypoint.sh 文件与 Docker 镜像的版本保持一致。 # Use CPU for DeepDoc tasks: - $ docker compose -f docker-compose.yml up -d + docker compose -f docker-compose.yml up -d # To use GPU to accelerate DeepDoc tasks: # sed -i '1i DEVICE=gpu' .env @@ -228,7 +228,7 @@ 4. 服务器启动成功后再次确认服务器状态: ```bash - $ docker logs -f docker-ragflow-cpu-1 + docker logs -f docker-ragflow-cpu-1 ``` _出现以下界面提示说明服务器启动成功:_ @@ -272,7 +272,7 @@ > 所有系统配置都需要通过系统重启生效: > > ```bash -> $ docker compose -f docker-compose.yml up -d +> docker compose -f docker-compose.yml up -d > ``` ### 把文档引擎从 Elasticsearch 切换成为 Infinity @@ -282,7 +282,7 @@ RAGFlow 默认使用 Elasticsearch 存储文本和向量数据. 如果要切换 1. 停止所有容器运行: ```bash - $ docker compose -f docker/docker-compose.yml down -v + docker compose -f docker/docker-compose.yml down -v ``` Note: `-v` 将会删除 docker 容器的 volumes,已有的数据会被清空。 @@ -291,7 +291,7 @@ RAGFlow 默认使用 Elasticsearch 存储文本和向量数据. 如果要切换 3. 启动容器: ```bash - $ docker compose -f docker-compose.yml up -d + docker compose -f docker/docker-compose.yml up -d ``` > [!WARNING] @@ -345,7 +345,7 @@ docker build --platform linux/amd64 \ 在 `/etc/hosts` 中添加以下代码,目的是将 **conf/service_conf.yaml** 文件中的所有 host 地址都解析为 `127.0.0.1`: - ``` + ```text 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` 4. 如果无法访问 HuggingFace,可以把环境变量 `HF_ENDPOINT` 设成相应的镜像站点: @@ -362,7 +362,7 @@ docker build --platform linux/amd64 \ # centos sudo yum install jemalloc # mac - sudo brew install jemalloc + brew install jemalloc ``` 6. 启动后端服务: @@ -388,7 +388,7 @@ docker build --platform linux/amd64 \ _以下界面说明系统已经成功启动:_ - ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ![RAGFlow web interface](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. 开发完成后停止 RAGFlow 前端和后端服务: @@ -430,5 +430,5 @@ RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们 扫二维码添加 RAGFlow 小助手,进 RAGFlow 交流群。

- + RAGFlow assistant QR code