From f7a73c51495b3251d1bb7e45626a057eb241c7c2 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Wed, 9 Oct 2024 23:30:00 +0800 Subject: [PATCH] Fix README and some comments (#2774) ### What problem does this PR solve? 1. Fix typo 2. Update comments. ### Type of change - [x] Bug Fix (non-breaking change which fixes an issue) Signed-off-by: Jin Hai --- Dockerfile | 2 +- Dockerfile.slim | 2 +- README.md | 2 +- docker/.env | 2 +- docs/quickstart.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Dockerfile b/Dockerfile index 61a8cc27e..290010998 100644 --- a/Dockerfile +++ b/Dockerfile @@ -13,7 +13,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean \ RUN --mount=type=cache,id=ragflow_base_apt,target=/var/cache/apt,sharing=locked \ apt update && apt-get --no-install-recommends install -y ca-certificates -# If you are at mainland China, you can use tsinghua mirror to speed up apt and poetry +# If you download Python modules too slow, you can use a pip mirror site to speed up apt and poetry RUN sed -i 's|http://archive.ubuntu.com|https://mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list.d/ubuntu.sources ENV POETRY_PYPI_MIRROR_URL=https://pypi.tuna.tsinghua.edu.cn/simple/ diff --git a/Dockerfile.slim b/Dockerfile.slim index 4517ba95e..f0bed4eb8 100644 --- a/Dockerfile.slim +++ b/Dockerfile.slim @@ -13,7 +13,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean \ RUN --mount=type=cache,id=ragflow_base_apt,target=/var/cache/apt,sharing=locked \ apt update && apt-get --no-install-recommends install -y ca-certificates -# If you are at mainland China, you can use tsinghua mirror to speed up apt and poetry +# If you download Python modules too slow, you can use a pip mirror site to speed up apt and poetry RUN sed -i 's|http://archive.ubuntu.com|https://mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list.d/ubuntu.sources ENV POETRY_PYPI_MIRROR_URL=https://pypi.tuna.tsinghua.edu.cn/simple/ diff --git a/README.md b/README.md index 00651d76e..89104f2fb 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ``` 3. Build the pre-built Docker images and start up the server: - > Running the following commands automatically downloads the *slim-dev* 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. + > 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. ```bash $ cd ragflow/docker diff --git a/docker/.env b/docker/.env index 23e9c058f..aaf86ab1f 100644 --- a/docker/.env +++ b/docker/.env @@ -41,7 +41,7 @@ RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim TIMEZONE='Asia/Shanghai' -# If inside mainland China, decomment the following huggingface.co mirror: +# If can't download models, try to uncomment the following huggingface.co mirror: # HF_ENDPOINT=https://hf-mirror.com ######## OS setup for ES ########### diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index d070fb5b5..f99eab396 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -177,7 +177,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If 3. Build the pre-built Docker images and start up the server: - > Running the following commands automatically downloads the *slim-dev* 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. + > 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. ```bash $ cd ragflow/docker