writinwaters commited on
Commit
6465302
·
1 Parent(s): 95c3d5f

Updated Build Docker Image (#2706)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

README.md CHANGED
@@ -42,8 +42,8 @@
42
  - 🔎 [System Architecture](#-system-architecture)
43
  - 🎬 [Get Started](#-get-started)
44
  - 🔧 [Configurations](#-configurations)
45
- - 🪛 [Build the docker image without embedding models](#-build-the-docker-image-without-embedding-models)
46
- - 🪚 [Build the docker image including embedding models](#-build-the-docker-image-including-embedding-models)
47
  - 🔨 [Launch service from source for development](#-launch-service-from-source-for-development)
48
  - 📚 [Documentation](#-documentation)
49
  - 📜 [Roadmap](#-roadmap)
@@ -213,7 +213,7 @@ Updates to the above configurations require a reboot of all containers to take e
213
  > $ docker-compose -f docker/docker-compose.yml up -d
214
  > ```
215
 
216
- ## 🪛 Build the Docker image without embedding models
217
 
218
  This image is approximately 1 GB in size and relies on external LLM and embedding services.
219
 
@@ -225,7 +225,7 @@ python3 download_deps.py
225
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
226
  ```
227
 
228
- ## 🪚 Build the Docker image including embedding models
229
 
230
  This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only.
231
 
 
42
  - 🔎 [System Architecture](#-system-architecture)
43
  - 🎬 [Get Started](#-get-started)
44
  - 🔧 [Configurations](#-configurations)
45
+ - 🔧 [Build a docker image without embedding models](#-build-the-docker-image-without-embedding-models)
46
+ - 🔧 [Build a docker image including embedding models](#-build-the-docker-image-including-embedding-models)
47
  - 🔨 [Launch service from source for development](#-launch-service-from-source-for-development)
48
  - 📚 [Documentation](#-documentation)
49
  - 📜 [Roadmap](#-roadmap)
 
213
  > $ docker-compose -f docker/docker-compose.yml up -d
214
  > ```
215
 
216
+ ## 🔧 Build a Docker image without embedding models
217
 
218
  This image is approximately 1 GB in size and relies on external LLM and embedding services.
219
 
 
225
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
226
  ```
227
 
228
+ ## 🔧 Build a Docker image including embedding models
229
 
230
  This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only.
231
 
README_ja.md CHANGED
@@ -195,7 +195,7 @@
195
  > $ docker-compose up -d
196
  > ```
197
 
198
- ## 🪛 ソースコードでDockerイメージを作成(埋め込みモデルなし)
199
 
200
  この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
201
 
@@ -207,7 +207,7 @@ python3 download_deps.py
207
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
208
  ```
209
 
210
- ## 🪚 ソースコードをコンパイルしたDockerイメージ(埋め込みモデルを含む)
211
 
212
  この Docker のサイズは約 9GB で、埋め込みモデルを含むため、外部の大モデルサービスのみが必要です。
213
 
 
195
  > $ docker-compose up -d
196
  > ```
197
 
198
+ ## 🔧 ソースコードでDockerイメージを作成(埋め込みモデルなし)
199
 
200
  この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
201
 
 
207
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
208
  ```
209
 
210
+ ## 🔧 ソースコードをコンパイルしたDockerイメージ(埋め込みモデルを含む)
211
 
212
  この Docker のサイズは約 9GB で、埋め込みモデルを含むため、外部の大モデルサービスのみが必要です。
213
 
README_ko.md CHANGED
@@ -197,7 +197,7 @@
197
  > $ docker-compose up -d
198
  > ```
199
 
200
- ## 🪛 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음)
201
 
202
  이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다.
203
 
@@ -209,7 +209,7 @@ python3 download_deps.py
209
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
210
  ```
211
 
212
- ## 🪚 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함)
213
 
214
  이 Docker의 크기는 약 9GB이며, 이미 임베딩 모델을 포함하고 있으므로 외부 대형 모델 서비스에만 의존하면 됩니다.
215
 
 
197
  > $ docker-compose up -d
198
  > ```
199
 
200
+ ## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음)
201
 
202
  이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다.
203
 
 
209
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
210
  ```
211
 
212
+ ## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함)
213
 
214
  이 Docker의 크기는 약 9GB이며, 이미 임베딩 모델을 포함하고 있으므로 외부 대형 모델 서비스에만 의존하면 됩니다.
215
 
README_zh.md CHANGED
@@ -197,7 +197,7 @@
197
  > $ docker compose -f docker-compose.yml up -d
198
  > ```
199
 
200
- ## 🪛 源码编译 Docker 镜像(不含 embedding 模型)
201
 
202
  本 Docker 镜像大小约 1 GB 左右并且依赖外部的大模型和 embedding 服务。
203
 
@@ -209,7 +209,7 @@ python3 download_deps.py
209
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
210
  ```
211
 
212
- ## 🪚 源码编译 Docker 镜像(包含 embedding 模型)
213
 
214
  本 Docker 大小约 9 GB 左右。由于已包含 embedding 模型,所以只需依赖外部的大模型服务即可。
215
 
 
197
  > $ docker compose -f docker-compose.yml up -d
198
  > ```
199
 
200
+ ## 🔧 源码编译 Docker 镜像(不含 embedding 模型)
201
 
202
  本 Docker 镜像大小约 1 GB 左右并且依赖外部的大模型和 embedding 服务。
203
 
 
209
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
210
  ```
211
 
212
+ ## 🔧 源码编译 Docker 镜像(包含 embedding 模型)
213
 
214
  本 Docker 大小约 9 GB 左右。由于已包含 embedding 模型,所以只需依赖外部的大模型服务即可。
215
 
docs/guides/develop/{build_docker_image.md → build_docker_image.mdx} RENAMED
@@ -4,6 +4,8 @@ slug: /build_docker_image
4
  ---
5
 
6
  # Build a RAGFlow Docker Image
 
 
7
 
8
  A guide explaining how to build a RAGFlow Docker image from its source code. By following this guide, you'll be able to create a local Docker image that can be used for development, debugging, or testing purposes.
9
 
@@ -23,65 +25,40 @@ A guide explaining how to build a RAGFlow Docker image from its source code. By
23
  If you have not installed Docker on your local machine (Windows, Mac, or Linux), see the [Install Docker Engine](https://docs.docker.com/engine/install/) guide.
24
  :::
25
 
26
- ## Build a RAGFlow Docker Image
27
 
28
- To build a RAGFlow Docker image from source code:
 
 
 
 
 
 
29
 
30
- ### Git Clone the Repository
31
 
32
  ```bash
33
  git clone https://github.com/infiniflow/ragflow.git
34
- cd ragflow
35
- ```
36
-
37
- ### Build the Docker Image
38
-
39
- Navigate to the `ragflow` directory where the Dockerfile and other necessary files are located. Now you can build the Docker image using the provided Dockerfile. The command below specifies which Dockerfile to use and tags the image with a name for reference purpose.
40
-
41
- #### Build and push multi-arch image `infiniflow/ragflow:dev-slim`
42
-
43
- On a `linux/amd64` host:
44
- ```bash
45
- docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim-amd64 .
46
- docker push infiniflow/ragflow:dev-slim-amd64
47
- ```
48
-
49
- On a `linux/arm64` host:
50
- ```bash
51
- docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim-arm64 .
52
- docker push infiniflow/ragflow:dev-slim-arm64
53
- ```
54
-
55
- On a Linux host:
56
- ```bash
57
- docker manifest create infiniflow/ragflow:dev-slim --amend infiniflow/ragflow:dev-slim-amd64 --amend infiniflow/ragflow:dev-slim-arm64
58
- docker manifest push infiniflow/ragflow:dev-slim
59
  ```
60
 
61
- This image is approximately 1 GB in size and relies on external LLM services, as it does not include deepdoc, embedding, or chat models.
 
62
 
63
- #### Build and push multi-arch image `infiniflow/ragflow:dev`
64
 
65
- On a `linux/amd64` host:
66
- ```bash
67
- pip3 install huggingface-hub nltk
68
- python3 download_deps.py
69
- docker build -f Dockerfile -t infiniflow/ragflow:dev-amd64 .
70
- docker push infiniflow/ragflow:dev-amd64
71
- ```
72
 
73
- On a `linux/arm64` host:
74
  ```bash
 
 
75
  pip3 install huggingface-hub nltk
76
  python3 download_deps.py
77
- docker build -f Dockerfile -t infiniflow/ragflow:dev-arm64 .
78
- docker push infiniflow/ragflow:dev-arm64
79
- ```
80
-
81
- On any linux host:
82
- ```bash
83
- docker manifest create infiniflow/ragflow:dev --amend infiniflow/ragflow:dev-amd64 --amend infiniflow/ragflow:dev-arm64
84
- docker manifest push infiniflow/ragflow:dev
85
  ```
86
 
87
- This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes deepdoc, embedding, and chat models.
 
 
4
  ---
5
 
6
  # Build a RAGFlow Docker Image
7
+ import Tabs from '@theme/Tabs';
8
+ import TabItem from '@theme/TabItem';
9
 
10
  A guide explaining how to build a RAGFlow Docker image from its source code. By following this guide, you'll be able to create a local Docker image that can be used for development, debugging, or testing purposes.
11
 
 
25
  If you have not installed Docker on your local machine (Windows, Mac, or Linux), see the [Install Docker Engine](https://docs.docker.com/engine/install/) guide.
26
  :::
27
 
28
+ ## Build a Docker image
29
 
30
+ <Tabs
31
+ defaultValue="without"
32
+ values={[
33
+ {label: 'Build a Docker image without embedding models', value: 'without'},
34
+ {label: 'Build a Docker image including embedding models', value: 'including'}
35
+ ]}>
36
+ <TabItem value="without">
37
 
38
+ This image is approximately 1 GB in size and relies on external LLM and embedding services.
39
 
40
  ```bash
41
  git clone https://github.com/infiniflow/ragflow.git
42
+ cd ragflow/
43
+ pip3 install huggingface-hub nltk
44
+ python3 download_deps.py
45
+ docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
46
  ```
47
 
48
+ </TabItem>
49
+ <TabItem value="including">
50
 
51
+ ## Build a Docker image including embedding models
52
 
53
+ This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only.
 
 
 
 
 
 
54
 
 
55
  ```bash
56
+ git clone https://github.com/infiniflow/ragflow.git
57
+ cd ragflow/
58
  pip3 install huggingface-hub nltk
59
  python3 download_deps.py
60
+ docker build -f Dockerfile -t infiniflow/ragflow:dev .
 
 
 
 
 
 
 
61
  ```
62
 
63
+ </TabItem>
64
+ </Tabs>