infiniflow/ragflow repository overview

⁠ ⁠ ⁠ ⁠

⁠📝 Prerequisites

• CPU >= 4 cores
• 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⁠.

⁠🚀 Start up the server

1. Ensure vm.max_map_count >= 262144:

   To check the value of vm.max_map_count:

   $ sysctl vm.max_map_count
   

   Copy

   Reset vm.max_map_count to a value at least 262144 if it is not.

   # In this case, we set it to 262144:
   $ sudo sysctl -w vm.max_map_count=262144
   

   Copy

   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:

   vm.max_map_count=262144
   

   Copy

2. Clone the repo:

   $ git clone https://github.com/infiniflow/ragflow.git
   

   Copy

3. Start up the server using the pre-built Docker images:

   The command below downloads the v0.15.0-slim edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from v0.14.1-slim, update the RAGFLOW_IMAGE variable accordingly in docker/.env before using docker compose to start the server. For example: set RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 for the full edition v0.14.1.

   $ cd ragflow
   $ docker compose -f docker/docker-compose.yml up -d
   

   Copy

   RAGFlow image tag	Image size (GB)	Has embedding models?	Stable?
   v0.15.0	≈9	:heavy_check_mark:	Stable release
   v0.15.0-slim	≈2	❌	Stable release
   nightly	≈9	:heavy_check_mark:	Unstable nightly build
   nightly-slim	≈2	❌	Unstable nightly build

4. Check the server status after having the server up and running:

   $ docker logs -f ragflow-server
   

   Copy

   The following output confirms a successful launch of the system:

   
         ____   ___    ______ ______ __               
        / __ \ /   |  / ____// ____// /____  _      __
       / /_/ // /| | / / __ / /_   / // __ \| | /| / /
      / _, _// ___ |/ /_/ // __/  / // /_/ /| |/ |/ / 
     /_/ |_|/_/  |_|\____//_/    /_/ \____/ |__/|__/ 
   
    * Running on all addresses (0.0.0.0)
    * Running on http://127.0.0.1:9380
    * Running on http://x.x.x.x:9380
    INFO:werkzeug:Press CTRL+C to quit
   

   Copy

   If you skip this confirmation step and directly log in to RAGFlow, your browser may prompt a network anormal 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.template⁠, 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⁠ for more information.

   The show is on!

⁠🔧 Configurations

When it comes to system configurations, you will need to manage the following files:

• .env⁠: Keeps the fundamental setups for the system, such as SVR_HTTP_PORT, MYSQL_PASSWORD, and MINIO_PASSWORD.
• service_conf.yaml.template⁠: Configures the back-end services. The environment variables in this file will be automatically populated when the Docker container starts. Any environment variables set within the Docker container will be available for use, allowing you to customize service behavior based on the deployment environment.
• docker-compose.yml⁠: The system relies on docker-compose.yml⁠ to start up.

To update the default HTTP serving port (80), go to docker-compose.yml⁠ and change 80:80 to <YOUR_SERVING_PORT>:80.

Updates to the above configurations require a reboot of all containers to take effect:

⁠Switch doc engine from Elasticsearch to Infinity

RAGFlow uses Elasticsearch by default for storing full text and vectors. To switch to Infinity⁠, follow these steps:

1. Stop all running containers:

   $ docker compose -f docker/docker-compose.yml down -v
   

   Copy

2. Set DOC_ENGINE in docker/.env to infinity.

3. Start the containers:

   $ docker compose -f docker/docker-compose.yml up -d
   

   Copy