jinhai-2012 commited on
Commit
405e0ff
·
1 Parent(s): 18031e9

Fix README and some comments (#2774)

Browse files

### 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 <[email protected]>

Files changed (5) hide show
  1. Dockerfile +1 -1
  2. Dockerfile.slim +1 -1
  3. README.md +1 -1
  4. docker/.env +1 -1
  5. docs/quickstart.mdx +1 -1
Dockerfile CHANGED
@@ -13,7 +13,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean \
13
  RUN --mount=type=cache,id=ragflow_base_apt,target=/var/cache/apt,sharing=locked \
14
  apt update && apt-get --no-install-recommends install -y ca-certificates
15
 
16
- # If you are at mainland China, you can use tsinghua mirror to speed up apt and poetry
17
  RUN sed -i 's|http://archive.ubuntu.com|https://mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list.d/ubuntu.sources
18
  ENV POETRY_PYPI_MIRROR_URL=https://pypi.tuna.tsinghua.edu.cn/simple/
19
 
 
13
  RUN --mount=type=cache,id=ragflow_base_apt,target=/var/cache/apt,sharing=locked \
14
  apt update && apt-get --no-install-recommends install -y ca-certificates
15
 
16
+ # If you download Python modules too slow, you can use a pip mirror site to speed up apt and poetry
17
  RUN sed -i 's|http://archive.ubuntu.com|https://mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list.d/ubuntu.sources
18
  ENV POETRY_PYPI_MIRROR_URL=https://pypi.tuna.tsinghua.edu.cn/simple/
19
 
Dockerfile.slim CHANGED
@@ -13,7 +13,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean \
13
  RUN --mount=type=cache,id=ragflow_base_apt,target=/var/cache/apt,sharing=locked \
14
  apt update && apt-get --no-install-recommends install -y ca-certificates
15
 
16
- # If you are at mainland China, you can use tsinghua mirror to speed up apt and poetry
17
  RUN sed -i 's|http://archive.ubuntu.com|https://mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list.d/ubuntu.sources
18
  ENV POETRY_PYPI_MIRROR_URL=https://pypi.tuna.tsinghua.edu.cn/simple/
19
 
 
13
  RUN --mount=type=cache,id=ragflow_base_apt,target=/var/cache/apt,sharing=locked \
14
  apt update && apt-get --no-install-recommends install -y ca-certificates
15
 
16
+ # If you download Python modules too slow, you can use a pip mirror site to speed up apt and poetry
17
  RUN sed -i 's|http://archive.ubuntu.com|https://mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list.d/ubuntu.sources
18
  ENV POETRY_PYPI_MIRROR_URL=https://pypi.tuna.tsinghua.edu.cn/simple/
19
 
README.md CHANGED
@@ -153,7 +153,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
153
  ```
154
 
155
  3. Build the pre-built Docker images and start up the server:
156
- > 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.
157
 
158
  ```bash
159
  $ cd ragflow/docker
 
153
  ```
154
 
155
  3. Build the pre-built Docker images and start up the server:
156
+ > 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.
157
 
158
  ```bash
159
  $ cd ragflow/docker
docker/.env CHANGED
@@ -41,7 +41,7 @@ RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim
41
 
42
  TIMEZONE='Asia/Shanghai'
43
 
44
- # If inside mainland China, decomment the following huggingface.co mirror:
45
  # HF_ENDPOINT=https://hf-mirror.com
46
 
47
  ######## OS setup for ES ###########
 
41
 
42
  TIMEZONE='Asia/Shanghai'
43
 
44
+ # If can't download models, try to uncomment the following huggingface.co mirror:
45
  # HF_ENDPOINT=https://hf-mirror.com
46
 
47
  ######## OS setup for ES ###########
docs/quickstart.mdx CHANGED
@@ -177,7 +177,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
177
 
178
  3. Build the pre-built Docker images and start up the server:
179
 
180
- > 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.
181
 
182
  ```bash
183
  $ cd ragflow/docker
 
177
 
178
  3. Build the pre-built Docker images and start up the server:
179
 
180
+ > 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.
181
 
182
  ```bash
183
  $ cd ragflow/docker