From 5d966b11209b3ddfb5e3d9514657bc7a69047736 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Wed, 9 Oct 2024 23:03:18 +0800 Subject: [PATCH] Fix README description (#2773) ### What problem does this PR solve? _Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR._ ### Type of change - [x] Documentation Update --------- Signed-off-by: Jin Hai --- README.md | 2 +- README_ja.md | 2 +- README_ko.md | 2 +- README_zh.md | 2 +- docs/quickstart.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d97be5cce..00651d76e 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ``` 3. Build the pre-built Docker images and start up the server: - > Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_IMAGE` in **docker/.env** to the intended version, for example `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`, before running the following commands. + > Running the following commands automatically downloads the *slim-dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_IMAGE` in **docker/.env** to the intended version, for example `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`, before running the following commands. ```bash $ cd ragflow/docker diff --git a/README_ja.md b/README_ja.md index 30982927e..5e924e691 100644 --- a/README_ja.md +++ b/README_ja.md @@ -141,7 +141,7 @@ $ docker compose up -d ``` - > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_IMAGE変数を見つけて、対応するバージョンに変更してください。 例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`として、上記のコマンドを実行してください。 + > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_IMAGE変数を見つけて、対応するバージョンに変更してください。 例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`として、上記のコマンドを実行してください。 > コアイメージのサイズは約 1 GB で、ロードに時間がかかる場合があります。 diff --git a/README_ko.md b/README_ko.md index ce1aee34c..c4bcc6dc0 100644 --- a/README_ko.md +++ b/README_ko.md @@ -138,7 +138,7 @@ 3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요: - > 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_IMAGE`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`로 업데이트 한 뒤, 다음 명령어를 실행하세요. + > 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_IMAGE`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`로 업데이트 한 뒤, 다음 명령어를 실행하세요. ```bash $ cd ragflow/docker $ chmod +x ./entrypoint.sh diff --git a/README_zh.md b/README_zh.md index d38ad6241..207f042b4 100644 --- a/README_zh.md +++ b/README_zh.md @@ -141,7 +141,7 @@ $ docker compose -f docker-compose.yml up -d ``` - > 请注意，运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像，请在 docker/.env 文件中找到 RAGFLOW_IMAGE 变量，将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`，然后运行上述命令。 + > 请注意，运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像，请在 docker/.env 文件中找到 RAGFLOW_IMAGE 变量，将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`，然后运行上述命令。 > 核心镜像下载大小为 1 GB，可能需要一定时间拉取。请耐心等待。 diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 47b393f08..d070fb5b5 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -177,7 +177,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If 3. Build the pre-built Docker images and start up the server: - > Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_IMAGE` in **docker/.env** to the intended version, for example `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`, before running the following commands. + > Running the following commands automatically downloads the *slim-dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_IMAGE` in **docker/.env** to the intended version, for example `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`, before running the following commands. ```bash $ cd ragflow/docker