writinwaters commited on
Commit
149dd1b
·
1 Parent(s): 3e144e5

Updated instructions on downloading RAGFlow Slim and RAGFlow all-in-one. (#2785)

Browse files

### What problem does this PR solve?


### Type of change

- [x] Documentation Update

Files changed (5) hide show
  1. README.md +7 -3
  2. README_ja.md +7 -4
  3. README_ko.md +7 -3
  4. README_zh.md +6 -2
  5. docs/quickstart.mdx +9 -3
README.md CHANGED
@@ -153,14 +153,18 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
153
  ```
154
 
155
  3. Build the pre-built Docker images and start up the server:
156
- > Running the following commands automatically downloads the *dev-slim* 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.
 
157
 
158
  ```bash
159
  $ cd ragflow/docker
160
- $ docker compose up -d
161
  ```
162
 
163
- > The core image is about 1 GB in size and may take a while to load.
 
 
 
164
 
165
  4. Check the server status after having the server up and running:
166
 
 
153
  ```
154
 
155
  3. Build the pre-built Docker images and start up the server:
156
+
157
+ > The command below downloads the dev version Docker image for RAGFlow slim (`dev-slim`). Note that RAGFlow slim Docker images do not include embedding models or Python libraries and hence are approximately 1GB in size.
158
 
159
  ```bash
160
  $ cd ragflow/docker
161
+ $ docker compose -f docker-compose.yml up -d
162
  ```
163
 
164
+ > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`. After making this change, rerun the command above to initiate the download.
165
+ > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, rerun the command above to initiate the download.
166
+ > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`. After making this change, rerun the command above to initiate the download.
167
+ > **NOTE:** A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.
168
 
169
  4. Check the server status after having the server up and running:
170
 
README_ja.md CHANGED
@@ -135,14 +135,17 @@
135
 
136
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
137
 
 
 
138
  ```bash
139
  $ cd ragflow/docker
140
- $ docker compose up -d
141
  ```
142
 
143
- > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_IMAGE変数を見つけて、対応するバージョンに変更してください。 例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`として、上記のコマンドを実行してください。
144
-
145
- > コアイメージのサイズは約 1 GB で、ロードに時間がかかる場合があります。
 
146
 
147
  4. サーバーを立ち上げた後、サーバーの状態を確認する:
148
 
 
135
 
136
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
137
 
138
+ > 以下のコマンドは、RAGFlow slim(`dev-slim`)の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。
139
+
140
  ```bash
141
  $ cd ragflow/docker
142
+ $ docker compose -f docker-compose.yml up -d
143
  ```
144
 
145
+ > - 特定のバージョンのRAGFlow slim Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
146
+ > - RAGFlowの埋め込みモデルとPythonライブラリを含む開発版Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を`RAGFLOW_IMAGE=infiniflow/ragflow:dev`に更新します。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
147
+ > - 特定のバージョンのRAGFlow Dockerイメージ(埋め込みモデルとPythonライブラリを含む)をダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
148
+ > **NOTE:** 埋め込みモデルとPythonライブラリを含むRAGFlow Dockerイメージのサイズは約9GBであり、読み込みにかなりの時間がかかる場合があります。
149
 
150
  4. サーバーを立ち上げた後、サーバーの状態を確認する:
151
 
README_ko.md CHANGED
@@ -138,13 +138,17 @@
138
 
139
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
140
 
141
- > 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_IMAGE`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`로 업데이트 한 뒤, 다음 명령어를 실행하세요.
 
142
  ```bash
143
  $ cd ragflow/docker
144
- $ docker compose up -d
145
  ```
146
 
147
- > 기본 이미지는 1GB 크기이며 로드하는 시간이 걸릴 있습니다.
 
 
 
148
 
149
 
150
  4. 서버가 시작된 후 서버 상태를 확인하세요:
 
138
 
139
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
140
 
141
+ > 아래의 명령은 RAGFlow slim(dev-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 1GB입니다.
142
+
143
  ```bash
144
  $ cd ragflow/docker
145
+ $ docker compose -f docker-compose.yml up -d
146
  ```
147
 
148
+ > - 특정 버전의 RAGFlow slim Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`으로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
149
+ > - RAGFlow의 임베딩 모델과 Python 라이브러리를 포함한 개발 버전 Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 `RAGFLOW_IMAGE=infiniflow/ragflow:dev`로 업데이트하세요. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
150
+ > - 특정 버전의 RAGFlow Docker 이미지를 임베딩 모델과 Python 라이브러리를 포함하여 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0` 로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
151
+ > **NOTE:** 임베딩 모델과 Python 라이브러리를 포함한 RAGFlow Docker 이미지의 크기는 약 9GB이며, 로드하는 데 상당히 오랜 시간이 걸릴 수 있습니다.
152
 
153
 
154
  4. 서버가 시작된 후 서버 상태를 확인하세요:
README_zh.md CHANGED
@@ -135,13 +135,17 @@
135
 
136
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
137
 
 
 
138
  ```bash
139
  $ cd ragflow/docker
140
  $ docker compose -f docker-compose.yml up -d
141
  ```
142
 
143
- > 运行上述命令会自动下载 RAGFlow 的 dev-slim 版本的 Docker 镜像,该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB。如果你想下载并运行特定版本的 Docker 镜像,请在 docker/slim.env 文件中找到 RAGFLOW_IMAGE 变量,将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`,然后再运行上述命令。
144
- > 如果您想安装内置 embedding 模型的 dev 版本的 docker 镜像,需要把docker/.env文件中 RAGFLOW_IMAGE 变量,这样的修改: `RAGFLOW_IMAGE=infiniflow/ragflow:dev`。如果您想指定指定特定版本,则可以修改为:`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`。修改后,再运行上面的命令。注意 dev 版本的 RAGFlow Docker image 大小约 9 GB,可能需要一定时间下载,请耐心等待。
 
 
145
 
146
  4. 服务器启动成功后再次确认服务器状态:
147
 
 
135
 
136
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
137
 
138
+ > 运行上述命令会自动下载 dev 版的 RAGFlow slim Docker 镜像(`dev-slim`),该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB。
139
+
140
  ```bash
141
  $ cd ragflow/docker
142
  $ docker compose -f docker-compose.yml up -d
143
  ```
144
 
145
+ > - 如果你想下载并运行特定版本的 RAGFlow slim Docker 镜像,请在 **docker/.env** 文件中找到 `RAGFLOW_IMAGE` 变量,将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`,然后再运行上述命令。
146
+ > - 如果您想安装内置 embedding 模型和 Python 库的 dev 版本的 Docker 镜像,需要将 **docker/.env** 文件中的 `RAGFLOW_IMAGE` 变量修改为: `RAGFLOW_IMAGE=infiniflow/ragflow:dev`。
147
+ > - 如果您想安装内置 embedding 模型和 Python 库的指定版本的 RAGFlow Docker 镜像,需要将 **docker/.env** 文件中的 `RAGFLOW_IMAGE` 变量修改为: `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`。修改后,再运行上面的命令。
148
+ > **注意:** 安装内置 embedding 模型和 Python 库的指定版本的 RAGFlow Docker 镜像大小约 9 GB,可能需要更长时间下载,请耐心等待。
149
 
150
  4. 服务器启动成功后再次确认服务器状态:
151
 
docs/quickstart.mdx CHANGED
@@ -177,14 +177,20 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
177
 
178
  3. Build the pre-built Docker images and start up the server:
179
 
180
- > Running the following commands automatically downloads the *dev-slim* 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.
181
 
182
  ```bash
183
  $ cd ragflow/docker
184
- $ docker compose up -d
185
  ```
186
 
187
- > The core image is about 1 GB in size and may take a while to load.
 
 
 
 
 
 
188
 
189
  4. Check the server status after having the server up and running:
190
 
 
177
 
178
  3. Build the pre-built Docker images and start up the server:
179
 
180
+ > The command below downloads the dev version Docker image for RAGFlow slim (`dev-slim`). Note that RAGFlow slim Docker images do not include embedding models or Python libraries and hence are approximately 1GB in size.
181
 
182
  ```bash
183
  $ cd ragflow/docker
184
+ $ docker compose -f docker-compose.yml up -d
185
  ```
186
 
187
+ > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`. After making this change, rerun the command above to initiate the download.
188
+ > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, rerun the command above to initiate the download.
189
+ > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`. After making this change, rerun the command above to initiate the download.
190
+
191
+ :::tip NOTE
192
+ A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.
193
+ :::
194
 
195
  4. Check the server status after having the server up and running:
196