Fixed README (#3956)
Browse files### What problem does this PR solve?
Fixed README
### Type of change
- [x] Documentation Update
- README.md +2 -2
- README_id.md +2 -2
- README_ja.md +3 -3
- README_ko.md +5 -5
- README_zh.md +5 -5
README.md
CHANGED
|
@@ -171,8 +171,8 @@ releases! 🌟
|
|
| 171 |
Docker images do not include embedding models or Python libraries and hence are approximately 2 GB in size.
|
| 172 |
|
| 173 |
```bash
|
| 174 |
-
$ cd ragflow
|
| 175 |
-
$ docker compose -f docker-compose.yml up -d
|
| 176 |
```
|
| 177 |
|
| 178 |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
|
|
|
|
| 171 |
Docker images do not include embedding models or Python libraries and hence are approximately 2 GB in size.
|
| 172 |
|
| 173 |
```bash
|
| 174 |
+
$ cd ragflow
|
| 175 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 176 |
```
|
| 177 |
|
| 178 |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
|
README_id.md
CHANGED
|
@@ -164,8 +164,8 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
|
|
| 164 |
tidak termasuk model embedding atau library Python dan berukuran sekitar 1GB.
|
| 165 |
|
| 166 |
```bash
|
| 167 |
-
$ cd ragflow
|
| 168 |
-
$ docker compose -f docker-compose.yml up -d
|
| 169 |
```
|
| 170 |
|
| 171 |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
|
|
|
|
| 164 |
tidak termasuk model embedding atau library Python dan berukuran sekitar 1GB.
|
| 165 |
|
| 166 |
```bash
|
| 167 |
+
$ cd ragflow
|
| 168 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 169 |
```
|
| 170 |
|
| 171 |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
|
README_ja.md
CHANGED
|
@@ -144,8 +144,8 @@
|
|
| 144 |
> 以下のコマンドは、RAGFlow slim(`v0.14.1-slim`)の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。
|
| 145 |
|
| 146 |
```bash
|
| 147 |
-
$ cd ragflow
|
| 148 |
-
$ docker compose -f docker-compose.yml up -d
|
| 149 |
```
|
| 150 |
|
| 151 |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
|
|
@@ -198,7 +198,7 @@
|
|
| 198 |
|
| 199 |
[.env](./docker/.env) ファイルの変更が [service_conf.yaml.template](./docker/service_conf.yaml.template) ファイルの内容と一致していることを確認する必要があります。
|
| 200 |
|
| 201 |
-
> [./docker/README](./docker/README.md)
|
| 202 |
|
| 203 |
デフォルトの HTTP サービングポート(80)を更新するには、[docker-compose.yml](./docker/docker-compose.yml) にアクセスして、`80:80` を `<YOUR_SERVING_PORT>:80` に変更します。
|
| 204 |
|
|
|
|
| 144 |
> 以下のコマンドは、RAGFlow slim(`v0.14.1-slim`)の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。
|
| 145 |
|
| 146 |
```bash
|
| 147 |
+
$ cd ragflow
|
| 148 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 149 |
```
|
| 150 |
|
| 151 |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
|
|
|
|
| 198 |
|
| 199 |
[.env](./docker/.env) ファイルの変更が [service_conf.yaml.template](./docker/service_conf.yaml.template) ファイルの内容と一致していることを確認する必要があります。
|
| 200 |
|
| 201 |
+
> [./docker/README](./docker/README.md) ファイル ./docker/README には、service_conf.yaml.template ファイルで ${ENV_VARS} として使用できる環境設定とサービス構成の詳細な説明が含まれています。
|
| 202 |
|
| 203 |
デフォルトの HTTP サービングポート(80)を更新するには、[docker-compose.yml](./docker/docker-compose.yml) にアクセスして、`80:80` を `<YOUR_SERVING_PORT>:80` に変更します。
|
| 204 |
|
README_ko.md
CHANGED
|
@@ -148,8 +148,8 @@
|
|
| 148 |
> 아래의 명령은 RAGFlow slim(v0.14.1-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다.
|
| 149 |
|
| 150 |
```bash
|
| 151 |
-
$ cd ragflow
|
| 152 |
-
$ docker compose -f docker-compose.yml up -d
|
| 153 |
```
|
| 154 |
|
| 155 |
|
|
@@ -204,7 +204,7 @@
|
|
| 204 |
|
| 205 |
[.env](./docker/.env) 파일의 변경 사항이 [service_conf.yaml.template](./docker/service_conf.yaml.template) 파일의 내용과 일치하도록 해야 합니다.
|
| 206 |
|
| 207 |
-
> [./docker/README](./docker/README.md)
|
| 208 |
|
| 209 |
기본 HTTP 서비스 포트(80)를 업데이트하려면 [docker-compose.yml](./docker/docker-compose.yml) 파일에서 `80:80`을 `<YOUR_SERVING_PORT>:80`으로 변경하세요.
|
| 210 |
|
|
@@ -219,12 +219,12 @@
|
|
| 219 |
RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및 벡터를 저장합니다. [Infinity]로 전환(https://github.com/infiniflow/infinity/), 다음 절차를 따르십시오.
|
| 220 |
1. 실행 중인 모든 컨테이너를 중지합니다.
|
| 221 |
```bash
|
| 222 |
-
$docker compose-f docker/docker-compose.yml down-v
|
| 223 |
```
|
| 224 |
2. **docker/.env**의 "DOC_ENGINE" 을 "infinity" 로 설정합니다.
|
| 225 |
3. 컨테이너 부팅:
|
| 226 |
```bash
|
| 227 |
-
$docker compose-f docker/docker-compose.yml up-d
|
| 228 |
```
|
| 229 |
> [!WARNING]
|
| 230 |
> Linux/arm64 시스템에서 Infinity로 전환하는 것은 공식적으로 지원되지 않습니다.
|
|
|
|
| 148 |
> 아래의 명령은 RAGFlow slim(v0.14.1-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다.
|
| 149 |
|
| 150 |
```bash
|
| 151 |
+
$ cd ragflow
|
| 152 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 153 |
```
|
| 154 |
|
| 155 |
|
|
|
|
| 204 |
|
| 205 |
[.env](./docker/.env) 파일의 변경 사항이 [service_conf.yaml.template](./docker/service_conf.yaml.template) 파일의 내용과 일치하도록 해야 합니다.
|
| 206 |
|
| 207 |
+
> [./docker/README](./docker/README.md) 파일 ./docker/README은 service_conf.yaml.template 파일에서 ${ENV_VARS}로 사용할 수 있는 환경 설정과 서비스 구성에 대한 자세한 설명을 제공합니다.
|
| 208 |
|
| 209 |
기본 HTTP 서비스 포트(80)를 업데이트하려면 [docker-compose.yml](./docker/docker-compose.yml) 파일에서 `80:80`을 `<YOUR_SERVING_PORT>:80`으로 변경하세요.
|
| 210 |
|
|
|
|
| 219 |
RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및 벡터를 저장합니다. [Infinity]로 전환(https://github.com/infiniflow/infinity/), 다음 절차를 따르십시오.
|
| 220 |
1. 실행 중인 모든 컨테이너를 중지합니다.
|
| 221 |
```bash
|
| 222 |
+
$docker compose-f docker/docker-compose.yml down -v
|
| 223 |
```
|
| 224 |
2. **docker/.env**의 "DOC_ENGINE" 을 "infinity" 로 설정합니다.
|
| 225 |
3. 컨테이너 부팅:
|
| 226 |
```bash
|
| 227 |
+
$docker compose-f docker/docker-compose.yml up -d
|
| 228 |
```
|
| 229 |
> [!WARNING]
|
| 230 |
> Linux/arm64 시스템에서 Infinity로 전환하는 것은 공식적으로 지원되지 않습니다.
|
README_zh.md
CHANGED
|
@@ -145,8 +145,8 @@
|
|
| 145 |
> 运行以下命令会自动下载 v0.14.1 版的 RAGFlow slim Docker 镜像(`v0.14.1-slim`),该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB。
|
| 146 |
|
| 147 |
```bash
|
| 148 |
-
$ cd ragflow
|
| 149 |
-
$ docker compose -f docker-compose.yml up -d
|
| 150 |
```
|
| 151 |
|
| 152 |
| RAGFLOW_IMAGE tag in docker/.env | 尺寸 | 内置 embedding 模型和相关 Python 库? | 描述 |
|
|
@@ -199,16 +199,16 @@
|
|
| 199 |
|
| 200 |
请务必确保 [.env](./docker/.env) 文件中的变量设置与 [service_conf.yaml.template](./docker/service_conf.yaml.template) 文件中的配置保持一致!
|
| 201 |
|
| 202 |
-
如果不能访问镜像站点hub.docker.com或者模型站点huggingface.co,请按照[.env](./docker/.env)
|
| 203 |
|
| 204 |
-
> [./docker/README](./docker/README.md)
|
| 205 |
|
| 206 |
如需更新默认的 HTTP 服务端口(80), 可以在 [docker-compose.yml](./docker/docker-compose.yml) 文件中将配置 `80:80` 改为 `<YOUR_SERVING_PORT>:80`。
|
| 207 |
|
| 208 |
> 所有系统配置都需要通过系统重启生效:
|
| 209 |
>
|
| 210 |
> ```bash
|
| 211 |
-
> $ docker compose -f docker-compose.yml up -d
|
| 212 |
> ```
|
| 213 |
|
| 214 |
### 把文档引擎从 Elasticsearch 切换成为 Infinity
|
|
|
|
| 145 |
> 运行以下命令会自动下载 v0.14.1 版的 RAGFlow slim Docker 镜像(`v0.14.1-slim`),该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB。
|
| 146 |
|
| 147 |
```bash
|
| 148 |
+
$ cd ragflow
|
| 149 |
+
$ docker compose -f docker/docker-compose.yml up -d
|
| 150 |
```
|
| 151 |
|
| 152 |
| RAGFLOW_IMAGE tag in docker/.env | 尺寸 | 内置 embedding 模型和相关 Python 库? | 描述 |
|
|
|
|
| 199 |
|
| 200 |
请务必确保 [.env](./docker/.env) 文件中的变量设置与 [service_conf.yaml.template](./docker/service_conf.yaml.template) 文件中的配置保持一致!
|
| 201 |
|
| 202 |
+
如果不能访问镜像站点 hub.docker.com 或者模型站点 huggingface.co,请按照 [.env](./docker/.env) 注释修改 `RAGFLOW_IMAGE` 和 `HF_ENDPOINT`。
|
| 203 |
|
| 204 |
+
> [./docker/README](./docker/README.md) 解释了 [service_conf.yaml.template](./docker/service_conf.yaml.template) 用到的环境变量设置和服务配置。
|
| 205 |
|
| 206 |
如需更新默认的 HTTP 服务端口(80), 可以在 [docker-compose.yml](./docker/docker-compose.yml) 文件中将配置 `80:80` 改为 `<YOUR_SERVING_PORT>:80`。
|
| 207 |
|
| 208 |
> 所有系统配置都需要通过系统重启生效:
|
| 209 |
>
|
| 210 |
> ```bash
|
| 211 |
+
> $ docker compose -f docker/docker-compose.yml up -d
|
| 212 |
> ```
|
| 213 |
|
| 214 |
### 把文档引擎从 Elasticsearch 切换成为 Infinity
|