writinwaters
commited on
Commit
·
68f947e
1
Parent(s):
e3fc972
[DOC] We have no plan to maintain Docker images for ARM. Please build your … (#3808)
Browse files…Docker image
### What problem does this PR solve?
### Type of change
- [x] Documentation Update
docs/guides/develop/build_docker_image.mdx
CHANGED
@@ -21,10 +21,6 @@ A guide explaining how to build a RAGFlow Docker image from its source code. By
|
|
21 |
- Disk ≥ 50 GB
|
22 |
- Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1
|
23 |
|
24 |
-
:::tip NOTE
|
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
|
@@ -37,6 +33,10 @@ If you have not installed Docker on your local machine (Windows, Mac, or Linux),
|
|
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/
|
@@ -45,37 +45,23 @@ 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 |
-
|
56 |
-
|
57 |
-
|
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 |
-
<TabItem value="linux/arm64">
|
65 |
-
|
66 |
-
## 🔧 Build a Docker image for linux arm64
|
67 |
-
|
68 |
-
We are currently unable to regularly build multi-arch images with CI and have no plans to publish arm64 images in the near future.
|
69 |
-
However, you can build an image yourself on a linux/arm64 host machine:
|
70 |
|
71 |
```bash
|
72 |
git clone https://github.com/infiniflow/ragflow.git
|
73 |
cd ragflow/
|
74 |
pip3 install huggingface-hub nltk
|
75 |
python3 download_deps.py
|
76 |
-
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
77 |
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
78 |
```
|
79 |
-
</TabItem>
|
80 |
|
|
|
81 |
</Tabs>
|
|
|
21 |
- Disk ≥ 50 GB
|
22 |
- Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1
|
23 |
|
|
|
|
|
|
|
|
|
24 |
## Build a Docker image
|
25 |
|
26 |
<Tabs
|
|
|
33 |
|
34 |
This image is approximately 1 GB in size and relies on external LLM and embedding services.
|
35 |
|
36 |
+
:::tip NOTE
|
37 |
+
While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM. However, you can build an image yourself on a `linux/arm64` or `darwin/arm64` host machine as well.
|
38 |
+
:::
|
39 |
+
|
40 |
```bash
|
41 |
git clone https://github.com/infiniflow/ragflow.git
|
42 |
cd ragflow/
|
|
|
45 |
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
46 |
```
|
47 |
|
48 |
+
|
49 |
</TabItem>
|
50 |
<TabItem value="including">
|
51 |
|
|
|
|
|
52 |
This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only.
|
53 |
|
54 |
+
:::tip NOTE
|
55 |
+
While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM. However, you can build an image yourself on a `linux/arm64` or `darwin/arm64` host machine as well.
|
56 |
+
:::
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
57 |
|
58 |
```bash
|
59 |
git clone https://github.com/infiniflow/ragflow.git
|
60 |
cd ragflow/
|
61 |
pip3 install huggingface-hub nltk
|
62 |
python3 download_deps.py
|
|
|
63 |
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
64 |
```
|
|
|
65 |
|
66 |
+
</TabItem>
|
67 |
</Tabs>
|
docs/quickstart.mdx
CHANGED
@@ -14,17 +14,21 @@ This quick start guide describes a general process from:
|
|
14 |
- Starting up a local RAGFlow server,
|
15 |
- Creating a knowledge base,
|
16 |
- Intervening with file parsing, to
|
17 |
-
- Establishing an AI chat based on your datasets.
|
|
|
|
|
|
|
|
|
|
|
|
|
18 |
|
19 |
## Prerequisites
|
20 |
|
21 |
-
- CPU ≥ 4 cores;
|
22 |
- RAM ≥ 16 GB;
|
23 |
- Disk ≥ 50 GB;
|
24 |
- Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1.
|
25 |
|
26 |
-
> If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
|
27 |
-
|
28 |
## Start up the server
|
29 |
|
30 |
This section provides instructions on setting up the RAGFlow server on Linux. If you are on a different operating system, no worries. Most steps are alike.
|
|
|
14 |
- Starting up a local RAGFlow server,
|
15 |
- Creating a knowledge base,
|
16 |
- Intervening with file parsing, to
|
17 |
+
- Establishing an AI chat based on your datasets.
|
18 |
+
|
19 |
+
:::danger IMPORTANT
|
20 |
+
We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM.
|
21 |
+
|
22 |
+
If you are on an ARM platform, following [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
|
23 |
+
:::
|
24 |
|
25 |
## Prerequisites
|
26 |
|
27 |
+
- CPU ≥ 4 cores (x86);
|
28 |
- RAM ≥ 16 GB;
|
29 |
- Disk ≥ 50 GB;
|
30 |
- Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1.
|
31 |
|
|
|
|
|
32 |
## Start up the server
|
33 |
|
34 |
This section provides instructions on setting up the RAGFlow server on Linux. If you are on a different operating system, no worries. Most steps are alike.
|