Kevin Hu
commited on
Commit
·
9cb9cc1
1
Parent(s):
8e4f87a
prepare document for release (#2438)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- README.md +2 -2
- README_ja.md +4 -4
- README_ko.md +2 -2
- README_zh.md +3 -3
- docs/guides/configure_knowledge_base.md +1 -1
- docs/guides/manage_files.md +2 -2
- docs/quickstart.mdx +2 -2
README.md
CHANGED
|
@@ -18,7 +18,7 @@
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
| 22 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 23 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 24 |
</a>
|
|
@@ -151,7 +151,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
|
|
| 151 |
|
| 152 |
3. Build the pre-built Docker images and start up the server:
|
| 153 |
|
| 154 |
-
> Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_VERSION` in **docker/.env** to the intended version, for example `RAGFLOW_VERSION=v0.
|
| 155 |
|
| 156 |
```bash
|
| 157 |
$ cd ragflow/docker
|
|
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.11.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.11.0"></a>
|
| 22 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 23 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 24 |
</a>
|
|
|
|
| 151 |
|
| 152 |
3. Build the pre-built Docker images and start up the server:
|
| 153 |
|
| 154 |
+
> Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_VERSION` in **docker/.env** to the intended version, for example `RAGFLOW_VERSION=v0.11.0`, before running the following commands.
|
| 155 |
|
| 156 |
```bash
|
| 157 |
$ cd ragflow/docker
|
README_ja.md
CHANGED
|
@@ -18,8 +18,8 @@
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
| 22 |
-
alt="docker pull infiniflow/ragflow:v0.
|
| 23 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 24 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 25 |
</a>
|
|
@@ -139,7 +139,7 @@
|
|
| 139 |
$ docker compose up -d
|
| 140 |
```
|
| 141 |
|
| 142 |
-
> 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.
|
| 143 |
|
| 144 |
> コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
|
| 145 |
|
|
@@ -201,7 +201,7 @@
|
|
| 201 |
```bash
|
| 202 |
$ git clone https://github.com/infiniflow/ragflow.git
|
| 203 |
$ cd ragflow/
|
| 204 |
-
$ docker build -t infiniflow/ragflow:v0.
|
| 205 |
$ cd ragflow/docker
|
| 206 |
$ chmod +x ./entrypoint.sh
|
| 207 |
$ docker compose up -d
|
|
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.11.0-brightgreen"
|
| 22 |
+
alt="docker pull infiniflow/ragflow:v0.11.0"></a>
|
| 23 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 24 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 25 |
</a>
|
|
|
|
| 139 |
$ docker compose up -d
|
| 140 |
```
|
| 141 |
|
| 142 |
+
> 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.11.0として、上記のコマンドを実行してください。
|
| 143 |
|
| 144 |
> コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
|
| 145 |
|
|
|
|
| 201 |
```bash
|
| 202 |
$ git clone https://github.com/infiniflow/ragflow.git
|
| 203 |
$ cd ragflow/
|
| 204 |
+
$ docker build -t infiniflow/ragflow:v0.11.0 .
|
| 205 |
$ cd ragflow/docker
|
| 206 |
$ chmod +x ./entrypoint.sh
|
| 207 |
$ docker compose up -d
|
README_ko.md
CHANGED
|
@@ -18,7 +18,7 @@
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
| 22 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 23 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 24 |
</a>
|
|
@@ -138,7 +138,7 @@
|
|
| 138 |
|
| 139 |
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
|
| 140 |
|
| 141 |
-
> 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_VERSION`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_VERSION=v0.
|
| 142 |
```bash
|
| 143 |
$ cd ragflow/docker
|
| 144 |
$ chmod +x ./entrypoint.sh
|
|
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.11.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.11.0"></a>
|
| 22 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 23 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 24 |
</a>
|
|
|
|
| 138 |
|
| 139 |
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
|
| 140 |
|
| 141 |
+
> 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_VERSION`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_VERSION=v0.11.0`로 업데이트 한 뒤, 다음 명령어를 실행하세요.
|
| 142 |
```bash
|
| 143 |
$ cd ragflow/docker
|
| 144 |
$ chmod +x ./entrypoint.sh
|
README_zh.md
CHANGED
|
@@ -18,7 +18,7 @@
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
| 22 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 23 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 24 |
</a>
|
|
@@ -137,7 +137,7 @@
|
|
| 137 |
$ docker compose -f docker-compose-CN.yml up -d
|
| 138 |
```
|
| 139 |
|
| 140 |
-
> 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.
|
| 141 |
|
| 142 |
> 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
|
| 143 |
|
|
@@ -199,7 +199,7 @@
|
|
| 199 |
```bash
|
| 200 |
$ git clone https://github.com/infiniflow/ragflow.git
|
| 201 |
$ cd ragflow/
|
| 202 |
-
$ docker build -t infiniflow/ragflow:v0.
|
| 203 |
$ cd ragflow/docker
|
| 204 |
$ chmod +x ./entrypoint.sh
|
| 205 |
$ docker compose up -d
|
|
|
|
| 18 |
<a href="https://demo.ragflow.io" target="_blank">
|
| 19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
| 20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
| 21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.11.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.11.0"></a>
|
| 22 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
| 23 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
| 24 |
</a>
|
|
|
|
| 137 |
$ docker compose -f docker-compose-CN.yml up -d
|
| 138 |
```
|
| 139 |
|
| 140 |
+
> 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.11.0,然后运行上述命令。
|
| 141 |
|
| 142 |
> 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
|
| 143 |
|
|
|
|
| 199 |
```bash
|
| 200 |
$ git clone https://github.com/infiniflow/ragflow.git
|
| 201 |
$ cd ragflow/
|
| 202 |
+
$ docker build -t infiniflow/ragflow:v0.11.0 .
|
| 203 |
$ cd ragflow/docker
|
| 204 |
$ chmod +x ./entrypoint.sh
|
| 205 |
$ docker compose up -d
|
docs/guides/configure_knowledge_base.md
CHANGED
|
@@ -128,7 +128,7 @@ RAGFlow uses multiple recall of both full-text search and vector search in its c
|
|
| 128 |
|
| 129 |
## Search for knowledge base
|
| 130 |
|
| 131 |
-
As of RAGFlow v0.
|
| 132 |
|
| 133 |

|
| 134 |
|
|
|
|
| 128 |
|
| 129 |
## Search for knowledge base
|
| 130 |
|
| 131 |
+
As of RAGFlow v0.11.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
|
| 132 |
|
| 133 |

|
| 134 |
|
docs/guides/manage_files.md
CHANGED
|
@@ -49,7 +49,7 @@ You can link your file to one knowledge base or multiple knowledge bases at one
|
|
| 49 |
|
| 50 |
## Search files or folders
|
| 51 |
|
| 52 |
-
As of RAGFlow v0.
|
| 53 |
|
| 54 |

|
| 55 |
|
|
@@ -81,4 +81,4 @@ RAGFlow's file management allows you to download an uploaded file:
|
|
| 81 |
|
| 82 |

|
| 83 |
|
| 84 |
-
> As of RAGFlow v0.
|
|
|
|
| 49 |
|
| 50 |
## Search files or folders
|
| 51 |
|
| 52 |
+
As of RAGFlow v0.11.0, the search feature is still in a rudimentary form, supporting only file and folder search in the current directory by name (files or folders in the child directory will not be retrieved).
|
| 53 |
|
| 54 |

|
| 55 |
|
|
|
|
| 81 |
|
| 82 |

|
| 83 |
|
| 84 |
+
> As of RAGFlow v0.11.0, bulk download is not supported, nor can you download an entire folder.
|
docs/quickstart.mdx
CHANGED
|
@@ -34,7 +34,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
|
|
| 34 |
|
| 35 |
`vm.max_map_count`. This value sets the maximum number of memory map areas a process may have. Its default value is 65530. While most applications require fewer than a thousand maps, reducing this value can result in abmornal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation.
|
| 36 |
|
| 37 |
-
RAGFlow v0.
|
| 38 |
|
| 39 |
<Tabs
|
| 40 |
defaultValue="linux"
|
|
@@ -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 *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_VERSION` in **docker/.env** to the intended version, for example `RAGFLOW_VERSION=v0.
|
| 181 |
|
| 182 |
```bash
|
| 183 |
$ cd ragflow/docker
|
|
|
|
| 34 |
|
| 35 |
`vm.max_map_count`. This value sets the maximum number of memory map areas a process may have. Its default value is 65530. While most applications require fewer than a thousand maps, reducing this value can result in abmornal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation.
|
| 36 |
|
| 37 |
+
RAGFlow v0.11.0 uses Elasticsearch for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.
|
| 38 |
|
| 39 |
<Tabs
|
| 40 |
defaultValue="linux"
|
|
|
|
| 177 |
|
| 178 |
3. Build the pre-built Docker images and start up the server:
|
| 179 |
|
| 180 |
+
> Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_VERSION` in **docker/.env** to the intended version, for example `RAGFLOW_VERSION=v0.11.0`, before running the following commands.
|
| 181 |
|
| 182 |
```bash
|
| 183 |
$ cd ragflow/docker
|