From 3fb2bc7613562325133c616084aebccb9ff426cc Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Tue, 29 Oct 2024 21:05:38 +0800 Subject: [PATCH] Update README (#3092) ### What problem does this PR solve? _Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR._ ### Type of change - [x] Documentation Update Signed-off-by: Jin Hai --- README.md | 110 +++++++++++++++++++++++++++++++++------------------ README_ja.md | 21 ++++++---- README_ko.md | 18 ++++++--- README_zh.md | 18 ++++++--- 4 files changed, 108 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 027420a4d91..33ce52ccdb2 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,21 @@

- - Latest Release + + follow on X(Twitter) - Static Badge + Static Badge + - docker pull infiniflow/ragflow:v0.12.0 + docker pull infiniflow/ragflow:v0.12.0 + + + Latest Release + - license - + license +

@@ -34,7 +39,7 @@
📕 Table of Contents - + - 💡 [What is RAGFlow?](#-what-is-ragflow) - 🎮 [Demo](#-demo) - 📌 [Latest Updates](#-latest-updates) @@ -54,7 +59,10 @@ ## 💡 What is RAGFlow? -[RAGFlow](https://ragflow.io/) is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, combining LLM (Large Language Models) to provide truthful question-answering capabilities, backed by well-founded citations from various complex formatted data. +[RAGFlow](https://ragflow.io/) is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document +understanding. It offers a streamlined RAG workflow for businesses of any scale, combining LLM (Large Language Models) +to provide truthful question-answering capabilities, backed by well-founded citations from various complex formatted +data. ## 🎮 Demo @@ -64,7 +72,6 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). - ## 🔥 Latest Updates - 2024-09-29 Optimizes multi-round conversations. @@ -74,7 +81,9 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). - 2024-08-02 Supports GraphRAG inspired by [graphrag](https://github.com/microsoft/graphrag) and mind map. ## 🎉 Stay Tuned -⭐️ Star our repository to stay up-to-date with exciting new features and improvements! Get instant notifications for new releases! 🌟 + +⭐️ Star our repository to stay up-to-date with exciting new features and improvements! Get instant notifications for new +releases! 🌟
@@ -83,7 +92,8 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ### 🍭 **"Quality in, quality out"** -- [Deep document understanding](./deepdoc/README.md)-based knowledge extraction from unstructured data with complicated formats. +- [Deep document understanding](./deepdoc/README.md)-based knowledge extraction from unstructured data with complicated + formats. - Finds "needle in a data haystack" of literally unlimited tokens. ### 🍱 **Template-based chunking** @@ -121,7 +131,8 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/). + > If you have not installed Docker on your local machine (Windows, Mac, or Linux), + see [Install Docker Engine](https://docs.docker.com/engine/install/). ### 🚀 Start up the server @@ -140,7 +151,8 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). > $ sudo sysctl -w vm.max_map_count=262144 > ``` > - > This change will be reset after a system reboot. To ensure your change remains permanent, add or update the `vm.max_map_count` value in **/etc/sysctl.conf** accordingly: + > This change will be reset after a system reboot. To ensure your change remains permanent, add or update the + `vm.max_map_count` value in **/etc/sysctl.conf** accordingly: > > ```bash > vm.max_map_count=262144 @@ -154,18 +166,27 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). 3. Build the pre-built Docker images and start up the server: - > The command below downloads the dev version Docker image for RAGFlow slim (`dev-slim`). Note that RAGFlow slim Docker images do not include embedding models or Python libraries and hence are approximately 1GB in size. + > The command below downloads the dev version Docker image for RAGFlow slim (`dev-slim`). Note that RAGFlow slim + Docker images do not include embedding models or Python libraries and hence are approximately 1GB in size. ```bash $ cd ragflow/docker $ docker compose -f docker-compose.yml up -d ``` - > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`. After making this change, rerun the command above to initiate the download. - > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, rerun the command above to initiate the download. - > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`. After making this change, rerun the command above to initiate the download. - - > **NOTE:** A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load. + > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in * + *docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`. After + making this change, rerun the command above to initiate the download. + > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the + `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, + rerun the command above to initiate the download. + > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update + the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, + `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`. After making this change, rerun the command above to initiate the + download. + + > **NOTE:** A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size + and may take significantly longer time to load. 4. Check the server status after having the server up and running: @@ -188,11 +209,14 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). * Running on http://x.x.x.x:9380 INFO:werkzeug:Press CTRL+C to quit ``` - > If you skip this confirmation step and directly log in to RAGFlow, your browser may prompt a `network abnormal` error because, at that moment, your RAGFlow may not be fully initialized. + > If you skip this confirmation step and directly log in to RAGFlow, your browser may prompt a `network abnormal` + error because, at that moment, your RAGFlow may not be fully initialized. 5. In your web browser, enter the IP address of your server and log in to RAGFlow. - > With the default settings, you only need to enter `http://IP_OF_YOUR_MACHINE` (**sans** port number) as the default HTTP serving port `80` can be omitted when using the default configurations. -6. In [service_conf.yaml](./docker/service_conf.yaml), select the desired LLM factory in `user_default_llm` and update the `API_KEY` field with the corresponding API key. + > With the default settings, you only need to enter `http://IP_OF_YOUR_MACHINE` (**sans** port number) as the default + HTTP serving port `80` can be omitted when using the default configurations. +6. In [service_conf.yaml](./docker/service_conf.yaml), select the desired LLM factory in `user_default_llm` and update + the `API_KEY` field with the corresponding API key. > See [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) for more information. @@ -202,15 +226,22 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). When it comes to system configurations, you will need to manage the following files: -- [.env](./docker/.env): Keeps the fundamental setups for the system, such as `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, and `MINIO_PASSWORD`. +- [.env](./docker/.env): Keeps the fundamental setups for the system, such as `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, and + `MINIO_PASSWORD`. - [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services. -- [docker-compose.yml](./docker/docker-compose.yml): The system relies on [docker-compose.yml](./docker/docker-compose.yml) to start up. +- [docker-compose.yml](./docker/docker-compose.yml): The system relies + on [docker-compose.yml](./docker/docker-compose.yml) to start up. -You must ensure that changes to the [.env](./docker/.env) file are in line with what are in the [service_conf.yaml](./docker/service_conf.yaml) file. +You must ensure that changes to the [.env](./docker/.env) file are in line with what are in +the [service_conf.yaml](./docker/service_conf.yaml) file. -> The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and you are REQUIRED to ensure that all environment settings listed in the [./docker/README](./docker/README.md) file are aligned with the corresponding configurations in the [service_conf.yaml](./docker/service_conf.yaml) file. +> The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service +> configurations, and you are REQUIRED to ensure that all environment settings listed in +> the [./docker/README](./docker/README.md) file are aligned with the corresponding configurations in +> the [service_conf.yaml](./docker/service_conf.yaml) file. -To update the default HTTP serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` to `:80`. +To update the default HTTP serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` +to `:80`. Updates to the above configurations require a reboot of all containers to take effect: @@ -232,7 +263,7 @@ docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ## 🔧 Build a Docker image including embedding models -This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only. +This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only. ```bash git clone https://github.com/infiniflow/ragflow.git @@ -244,12 +275,12 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev . ## 🔨 Launch service from source for development -1. Install Poetry, or skip this step if it is already installed: +1. Install Poetry, or skip this step if it is already installed: ```bash curl -sSL https://install.python-poetry.org | python3 - ``` -2. Clone the source code and install Python dependencies: +2. Clone the source code and install Python dependencies: ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ @@ -257,42 +288,42 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev . ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules ``` -3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose: +3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose: ```bash docker compose -f docker/docker-compose-base.yml up -d ``` - Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`: + Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`: ``` 127.0.0.1 es01 mysql minio redis ``` In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**. -4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site: - +4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site: + ```bash export HF_ENDPOINT=https://hf-mirror.com ``` -5. Launch backend service: +5. Launch backend service: ```bash source .venv/bin/activate export PYTHONPATH=$(pwd) bash docker/launch_backend_service.sh ``` -6. Install frontend dependencies: +6. Install frontend dependencies: ```bash cd web npm install --force ``` 7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`: -8. Launch frontend service: +8. Launch frontend service: ```bash npm run dev ``` - _The following output confirms a successful launch of the system:_ + _The following output confirms a successful launch of the system:_ ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) @@ -315,4 +346,5 @@ See the [RAGFlow Roadmap 2024](https://github.com/infiniflow/ragflow/issues/162) ## 🙌 Contributing -RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. If you would like to be a part, review our [Contribution Guidelines](./CONTRIBUTING.md) first. +RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. +If you would like to be a part, review our [Contribution Guidelines](./CONTRIBUTING.md) first. diff --git a/README_ja.md b/README_ja.md index e22955d38d7..8e38ea8d7b1 100644 --- a/README_ja.md +++ b/README_ja.md @@ -12,19 +12,24 @@

- - Latest Release + + follow on X(Twitter) - Static Badge + Static Badge + - docker pull infiniflow/ragflow:v0.12.0 - - license - + docker pull infiniflow/ragflow:v0.12.0 + + + Latest Release + + + license +

+

Document | Roadmap | diff --git a/README_ko.md b/README_ko.md index 1c89a5c6933..5e639e55785 100644 --- a/README_ko.md +++ b/README_ko.md @@ -12,18 +12,24 @@

- - Latest Release + + follow on X(Twitter) - Static Badge + Static Badge + - docker pull infiniflow/ragflow:v0.12.0 + docker pull infiniflow/ragflow:v0.12.0 + + + Latest Release + - license - + license +

+

Document | Roadmap | diff --git a/README_zh.md b/README_zh.md index fb1b71d166d..1a94a0e3b89 100644 --- a/README_zh.md +++ b/README_zh.md @@ -12,18 +12,24 @@

- - Latest Release + + follow on X(Twitter) - Static Badge + Static Badge + - docker pull infiniflow/ragflow:v0.12.0 + docker pull infiniflow/ragflow:v0.12.0 + + + Latest Release + - license - + license +

+

Document | Roadmap |