ragflow

(โ˜… 88,974)

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fuses cutting-edge RAG with Agent capabilities to create a superior context layer for LLMs

File Explorer

Download Latest Version (.zip)

Showing a partial file list โ€” download the zip above to see everything.

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .rooignore
  • .trivyignore
  • AGENTS.md
  • build.sh
  • CLAUDE.md
  • codecov.yml
  • Dockerfile
  • Dockerfile.scratch.oc9
  • Dockerfile_base
  • Dockerfile_ci
  • Dockerfile_deepdoc_oss
  • Dockerfile_tei
  • go.mod
  • go.sum
  • LICENSE
  • README.md
  • README_ar.md
  • README_fr.md
  • README_id.md
  • README_ja.md
  • README_ko.md
  • README_pt_br.md
  • README_ru.md
  • README_tr.md
  • README_tzh.md
  • README_zh.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/infiniflow/ragflow

Downloads the entire project code from GitHub to your computer.

cd ragflow

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • pipx Installs Python-based CLI tools into isolated environments.
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
  • Homebrew A package manager for macOS/Linux.
pipx install uv

Installs the CLI tool into an isolated environment via pipx.

sudo apt-get install libjemalloc-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

brew install jemalloc

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
cd ragflow/docker

Moves into the project folder you just downloaded.

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

Runs the command against the services defined in the compose file.

docker logs -f docker-ragflow-cpu-1

Type this command into your terminal and run it.

> docker compose -f docker-compose.yml up -d

Runs the command against the services defined in the compose file.

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

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ ์ปดํŒŒ์ผ๋Ÿฌ Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd internal/binding/cpp

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

6. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

7. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

8. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd internal/binding/cpp

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

HelloGitHub โ˜… 171,210

:octocat: ๅˆ†ไบซ GitHub ไธŠๆœ‰่ถฃใ€ๅ…ฅ้—จ็บง็š„ๅผ€ๆบ้กน็›ฎใ€‚Share interesting, entry-level open source projects on Gi

Python
agency-agents โ˜… 147,102

A complete AI agency at your fingertips - From frontend wizards to Reddit community ninjas

Shell
rustdesk โ˜… 121,416

An open-source remote desktop application designed for self-hosting, as an alternative to

Rust
vllm โ˜… 89,633

A high-throughput and memory-efficient inference and serving engine for LLMs

Python
langchain โ˜… 144,721

The agent engineering platform.

Python
ui โ˜… 121,773

A set of beautifully-designed, accessible components and a code distribution platform. Wor

TypeScript
// repository documentation