writinwaters
commited on
Commit
·
4dbdea1
1
Parent(s):
c012263
Updated CN readme (#2661)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- README.md +9 -9
- README_ja.md +78 -0
- README_ko.md +78 -0
- README_zh.md +78 -0
README.md
CHANGED
|
@@ -220,30 +220,30 @@ This image is approximately 1 GB in size and relies on external LLM and embeddin
|
|
| 220 |
git clone https://github.com/infiniflow/ragflow.git
|
| 221 |
cd ragflow/
|
| 222 |
pip3 install huggingface-hub
|
| 223 |
-
python3 download_deps.py
|
| 224 |
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
| 225 |
```
|
| 226 |
|
| 227 |
## 🪚 Build the Docker image including embedding models
|
| 228 |
|
| 229 |
-
This image
|
| 230 |
|
| 231 |
```bash
|
| 232 |
git clone https://github.com/infiniflow/ragflow.git
|
| 233 |
cd ragflow/
|
| 234 |
pip3 install huggingface-hub
|
| 235 |
-
python3 download_deps.py
|
| 236 |
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
| 237 |
```
|
| 238 |
|
| 239 |
## 🔨 Launch service from source for development
|
| 240 |
|
| 241 |
-
1. Install Poetry, or skip this step if it is already installed:
|
| 242 |
```bash
|
| 243 |
curl -sSL https://install.python-poetry.org | python3 -
|
| 244 |
```
|
| 245 |
|
| 246 |
-
2. Clone the source code and install Python dependencies:
|
| 247 |
```bash
|
| 248 |
git clone https://github.com/infiniflow/ragflow.git
|
| 249 |
cd ragflow/
|
|
@@ -251,7 +251,7 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
|
| 251 |
~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
|
| 252 |
```
|
| 253 |
|
| 254 |
-
3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
|
| 255 |
```bash
|
| 256 |
docker compose -f docker/docker-compose-base.yml up -d
|
| 257 |
```
|
|
@@ -262,13 +262,13 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
|
| 262 |
```
|
| 263 |
In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
|
| 264 |
|
| 265 |
-
4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
|
| 266 |
|
| 267 |
```bash
|
| 268 |
export HF_ENDPOINT=https://hf-mirror.com
|
| 269 |
```
|
| 270 |
|
| 271 |
-
5. Launch backend service:
|
| 272 |
```bash
|
| 273 |
source .venv/bin/activate
|
| 274 |
export PYTHONPATH=$(pwd)
|
|
@@ -284,7 +284,7 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
|
| 284 |
8. Launch frontend service:
|
| 285 |
```bash
|
| 286 |
npm run dev
|
| 287 |
-
```
|
| 288 |
|
| 289 |
_The following output confirms a successful launch of the system:_
|
| 290 |
|
|
|
|
| 220 |
git clone https://github.com/infiniflow/ragflow.git
|
| 221 |
cd ragflow/
|
| 222 |
pip3 install huggingface-hub
|
| 223 |
+
python3 download_deps.py
|
| 224 |
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
| 225 |
```
|
| 226 |
|
| 227 |
## 🪚 Build the Docker image including embedding models
|
| 228 |
|
| 229 |
+
This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only.
|
| 230 |
|
| 231 |
```bash
|
| 232 |
git clone https://github.com/infiniflow/ragflow.git
|
| 233 |
cd ragflow/
|
| 234 |
pip3 install huggingface-hub
|
| 235 |
+
python3 download_deps.py
|
| 236 |
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
| 237 |
```
|
| 238 |
|
| 239 |
## 🔨 Launch service from source for development
|
| 240 |
|
| 241 |
+
1. Install Poetry, or skip this step if it is already installed:
|
| 242 |
```bash
|
| 243 |
curl -sSL https://install.python-poetry.org | python3 -
|
| 244 |
```
|
| 245 |
|
| 246 |
+
2. Clone the source code and install Python dependencies:
|
| 247 |
```bash
|
| 248 |
git clone https://github.com/infiniflow/ragflow.git
|
| 249 |
cd ragflow/
|
|
|
|
| 251 |
~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
|
| 252 |
```
|
| 253 |
|
| 254 |
+
3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
|
| 255 |
```bash
|
| 256 |
docker compose -f docker/docker-compose-base.yml up -d
|
| 257 |
```
|
|
|
|
| 262 |
```
|
| 263 |
In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
|
| 264 |
|
| 265 |
+
4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
|
| 266 |
|
| 267 |
```bash
|
| 268 |
export HF_ENDPOINT=https://hf-mirror.com
|
| 269 |
```
|
| 270 |
|
| 271 |
+
5. Launch backend service:
|
| 272 |
```bash
|
| 273 |
source .venv/bin/activate
|
| 274 |
export PYTHONPATH=$(pwd)
|
|
|
|
| 284 |
8. Launch frontend service:
|
| 285 |
```bash
|
| 286 |
npm run dev
|
| 287 |
+
```
|
| 288 |
|
| 289 |
_The following output confirms a successful launch of the system:_
|
| 290 |
|
README_ja.md
CHANGED
|
@@ -194,6 +194,84 @@
|
|
| 194 |
> $ docker-compose up -d
|
| 195 |
> ```
|
| 196 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 197 |
## 📚 ドキュメンテーション
|
| 198 |
|
| 199 |
- [Quickstart](https://ragflow.io/docs/dev/)
|
|
|
|
| 194 |
> $ docker-compose up -d
|
| 195 |
> ```
|
| 196 |
|
| 197 |
+
## 🪛 Build the Docker image without embedding models
|
| 198 |
+
|
| 199 |
+
This image is approximately 1 GB in size and relies on external LLM and embedding services.
|
| 200 |
+
|
| 201 |
+
```bash
|
| 202 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 203 |
+
cd ragflow/
|
| 204 |
+
pip3 install huggingface-hub
|
| 205 |
+
python3 download_deps.py
|
| 206 |
+
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
| 207 |
+
```
|
| 208 |
+
|
| 209 |
+
## 🪚 Build the Docker image including embedding models
|
| 210 |
+
|
| 211 |
+
This image includes embedding models and is approximately 9 GB in size, and so relies on external LLM services only.
|
| 212 |
+
|
| 213 |
+
```bash
|
| 214 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 215 |
+
cd ragflow/
|
| 216 |
+
pip3 install huggingface-hub
|
| 217 |
+
python3 download_deps.py
|
| 218 |
+
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
| 219 |
+
```
|
| 220 |
+
|
| 221 |
+
## 🔨 Launch service from source for development
|
| 222 |
+
|
| 223 |
+
1. Install Poetry, or skip this step if it is already installed:
|
| 224 |
+
```bash
|
| 225 |
+
curl -sSL https://install.python-poetry.org | python3 -
|
| 226 |
+
```
|
| 227 |
+
|
| 228 |
+
2. Clone the source code and install Python dependencies:
|
| 229 |
+
```bash
|
| 230 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 231 |
+
cd ragflow/
|
| 232 |
+
export POETRY_VIRTUALENVS_CREATE=true POETRY_VIRTUALENVS_IN_PROJECT=true
|
| 233 |
+
~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
|
| 234 |
+
```
|
| 235 |
+
|
| 236 |
+
3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
|
| 237 |
+
```bash
|
| 238 |
+
docker compose -f docker/docker-compose-base.yml up -d
|
| 239 |
+
```
|
| 240 |
+
|
| 241 |
+
Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`:
|
| 242 |
+
```
|
| 243 |
+
127.0.0.1 es01 mysql minio redis
|
| 244 |
+
```
|
| 245 |
+
In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
|
| 246 |
+
|
| 247 |
+
4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
|
| 248 |
+
|
| 249 |
+
```bash
|
| 250 |
+
export HF_ENDPOINT=https://hf-mirror.com
|
| 251 |
+
```
|
| 252 |
+
|
| 253 |
+
5. Launch backend service:
|
| 254 |
+
```bash
|
| 255 |
+
source .venv/bin/activate
|
| 256 |
+
export PYTHONPATH=$(pwd)
|
| 257 |
+
bash docker/launch_backend_service.sh
|
| 258 |
+
```
|
| 259 |
+
|
| 260 |
+
6. Install frontend dependencies:
|
| 261 |
+
```bash
|
| 262 |
+
cd web
|
| 263 |
+
npm install --force
|
| 264 |
+
```
|
| 265 |
+
7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`:
|
| 266 |
+
8. Launch frontend service:
|
| 267 |
+
```bash
|
| 268 |
+
npm run dev
|
| 269 |
+
```
|
| 270 |
+
|
| 271 |
+
_The following output confirms a successful launch of the system:_
|
| 272 |
+
|
| 273 |
+

|
| 274 |
+
|
| 275 |
## 📚 ドキュメンテーション
|
| 276 |
|
| 277 |
- [Quickstart](https://ragflow.io/docs/dev/)
|
README_ko.md
CHANGED
|
@@ -199,6 +199,84 @@
|
|
| 199 |
> $ docker-compose up -d
|
| 200 |
> ```
|
| 201 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 202 |
## 📚 문서
|
| 203 |
|
| 204 |
- [Quickstart](https://ragflow.io/docs/dev/)
|
|
|
|
| 199 |
> $ docker-compose up -d
|
| 200 |
> ```
|
| 201 |
|
| 202 |
+
## 🪛 Build the Docker image without embedding models
|
| 203 |
+
|
| 204 |
+
This image is approximately 1 GB in size and relies on external LLM and embedding services.
|
| 205 |
+
|
| 206 |
+
```bash
|
| 207 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 208 |
+
cd ragflow/
|
| 209 |
+
pip3 install huggingface-hub
|
| 210 |
+
python3 download_deps.py
|
| 211 |
+
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
| 212 |
+
```
|
| 213 |
+
|
| 214 |
+
## 🪚 Build the Docker image including embedding models
|
| 215 |
+
|
| 216 |
+
This image includes embedding models and is approximately 9 GB in size, and so relies on external LLM services only.
|
| 217 |
+
|
| 218 |
+
```bash
|
| 219 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 220 |
+
cd ragflow/
|
| 221 |
+
pip3 install huggingface-hub
|
| 222 |
+
python3 download_deps.py
|
| 223 |
+
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
| 224 |
+
```
|
| 225 |
+
|
| 226 |
+
## 🔨 Launch service from source for development
|
| 227 |
+
|
| 228 |
+
1. Install Poetry, or skip this step if it is already installed:
|
| 229 |
+
```bash
|
| 230 |
+
curl -sSL https://install.python-poetry.org | python3 -
|
| 231 |
+
```
|
| 232 |
+
|
| 233 |
+
2. Clone the source code and install Python dependencies:
|
| 234 |
+
```bash
|
| 235 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 236 |
+
cd ragflow/
|
| 237 |
+
export POETRY_VIRTUALENVS_CREATE=true POETRY_VIRTUALENVS_IN_PROJECT=true
|
| 238 |
+
~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
|
| 239 |
+
```
|
| 240 |
+
|
| 241 |
+
3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
|
| 242 |
+
```bash
|
| 243 |
+
docker compose -f docker/docker-compose-base.yml up -d
|
| 244 |
+
```
|
| 245 |
+
|
| 246 |
+
Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`:
|
| 247 |
+
```
|
| 248 |
+
127.0.0.1 es01 mysql minio redis
|
| 249 |
+
```
|
| 250 |
+
In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
|
| 251 |
+
|
| 252 |
+
4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
|
| 253 |
+
|
| 254 |
+
```bash
|
| 255 |
+
export HF_ENDPOINT=https://hf-mirror.com
|
| 256 |
+
```
|
| 257 |
+
|
| 258 |
+
5. Launch backend service:
|
| 259 |
+
```bash
|
| 260 |
+
source .venv/bin/activate
|
| 261 |
+
export PYTHONPATH=$(pwd)
|
| 262 |
+
bash docker/launch_backend_service.sh
|
| 263 |
+
```
|
| 264 |
+
|
| 265 |
+
6. Install frontend dependencies:
|
| 266 |
+
```bash
|
| 267 |
+
cd web
|
| 268 |
+
npm install --force
|
| 269 |
+
```
|
| 270 |
+
7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`:
|
| 271 |
+
8. Launch frontend service:
|
| 272 |
+
```bash
|
| 273 |
+
npm run dev
|
| 274 |
+
```
|
| 275 |
+
|
| 276 |
+
_The following output confirms a successful launch of the system:_
|
| 277 |
+
|
| 278 |
+

|
| 279 |
+
|
| 280 |
## 📚 문서
|
| 281 |
|
| 282 |
- [Quickstart](https://ragflow.io/docs/dev/)
|
README_zh.md
CHANGED
|
@@ -192,6 +192,84 @@
|
|
| 192 |
> $ docker compose -f docker-compose-CN.yml up -d
|
| 193 |
> ```
|
| 194 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 195 |
## 📚 技术文档
|
| 196 |
|
| 197 |
- [Quickstart](https://ragflow.io/docs/dev/)
|
|
|
|
| 192 |
> $ docker compose -f docker-compose-CN.yml up -d
|
| 193 |
> ```
|
| 194 |
|
| 195 |
+
## 🪛 源码编译 Docker 镜像(不含 embedding 模型)
|
| 196 |
+
|
| 197 |
+
本 Docker 镜像大小约 1 GB 左右并且依赖外部的大模型和 embedding 服务。
|
| 198 |
+
|
| 199 |
+
```bash
|
| 200 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 201 |
+
cd ragflow/
|
| 202 |
+
pip3 install huggingface-hub
|
| 203 |
+
python3 download_deps.py
|
| 204 |
+
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
|
| 205 |
+
```
|
| 206 |
+
|
| 207 |
+
## 🪚 源码编译 Docker 镜像(包含 embedding 模型)
|
| 208 |
+
|
| 209 |
+
本 Docker 大小约 9 GB 左右。由于已包含 embedding 模型,所以只需依赖外部的大模型服务即可。
|
| 210 |
+
|
| 211 |
+
```bash
|
| 212 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 213 |
+
cd ragflow/
|
| 214 |
+
pip3 install huggingface-hub
|
| 215 |
+
python3 download_deps.py
|
| 216 |
+
docker build -f Dockerfile -t infiniflow/ragflow:dev .
|
| 217 |
+
```
|
| 218 |
+
|
| 219 |
+
## 🔨 以源代码启动服务
|
| 220 |
+
|
| 221 |
+
1. 安装 Poetry。如已经安装,可跳过本步骤:
|
| 222 |
+
```bash
|
| 223 |
+
curl -sSL https://install.python-poetry.org | python3 -
|
| 224 |
+
```
|
| 225 |
+
|
| 226 |
+
2. 下载源代码并安装 Python 依赖:
|
| 227 |
+
```bash
|
| 228 |
+
git clone https://github.com/infiniflow/ragflow.git
|
| 229 |
+
cd ragflow/
|
| 230 |
+
export POETRY_VIRTUALENVS_CREATE=true POETRY_VIRTUALENVS_IN_PROJECT=true
|
| 231 |
+
~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
|
| 232 |
+
```
|
| 233 |
+
|
| 234 |
+
3. 通过 Docker Compose 启动依赖的服务(MinIO, Elasticsearch, Redis, and MySQL):
|
| 235 |
+
```bash
|
| 236 |
+
docker compose -f docker/docker-compose-base.yml up -d
|
| 237 |
+
```
|
| 238 |
+
|
| 239 |
+
在 `/etc/hosts` 中添加以下代码,将 **docker/service_conf.yaml** 文件中的所有 host 地址都解析为 `127.0.0.1`:
|
| 240 |
+
```
|
| 241 |
+
127.0.0.1 es01 mysql minio redis
|
| 242 |
+
```
|
| 243 |
+
在文件 **docker/service_conf.yaml** 中,对照 **docker/.env** 的配置将 mysql 端口更新为 `5455`,es 端口更新为 `1200`。
|
| 244 |
+
|
| 245 |
+
4. 如果无法访问 HuggingFace,可以把环境变量 `HF_ENDPOINT` 设成相应的镜像站点:
|
| 246 |
+
|
| 247 |
+
```bash
|
| 248 |
+
export HF_ENDPOINT=https://hf-mirror.com
|
| 249 |
+
```
|
| 250 |
+
|
| 251 |
+
5. 启动后端服务:
|
| 252 |
+
```bash
|
| 253 |
+
source .venv/bin/activate
|
| 254 |
+
export PYTHONPATH=$(pwd)
|
| 255 |
+
bash docker/launch_backend_service.sh
|
| 256 |
+
```
|
| 257 |
+
|
| 258 |
+
6. 安装前端依赖:
|
| 259 |
+
```bash
|
| 260 |
+
cd web
|
| 261 |
+
npm install --force
|
| 262 |
+
```
|
| 263 |
+
7. 配置前端,将 **.umirc.ts** 的 `proxy.target` 更新为 `http://127.0.0.1:9380`:
|
| 264 |
+
8. 启动前端服务:
|
| 265 |
+
```bash
|
| 266 |
+
npm run dev
|
| 267 |
+
```
|
| 268 |
+
|
| 269 |
+
_以下界面说明系统已经成功启动:_
|
| 270 |
+
|
| 271 |
+

|
| 272 |
+
|
| 273 |
## 📚 技术文档
|
| 274 |
|
| 275 |
- [Quickstart](https://ragflow.io/docs/dev/)
|