diff --git a/docs/guides/develop/build_docker_image.mdx b/docs/guides/develop/build_docker_image.mdx index de7d43a9e..07bc7b07c 100644 --- a/docs/guides/develop/build_docker_image.mdx +++ b/docs/guides/develop/build_docker_image.mdx @@ -21,10 +21,6 @@ A guide explaining how to build a RAGFlow Docker image from its source code. By - Disk ≥ 50 GB - Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1 -:::tip NOTE -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. -::: - ## Build a Docker image -## Build a Docker image including embedding models - This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only. +:::tip NOTE +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. +::: + ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ @@ -61,21 +64,4 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev . ``` - - -## 🔧 Build a Docker image for linux arm64 - -We are currently unable to regularly build multi-arch images with CI and have no plans to publish arm64 images in the near future. -However, you can build an image yourself on a linux/arm64 host machine: - -```bash -git clone https://github.com/infiniflow/ragflow.git -cd ragflow/ -pip3 install huggingface-hub nltk -python3 download_deps.py -docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . -docker build -f Dockerfile -t infiniflow/ragflow:dev . -``` - - \ No newline at end of file diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index b3c6721e8..3307ab638 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -14,17 +14,21 @@ This quick start guide describes a general process from: - Starting up a local RAGFlow server, - Creating a knowledge base, - Intervening with file parsing, to -- Establishing an AI chat based on your datasets. +- Establishing an AI chat based on your datasets. + +:::danger IMPORTANT +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. + +If you are on an ARM platform, following [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. +::: ## Prerequisites -- CPU ≥ 4 cores; +- CPU ≥ 4 cores (x86); - RAM ≥ 16 GB; - Disk ≥ 50 GB; - Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1. - > If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/). - ## Start up the server 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.