diff --git a/README.md b/README.md index 68aeed342..fdc6d04cc 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,8 @@ - 🔎 [System Architecture](#-system-architecture) - 🎬 [Get Started](#-get-started) - 🔧 [Configurations](#-configurations) -- 🪛 [Build the docker image without embedding models](#-build-the-docker-image-without-embedding-models) -- 🪚 [Build the docker image including embedding models](#-build-the-docker-image-including-embedding-models) +- 🔧 [Build a docker image without embedding models](#-build-the-docker-image-without-embedding-models) +- 🔧 [Build a docker image including embedding models](#-build-the-docker-image-including-embedding-models) - 🔨 [Launch service from source for development](#-launch-service-from-source-for-development) - 📚 [Documentation](#-documentation) - 📜 [Roadmap](#-roadmap) @@ -213,7 +213,7 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` -## 🪛 Build the Docker image without embedding models +## 🔧 Build a Docker image without embedding models This image is approximately 1 GB in size and relies on external LLM and embedding services. @@ -225,7 +225,7 @@ python3 download_deps.py docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -## 🪚 Build the Docker image including embedding models +## 🔧 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. diff --git a/README_ja.md b/README_ja.md index 833c658af..9d0c1b904 100644 --- a/README_ja.md +++ b/README_ja.md @@ -195,7 +195,7 @@ > $ docker-compose up -d > ``` -## 🪛 ソースコードでDockerイメージを作成（埋め込みモデルなし） +## 🔧 ソースコードでDockerイメージを作成（埋め込みモデルなし） この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。 @@ -207,7 +207,7 @@ python3 download_deps.py docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -## 🪚 ソースコードをコンパイルしたDockerイメージ（埋め込みモデルを含む） +## 🔧 ソースコードをコンパイルしたDockerイメージ（埋め込みモデルを含む） この Docker のサイズは約 9GB で、埋め込みモデルを含むため、外部の大モデルサービスのみが必要です。 diff --git a/README_ko.md b/README_ko.md index 8fe0fe1bc..9107bb39f 100644 --- a/README_ko.md +++ b/README_ko.md @@ -197,7 +197,7 @@ > $ docker-compose up -d > ``` -## 🪛 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음) +## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음) 이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다. @@ -209,7 +209,7 @@ python3 download_deps.py docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -## 🪚 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함) +## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함) 이 Docker의 크기는 약 9GB이며, 이미 임베딩 모델을 포함하고 있으므로 외부 대형 모델 서비스에만 의존하면 됩니다. diff --git a/README_zh.md b/README_zh.md index 0284a5730..556bccd30 100644 --- a/README_zh.md +++ b/README_zh.md @@ -197,7 +197,7 @@ > $ docker compose -f docker-compose.yml up -d > ``` -## 🪛 源码编译 Docker 镜像（不含 embedding 模型） +## 🔧 源码编译 Docker 镜像（不含 embedding 模型） 本 Docker 镜像大小约 1 GB 左右并且依赖外部的大模型和 embedding 服务。 @@ -209,7 +209,7 @@ python3 download_deps.py docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -## 🪚 源码编译 Docker 镜像（包含 embedding 模型） +## 🔧 源码编译 Docker 镜像（包含 embedding 模型） 本 Docker 大小约 9 GB 左右。由于已包含 embedding 模型，所以只需依赖外部的大模型服务即可。 diff --git a/docs/guides/develop/build_docker_image.md b/docs/guides/develop/build_docker_image.md deleted file mode 100644 index 648b2167c..000000000 --- a/docs/guides/develop/build_docker_image.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -sidebar_position: 1 -slug: /build_docker_image ---- - -# Build a RAGFlow Docker Image - -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. - -## Target Audience - -- Developers who have added new features or modified the existing code and require a Docker image to view and debug their changes. -- Testers looking to explore the latest features of RAGFlow in a Docker image. - -## Prerequisites - -- CPU ≥ 4 cores -- RAM ≥ 16 GB -- 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 RAGFlow Docker Image - -To build a RAGFlow Docker image from source code: - -### Git Clone the Repository - -```bash -git clone https://github.com/infiniflow/ragflow.git -cd ragflow -``` - -### Build the Docker Image - -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. - -#### Build and push multi-arch image `infiniflow/ragflow:dev-slim` - -On a `linux/amd64` host: -```bash -docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim-amd64 . -docker push infiniflow/ragflow:dev-slim-amd64 -``` - -On a `linux/arm64` host: -```bash -docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim-arm64 . -docker push infiniflow/ragflow:dev-slim-arm64 -``` - -On a Linux host: -```bash -docker manifest create infiniflow/ragflow:dev-slim --amend infiniflow/ragflow:dev-slim-amd64 --amend infiniflow/ragflow:dev-slim-arm64 -docker manifest push infiniflow/ragflow:dev-slim -``` - -This image is approximately 1 GB in size and relies on external LLM services, as it does not include deepdoc, embedding, or chat models. - -#### Build and push multi-arch image `infiniflow/ragflow:dev` - -On a `linux/amd64` host: -```bash -pip3 install huggingface-hub nltk -python3 download_deps.py -docker build -f Dockerfile -t infiniflow/ragflow:dev-amd64 . -docker push infiniflow/ragflow:dev-amd64 -``` - -On a `linux/arm64` host: -```bash -pip3 install huggingface-hub nltk -python3 download_deps.py -docker build -f Dockerfile -t infiniflow/ragflow:dev-arm64 . -docker push infiniflow/ragflow:dev-arm64 -``` - -On any linux host: -```bash -docker manifest create infiniflow/ragflow:dev --amend infiniflow/ragflow:dev-amd64 --amend infiniflow/ragflow:dev-arm64 -docker manifest push infiniflow/ragflow:dev -``` - -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. diff --git a/docs/guides/develop/build_docker_image.mdx b/docs/guides/develop/build_docker_image.mdx new file mode 100644 index 000000000..14ca55ea8 --- /dev/null +++ b/docs/guides/develop/build_docker_image.mdx @@ -0,0 +1,64 @@ +--- +sidebar_position: 1 +slug: /build_docker_image +--- + +# Build a RAGFlow Docker Image +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +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. + +## Target Audience + +- Developers who have added new features or modified the existing code and require a Docker image to view and debug their changes. +- Testers looking to explore the latest features of RAGFlow in a Docker image. + +## Prerequisites + +- CPU ≥ 4 cores +- RAM ≥ 16 GB +- 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 + + + + +This image is approximately 1 GB in size and relies on external LLM and embedding services. + +```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 . +``` + + + + +## 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. + +```bash +git clone https://github.com/infiniflow/ragflow.git +cd ragflow/ +pip3 install huggingface-hub nltk +python3 download_deps.py +docker build -f Dockerfile -t infiniflow/ragflow:dev . +``` + + + \ No newline at end of file