From 87e46b4425d0a4b5325a536571b75cb49b5e0e43 Mon Sep 17 00:00:00 2001 From: Zhichang Yu Date: Tue, 10 Dec 2024 12:11:39 +0800 Subject: [PATCH] Fixed README (#3956) ### What problem does this PR solve? Fixed README ### Type of change - [x] Documentation Update --- README.md | 4 ++-- README_id.md | 4 ++-- README_ja.md | 6 +++--- README_ko.md | 10 +++++----- README_zh.md | 10 +++++----- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index fd533431f..a71e5cf23 100644 --- a/README.md +++ b/README.md @@ -171,8 +171,8 @@ releases! 🌟 Docker images do not include embedding models or Python libraries and hence are approximately 2 GB in size. ```bash - $ cd ragflow/docker - $ docker compose -f docker-compose.yml up -d + $ cd ragflow + $ docker compose -f docker/docker-compose.yml up -d ``` | RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | diff --git a/README_id.md b/README_id.md index 54e21040f..61a8ff553 100644 --- a/README_id.md +++ b/README_id.md @@ -164,8 +164,8 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io). tidak termasuk model embedding atau library Python dan berukuran sekitar 1GB. ```bash - $ cd ragflow/docker - $ docker compose -f docker-compose.yml up -d + $ cd ragflow + $ docker compose -f docker/docker-compose.yml up -d ``` | RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | diff --git a/README_ja.md b/README_ja.md index 62977d19b..a5e439b08 100644 --- a/README_ja.md +++ b/README_ja.md @@ -144,8 +144,8 @@ > 以下のコマンドは、RAGFlow slim（`v0.14.1-slim`）の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。 ```bash - $ cd ragflow/docker - $ docker compose -f docker-compose.yml up -d + $ cd ragflow + $ docker compose -f docker/docker-compose.yml up -d ``` | RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | @@ -198,7 +198,7 @@ [.env](./docker/.env) ファイルの変更が [service_conf.yaml.template](./docker/service_conf.yaml.template) ファイルの内容と一致していることを確認する必要があります。 -> [./docker/README](./docker/README.md) ファイルは環境設定とサービスコンフィグの詳細な説明を提供し、[./docker/README](./docker/README.md) ファイルに記載されている全ての環境設定が [service_conf.yaml.template](./docker/service_conf.yaml.template) ファイルの対応するコンフィグと一致していることを確認することが義務付けられています。 +> [./docker/README](./docker/README.md) ファイル ./docker/README には、service_conf.yaml.template ファイルで ${ENV_VARS} として使用できる環境設定とサービス構成の詳細な説明が含まれています。 デフォルトの HTTP サービングポート(80)を更新するには、[docker-compose.yml](./docker/docker-compose.yml) にアクセスして、`80:80` を `:80` に変更します。 diff --git a/README_ko.md b/README_ko.md index 16fe4f499..1c21066b7 100644 --- a/README_ko.md +++ b/README_ko.md @@ -148,8 +148,8 @@ > 아래의 명령은 RAGFlow slim(v0.14.1-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다. ```bash - $ cd ragflow/docker - $ docker compose -f docker-compose.yml up -d + $ cd ragflow + $ docker compose -f docker/docker-compose.yml up -d ``` @@ -204,7 +204,7 @@ [.env](./docker/.env) 파일의 변경 사항이 [service_conf.yaml.template](./docker/service_conf.yaml.template) 파일의 내용과 일치하도록 해야 합니다. -> [./docker/README](./docker/README.md) 파일에는 환경 설정과 서비스 구성에 대한 자세한 설명이 있으며, [./docker/README](./docker/README.md) 파일에 나열된 모든 환경 설정이 [service_conf.yaml.template](./docker/service_conf.yaml.template) 파일의 해당 구성과 일치하도록 해야 합니다. +> [./docker/README](./docker/README.md) 파일 ./docker/README은 service_conf.yaml.template 파일에서 ${ENV_VARS}로 사용할 수 있는 환경 설정과 서비스 구성에 대한 자세한 설명을 제공합니다. 기본 HTTP 서비스 포트(80)를 업데이트하려면 [docker-compose.yml](./docker/docker-compose.yml) 파일에서 `80:80`을 `:80`으로 변경하세요. @@ -219,12 +219,12 @@ RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및 벡터를 저장합니다. [Infinity]로 전환(https://github.com/infiniflow/infinity/), 다음 절차를 따르십시오. 1. 실행 중인 모든 컨테이너를 중지합니다. ```bash - $docker compose-f docker/docker-compose.yml down-v + $docker compose-f docker/docker-compose.yml down -v ``` 2. **docker/.env**의 "DOC_ENGINE" 을 "infinity" 로 설정합니다. 3. 컨테이너 부팅: ```bash - $docker compose-f docker/docker-compose.yml up-d + $docker compose-f docker/docker-compose.yml up -d ``` > [!WARNING] > Linux/arm64 시스템에서 Infinity로 전환하는 것은 공식적으로 지원되지 않습니다. diff --git a/README_zh.md b/README_zh.md index 1b756ae35..4d15cbb8b 100644 --- a/README_zh.md +++ b/README_zh.md @@ -145,8 +145,8 @@ > 运行以下命令会自动下载 v0.14.1 版的 RAGFlow slim Docker 镜像（`v0.14.1-slim`），该镜像并不包含 embedding 模型以及一些 Python 库，因此镜像大小约 1GB。 ```bash - $ cd ragflow/docker - $ docker compose -f docker-compose.yml up -d + $ cd ragflow + $ docker compose -f docker/docker-compose.yml up -d ``` | RAGFLOW_IMAGE tag in docker/.env | 尺寸 | 内置 embedding 模型和相关 Python 库? | 描述 | @@ -199,16 +199,16 @@ 请务必确保 [.env](./docker/.env) 文件中的变量设置与 [service_conf.yaml.template](./docker/service_conf.yaml.template) 文件中的配置保持一致！ -如果不能访问镜像站点hub.docker.com或者模型站点huggingface.co，请按照[.env](./docker/.env)注释修改`RAGFLOW_IMAGE`和`HF_ENDPOINT`。 +如果不能访问镜像站点 hub.docker.com 或者模型站点 huggingface.co，请按照 [.env](./docker/.env) 注释修改 `RAGFLOW_IMAGE` 和 `HF_ENDPOINT`。 -> [./docker/README](./docker/README.md) 文件提供了环境变量设置和服务配置的详细信息。请**一定要**确保 [./docker/README](./docker/README.md) 文件当中列出来的环境变量的值与 [service_conf.yaml.template](./docker/service_conf.yaml.template) 文件当中的系统配置保持一致。 +> [./docker/README](./docker/README.md) 解释了 [service_conf.yaml.template](./docker/service_conf.yaml.template) 用到的环境变量设置和服务配置。 如需更新默认的 HTTP 服务端口(80), 可以在 [docker-compose.yml](./docker/docker-compose.yml) 文件中将配置 `80:80` 改为 `:80`。 > 所有系统配置都需要通过系统重启生效： > > ```bash -> $ docker compose -f docker-compose.yml up -d +> $ docker compose -f docker/docker-compose.yml up -d > ``` ### 把文档引擎从 Elasticsearch 切换成为 Infinity