infiniflow/ragflow

</a>
<a href="[***]" target="_blank">
    
</a>
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
    
</a>
<a href="https://github.com/infiniflow/ragflow/releases/latest">
    
</a>
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
    
</a>
<a href="[***]">
    
</a>

[!TIP] If you have not installed Docker on your local machine (Windows, Mac, or Linux), see https://docs.docker.com/engine/install/.

🚀 Start up the server

1. Ensure vm.max_map_count >= 262144:

   To check the value of vm.max_map_count:

   bash
   $ sysctl vm.max_map_count
   

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

   bash
   # In this case, we set it to 262144:
   $ 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:

   bash
   vm.max_map_count=262144
   

2. Clone the repo:

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

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

[!CAUTION] All Docker images are built for x86 platforms. We don't currently offer Docker images for ARM64. If you are on an ARM64 platform, follow this guide to build a Docker image compatible with your system.

The command below downloads the v0.25.6 edition of the RAGFlow Docker image. See the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from v0.25.6, update the RAGFLOW_IMAGE variable accordingly in docker/.env before using docker compose to start the server.

bash
   $ cd ragflow/docker

   # git checkout v0.25.6
   # Optional: use a stable tag (see releases: https://github.com/infiniflow/ragflow/releases)
   # This step ensures the **entrypoint.sh** file in the code matches the Docker image version.

   # Use CPU for DeepDoc tasks:
   $ docker compose -f docker-compose.yml up -d

   # To use GPU to accelerate DeepDoc tasks:
   # sed -i '1i DEVICE=gpu' .env
   # docker compose -f docker-compose.yml up -d

Note: Prior to v0.22.0, we provided both images with embedding models and slim images without embedding models. Details as follows:

Starting with v0.22.0, we ship only the slim edition and no longer append the -slim suffix to the image tag.

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

   bash
   $ docker logs -f docker-ragflow-cpu-1
   

   The following output confirms a successful launch of the system:

   bash
   
         ____   ___    ______ ______ __
        / __ \ /   |  / ____// ____// /____  _      __
       / /_/ // /| | / / __ / /_   / // __ \| | /| / /
      / _, _// ___ |/ /_/ // __/  / // /_/ /| |/ |/ /
     /_/ |_|/_/  |_|\____//_/    /_/ \____/ |__/|__/
   
    * Running on all addresses (0.0.0.0)
   

   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.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.

The ./docker/README file provides a detailed description of the environment settings and service configurations which can be used as ${ENV_VARS} in the service_conf.yaml.template file.

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:

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

Switch doc engine from Elasticsearch to Infinity

RAGFlow uses Elasticsearch by default for storing full text and vectors. To switch to https://github.com/infiniflow/infinity/, follow these steps:

1. Stop all running containers:

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

[!WARNING] -v will delete the docker container volumes, and the existing data will be cleared.

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

3. Start the containers:

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

[!WARNING] Switching to Infinity on a Linux/arm64 machine is not yet officially supported.

🔧 Build a Docker image

This image is approximately 2 GB in size and relies on external LLM and embedding services.

bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly .

Or if you are behind a proxy, you can pass proxy arguments:

bash
docker build --platform linux/amd64 \
  --build-arg http_proxy=http://YOUR_PROXY:PORT \
  --build-arg https_proxy=http://YOUR_PROXY:PORT \
  -f Dockerfile -t infiniflow/ragflow:nightly .

🔨 Launch service from source for development

1. Install uv and pre-commit, or skip this step if they are already installed:

   bash
   pipx install uv pre-commit
   

2. Clone the source code and install Python dependencies:

   bash
   git clone https://github.com/infiniflow/ragflow.git
   cd ragflow/
   uv sync --python 3.13 # install RAGFlow dependent python modules
   uv run python3 download_deps.py
   pre-commit install
   

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/.env to 127.0.0.1:

   127.0.0.1       es01 infinity mysql minio redis sandbox-executor-manager
   

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. If your operating system does not have jemalloc, please install it as follows:

   bash
   # Ubuntu
   sudo apt-get install libjemalloc-dev
   # CentOS
   sudo yum install jemalloc
   # OpenSUSE
   sudo zypper install jemalloc
   # macOS
   sudo brew install jemalloc
   

6. Launch backend service:

   bash
   source .venv/bin/activate
   export PYTHONPATH=$(pwd)
   bash docker/launch_backend_service.sh
   

7. Install frontend dependencies:

   bash
   cd web
   npm install
   

8. Launch frontend service:

   bash
   npm run dev
   

   The following output confirms a successful launch of the system:

9. Stop RAGFlow front-end and back-end service after development is complete:

   bash
   pkill -f "ragflow_server.py|task_executor.py"
   

📚 Documentation

• Quickstart
• Configuration
• Release notes
• User guides
• Developer guides
• References
• FAQs

📜 Roadmap

See the https://github.com/infiniflow/ragflow/issues/***

🏄 Community

• ---

• X
• https://github.com/orgs/infiniflow/discussions

🙌 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 first.