Commit
·
eec6cf8
1
Parent(s):
8872ee4
Fix document error (#3456)
Browse files### What problem does this PR solve?
1. Update README.md
2. Fix error description in docker/.env
### Type of change
- [x] Documentation Update
---------
Signed-off-by: jinhai <[email protected]>
- README.md +2 -2
- README_id.md +2 -2
- README_ja.md +19 -2
- README_ko.md +17 -2
- README_zh.md +24 -2
- docker/.env +1 -1
README.md
CHANGED
|
@@ -274,7 +274,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 274 |
cd ragflow/
|
| 275 |
pip3 install huggingface-hub nltk
|
| 276 |
python3 download_deps.py
|
| 277 |
-
build_docker_image.sh slim
|
| 278 |
```
|
| 279 |
|
| 280 |
## 🔧 Build a Docker image including embedding models
|
|
@@ -286,7 +286,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 286 |
cd ragflow/
|
| 287 |
pip3 install huggingface-hub nltk
|
| 288 |
python3 download_deps.py
|
| 289 |
-
build_docker_image.sh full
|
| 290 |
```
|
| 291 |
|
| 292 |
## 🔨 Launch service from source for development
|
|
|
|
| 274 |
cd ragflow/
|
| 275 |
pip3 install huggingface-hub nltk
|
| 276 |
python3 download_deps.py
|
| 277 |
+
bash build_docker_image.sh slim
|
| 278 |
```
|
| 279 |
|
| 280 |
## 🔧 Build a Docker image including embedding models
|
|
|
|
| 286 |
cd ragflow/
|
| 287 |
pip3 install huggingface-hub nltk
|
| 288 |
python3 download_deps.py
|
| 289 |
+
bash build_docker_image.sh full
|
| 290 |
```
|
| 291 |
|
| 292 |
## 🔨 Launch service from source for development
|
README_id.md
CHANGED
|
@@ -249,7 +249,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 249 |
cd ragflow/
|
| 250 |
pip3 install huggingface-hub nltk
|
| 251 |
python3 download_deps.py
|
| 252 |
-
|
| 253 |
```
|
| 254 |
|
| 255 |
## 🔧 Membangun Docker Image Termasuk Model Embedding
|
|
@@ -261,7 +261,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 261 |
cd ragflow/
|
| 262 |
pip3 install huggingface-hub nltk
|
| 263 |
python3 download_deps.py
|
| 264 |
-
|
| 265 |
```
|
| 266 |
|
| 267 |
## 🔨 Menjalankan Aplikasi dari untuk Pengembangan
|
|
|
|
| 249 |
cd ragflow/
|
| 250 |
pip3 install huggingface-hub nltk
|
| 251 |
python3 download_deps.py
|
| 252 |
+
bash build_docker_image.sh slim
|
| 253 |
```
|
| 254 |
|
| 255 |
## 🔧 Membangun Docker Image Termasuk Model Embedding
|
|
|
|
| 261 |
cd ragflow/
|
| 262 |
pip3 install huggingface-hub nltk
|
| 263 |
python3 download_deps.py
|
| 264 |
+
bash build_docker_image.sh full
|
| 265 |
```
|
| 266 |
|
| 267 |
## 🔨 Menjalankan Aplikasi dari untuk Pengembangan
|
README_ja.md
CHANGED
|
@@ -204,6 +204,23 @@
|
|
| 204 |
> $ docker compose -f docker/docker-compose.yml up -d
|
| 205 |
> ```
|
| 206 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 207 |
## 🔧 ソースコードでDockerイメージを作成(埋め込みモデルなし)
|
| 208 |
|
| 209 |
この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
|
|
@@ -213,7 +230,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 213 |
cd ragflow/
|
| 214 |
pip3 install huggingface-hub nltk
|
| 215 |
python3 download_deps.py
|
| 216 |
-
|
| 217 |
```
|
| 218 |
|
| 219 |
## 🔧 ソースコードをコンパイルしたDockerイメージ(埋め込みモデルを含む)
|
|
@@ -225,7 +242,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 225 |
cd ragflow/
|
| 226 |
pip3 install huggingface-hub nltk
|
| 227 |
python3 download_deps.py
|
| 228 |
-
|
| 229 |
```
|
| 230 |
|
| 231 |
## 🔨 ソースコードからサービスを起動する方法
|
|
|
|
| 204 |
> $ docker compose -f docker/docker-compose.yml up -d
|
| 205 |
> ```
|
| 206 |
|
| 207 |
+
### Elasticsearch から Infinity にドキュメントエンジンを切り替えます
|
| 208 |
+
|
| 209 |
+
RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトルを保存します。[Infinity]に切り替え(https://github.com/infiniflow/infinity/)、次の手順に従います。
|
| 210 |
+
|
| 211 |
+
1. 実行中のすべてのコンテナを停止するには:
|
| 212 |
+
```bash
|
| 213 |
+
$ docker compose -f docker/docker-compose.yml down -v
|
| 214 |
+
```
|
| 215 |
+
2. **docker/.env** の「DOC _ ENGINE」を「infinity」に設定します。
|
| 216 |
+
|
| 217 |
+
3. 起動コンテナ:
|
| 218 |
+
```bash
|
| 219 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 220 |
+
```
|
| 221 |
+
> [!WARNING]
|
| 222 |
+
> Linux/arm64 マシンでの Infinity への切り替えは正式にサポートされていません。
|
| 223 |
+
|
| 224 |
## 🔧 ソースコードでDockerイメージを作成(埋め込みモデルなし)
|
| 225 |
|
| 226 |
この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
|
|
|
|
| 230 |
cd ragflow/
|
| 231 |
pip3 install huggingface-hub nltk
|
| 232 |
python3 download_deps.py
|
| 233 |
+
bash build_docker_image.sh slim
|
| 234 |
```
|
| 235 |
|
| 236 |
## 🔧 ソースコードをコンパイルしたDockerイメージ(埋め込みモデルを含む)
|
|
|
|
| 242 |
cd ragflow/
|
| 243 |
pip3 install huggingface-hub nltk
|
| 244 |
python3 download_deps.py
|
| 245 |
+
bash build_docker_image.sh full
|
| 246 |
```
|
| 247 |
|
| 248 |
## 🔨 ソースコードからサービスを起動する方法
|
README_ko.md
CHANGED
|
@@ -208,6 +208,21 @@
|
|
| 208 |
> $ docker compose -f docker/docker-compose.yml up -d
|
| 209 |
> ```
|
| 210 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 211 |
## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음)
|
| 212 |
|
| 213 |
이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다.
|
|
@@ -217,7 +232,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 217 |
cd ragflow/
|
| 218 |
pip3 install huggingface-hub nltk
|
| 219 |
python3 download_deps.py
|
| 220 |
-
|
| 221 |
```
|
| 222 |
|
| 223 |
## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함)
|
|
@@ -229,7 +244,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 229 |
cd ragflow/
|
| 230 |
pip3 install huggingface-hub nltk
|
| 231 |
python3 download_deps.py
|
| 232 |
-
|
| 233 |
```
|
| 234 |
|
| 235 |
## 🔨 소스 코드로 서비스를 시작합니다.
|
|
|
|
| 208 |
> $ docker compose -f docker/docker-compose.yml up -d
|
| 209 |
> ```
|
| 210 |
|
| 211 |
+
### Elasticsearch 에서 Infinity로 문서 엔진 전환
|
| 212 |
+
|
| 213 |
+
RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및 벡터를 저장합니다. [Infinity]로 전환(https://github.com/infiniflow/infinity/), 다음 절차를 따르십시오.
|
| 214 |
+
1. 실행 중인 모든 컨테이너를 중지합니다.
|
| 215 |
+
```bash
|
| 216 |
+
$docker compose-f docker/docker-compose.yml down-v
|
| 217 |
+
```
|
| 218 |
+
2. **docker/.env**의 "DOC_ENGINE" 을 "infinity" 로 설정합니다.
|
| 219 |
+
3. 컨테이너 부팅:
|
| 220 |
+
```bash
|
| 221 |
+
$docker compose-f docker/docker-compose.yml up-d
|
| 222 |
+
```
|
| 223 |
+
> [!WARNING]
|
| 224 |
+
> Linux/arm64 시스템에서 Infinity로 전환하는 것은 공식적으로 지원되지 않습니다.
|
| 225 |
+
|
| 226 |
## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음)
|
| 227 |
|
| 228 |
이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다.
|
|
|
|
| 232 |
cd ragflow/
|
| 233 |
pip3 install huggingface-hub nltk
|
| 234 |
python3 download_deps.py
|
| 235 |
+
bash build_docker_image.sh slim
|
| 236 |
```
|
| 237 |
|
| 238 |
## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함)
|
|
|
|
| 244 |
cd ragflow/
|
| 245 |
pip3 install huggingface-hub nltk
|
| 246 |
python3 download_deps.py
|
| 247 |
+
bash build_docker_image.sh full
|
| 248 |
```
|
| 249 |
|
| 250 |
## 🔨 소스 코드로 서비스를 시작합니다.
|
README_zh.md
CHANGED
|
@@ -206,6 +206,28 @@
|
|
| 206 |
> $ docker compose -f docker-compose.yml up -d
|
| 207 |
> ```
|
| 208 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 209 |
## 🔧 源码编译 Docker 镜像(不含 embedding 模型)
|
| 210 |
|
| 211 |
本 Docker 镜像大小约 1 GB 左右并且依赖外部的大模型和 embedding 服务。
|
|
@@ -215,7 +237,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 215 |
cd ragflow/
|
| 216 |
pip3 install huggingface-hub nltk
|
| 217 |
python3 download_deps.py
|
| 218 |
-
|
| 219 |
```
|
| 220 |
|
| 221 |
## 🔧 源码编译 Docker 镜像(包含 embedding 模型)
|
|
@@ -227,7 +249,7 @@ git clone https://github.com/infiniflow/ragflow.git
|
|
| 227 |
cd ragflow/
|
| 228 |
pip3 install huggingface-hub nltk
|
| 229 |
python3 download_deps.py
|
| 230 |
-
|
| 231 |
```
|
| 232 |
|
| 233 |
## 🔨 以源代码启动服务
|
|
|
|
| 206 |
> $ docker compose -f docker-compose.yml up -d
|
| 207 |
> ```
|
| 208 |
|
| 209 |
+
### 把文档引擎从 Elasticserch 切换成为 Infinity
|
| 210 |
+
|
| 211 |
+
RAGFlow 默认使用 Elasticsearch 存储文本和向量数据. 如果要切换为 [Infinity](https://github.com/infiniflow/infinity/), 可以按照下面步骤进行:
|
| 212 |
+
|
| 213 |
+
1. 停止所有容器运行:
|
| 214 |
+
|
| 215 |
+
```bash
|
| 216 |
+
$ docker compose -f docker/docker-compose.yml down -v
|
| 217 |
+
```
|
| 218 |
+
|
| 219 |
+
2. 设置 **docker/.env** 目录中的 `DOC_ENGINE` 为 `infinity`.
|
| 220 |
+
|
| 221 |
+
3. 启动容器:
|
| 222 |
+
|
| 223 |
+
```bash
|
| 224 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 225 |
+
```
|
| 226 |
+
|
| 227 |
+
> [!WARNING]
|
| 228 |
+
> Infinity 目前官方并未正式支持在 Linux/arm64 架构下的机器上运行.
|
| 229 |
+
|
| 230 |
+
|
| 231 |
## 🔧 源码编译 Docker 镜像(不含 embedding 模型)
|
| 232 |
|
| 233 |
本 Docker 镜像大小约 1 GB 左右并且依赖外部的大模型和 embedding 服务。
|
|
|
|
| 237 |
cd ragflow/
|
| 238 |
pip3 install huggingface-hub nltk
|
| 239 |
python3 download_deps.py
|
| 240 |
+
bash build_docker_image.sh slim
|
| 241 |
```
|
| 242 |
|
| 243 |
## 🔧 源码编译 Docker 镜像(包含 embedding 模型)
|
|
|
|
| 249 |
cd ragflow/
|
| 250 |
pip3 install huggingface-hub nltk
|
| 251 |
python3 download_deps.py
|
| 252 |
+
bash build_docker_image.sh full
|
| 253 |
```
|
| 254 |
|
| 255 |
## 🔨 以源代码启动服务
|
docker/.env
CHANGED
|
@@ -109,7 +109,7 @@ RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim
|
|
| 109 |
# RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim
|
| 110 |
# RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim
|
| 111 |
#
|
| 112 |
-
# - For the `dev
|
| 113 |
# RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev
|
| 114 |
# RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev
|
| 115 |
|
|
|
|
| 109 |
# RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim
|
| 110 |
# RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim
|
| 111 |
#
|
| 112 |
+
# - For the `dev` edition, uncomment either of the following:
|
| 113 |
# RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev
|
| 114 |
# RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev
|
| 115 |
|