2024-11-11 18:33:23 +07:00
<div align="center">
<a href="https://demo.ragflow.io/">
<img src="web/src/assets/logo-with-text.png" width="520" alt="Logo ragflow">
</a>
</div>
<p align="center">
2025-05-28 18:31:50 +08:00
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-DFE0E5"></a>
<a href="./README_zh.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-DFE0E5"></a>
2025-06-16 21:14:50 +08:00
<a href="./README_tzh.md"><img alt="繁體中文版自述文件" src="https://img.shields.io/badge/繁體中文-DFE0E5"></a>
2025-05-28 18:31:50 +08:00
<a href="./README_ja.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-DFE0E5"></a>
<a href="./README_ko.md"><img alt="한국어" src="https://img.shields.io/badge/한국어-DFE0E5"></a>
<a href="./README_id.md"><img alt="Bahasa Indonesia" src="https://img.shields.io/badge/Bahasa Indonesia-DBEDFA"></a>
<a href="./README_pt_br.md"><img alt="Português(Brasil)" src="https://img.shields.io/badge/Português(Brasil)-DFE0E5"></a>
2024-11-11 18:33:23 +07:00
</p>
<p align="center">
<a href="https://x.com/intent/follow?screen_name=infiniflowai" target="_blank">
<img src="https://img.shields.io/twitter/follow/infiniflow?logo=X&color=%20%23f5f5f5" alt="Ikuti di X (Twitter)">
</a>
<a href="https://demo.ragflow.io" target="_blank">
<img alt="Lencana Daring" src="https://img.shields.io/badge/Online-Demo-4e6b99">
</a>
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
2025-08-01 20:41:44 +08:00
<img src="https://img.shields.io/docker/pulls/infiniflow/ragflow?label=Docker%20Pulls&color=0db7ed&logo=docker&logoColor=white&style=flat-square" alt="docker pull infiniflow/ragflow:v0.20.0">
2024-11-11 18:33:23 +07:00
</a>
<a href="https://github.com/infiniflow/ragflow/releases/latest">
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Rilis%20Terbaru" alt="Rilis Terbaru">
</a>
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
<img height="21" src="https://img.shields.io/badge/Lisensi-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="Lisensi">
</a>
2025-05-28 09:29:33 +08:00
<a href="https://deepwiki.com/infiniflow/ragflow">
<img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg">
</a>
2024-11-11 18:33:23 +07:00
</p>
<h4 align="center">
<a href="https://ragflow.io/docs/dev/">Dokumentasi</a> |
2024-12-27 10:48:11 +08:00
<a href="https://github.com/infiniflow/ragflow/issues/4214">Peta Jalan</a> |
2024-11-11 18:33:23 +07:00
<a href="https://twitter.com/infiniflowai">Twitter</a> |
2025-04-07 12:18:43 +08:00
<a href="https://discord.gg/NjYzJD3GM3">Discord</a> |
2024-11-11 18:33:23 +07:00
<a href="https://demo.ragflow.io">Demo</a>
</h4>
2025-05-28 18:31:50 +08:00
#
2024-11-11 18:33:23 +07:00
<details open>
2025-02-28 16:09:40 +08:00
<summary><b>📕 Daftar Isi </b> </summary>
2024-11-11 18:33:23 +07:00
- 💡 [Apa Itu RAGFlow? ](#-apa-itu-ragflow )
- 🎮 [Demo ](#-demo )
- 📌 [Pembaruan Terbaru ](#-pembaruan-terbaru )
- 🌟 [Fitur Utama ](#-fitur-utama )
- 🔎 [Arsitektur Sistem ](#-arsitektur-sistem )
- 🎬 [Mulai ](#-mulai )
- 🔧 [Konfigurasi ](#-konfigurasi )
- 🔧 [Membangun Image Docker tanpa Model Embedding ](#-membangun-image-docker-tanpa-model-embedding )
- 🔧 [Membangun Image Docker dengan Model Embedding ](#-membangun-image-docker-dengan-model-embedding )
- 🔨 [Meluncurkan aplikasi dari Sumber untuk Pengembangan ](#-meluncurkan-aplikasi-dari-sumber-untuk-pengembangan )
- 📚 [Dokumentasi ](#-dokumentasi )
- 📜 [Peta Jalan ](#-peta-jalan )
- 🏄 [Komunitas ](#-komunitas )
- 🙌 [Kontribusi ](#-kontribusi )
</details>
## 💡 Apa Itu RAGFlow?
[RAGFlow ](https://ragflow.io/ ) adalah mesin RAG (Retrieval-Augmented Generation) open-source berbasis pemahaman dokumen yang mendalam. Platform ini menyediakan alur kerja RAG yang efisien untuk bisnis dengan berbagai skala, menggabungkan LLM (Large Language Models) untuk menyediakan kemampuan tanya-jawab yang benar dan didukung oleh referensi dari data terstruktur kompleks.
## 🎮 Demo
Coba demo kami di [https://demo.ragflow.io ](https://demo.ragflow.io ).
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://github.com/infiniflow/ragflow/assets/7248/2f6baa3e-1092-4f11-866d-36f6a9d075e5" width="1200"/>
<img src="https://github.com/user-attachments/assets/504bbbf1-c9f7-4d83-8cc5-e9cb63c26db6" width="1200"/>
</div>
## 🔥 Pembaruan Terbaru
2025-05-28 18:31:50 +08:00
- 2025-05-23 Menambahkan komponen pelaksana kode Python/JS ke Agen.
- 2025-05-05 Mendukung kueri lintas bahasa.
2025-04-14 14:45:37 +08:00
- 2025-03-19 Mendukung penggunaan model multi-modal untuk memahami gambar di dalam file PDF atau DOCX.
2025-03-05 17:54:34 +08:00
- 2025-02-28 dikombinasikan dengan pencarian Internet (TAVILY), mendukung penelitian mendalam untuk LLM apa pun.
2025-02-28 16:09:40 +08:00
- 2024-12-18 Meningkatkan model Analisis Tata Letak Dokumen di DeepDoc.
2024-12-18 16:00:24 +08:00
- 2024-08-22 Dukungan untuk teks ke pernyataan SQL melalui RAG.
2024-11-11 18:33:23 +07:00
## 🎉 Tetap Terkini
⭐️ Star repositori kami untuk tetap mendapat informasi tentang fitur baru dan peningkatan menarik! 🌟
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>
</div>
## 🌟 Fitur Utama
### 🍭 **"Kualitas Masuk, Kualitas Keluar"**
- Ekstraksi pengetahuan berbasis pemahaman dokumen mendalam dari data tidak terstruktur dengan format yang rumit.
- Menemukan "jarum di tumpukan data" dengan token yang hampir tidak terbatas.
### 🍱 **Pemotongan Berbasis Template**
- Cerdas dan dapat dijelaskan.
- Banyak pilihan template yang tersedia.
### 🌱 **Referensi yang Didasarkan pada Data untuk Mengurangi Hallusinasi**
- Visualisasi pemotongan teks memungkinkan intervensi manusia.
- Tampilan cepat referensi kunci dan referensi yang dapat dilacak untuk mendukung jawaban yang didasarkan pada fakta.
### 🍔 **Kompatibilitas dengan Sumber Data Heterogen**
- Mendukung Word, slide, excel, txt, gambar, salinan hasil scan, data terstruktur, halaman web, dan banyak lagi.
### 🛀 **Alur Kerja RAG yang Otomatis dan Mudah**
- Orkestrasi RAG yang ramping untuk bisnis kecil dan besar.
- LLM yang dapat dikonfigurasi serta model embedding.
- Peringkat ulang berpasangan dengan beberapa pengambilan ulang.
- API intuitif untuk integrasi yang mudah dengan bisnis.
## 🔎 Arsitektur Sistem
<div align="center" style="margin-top:20px;margin-bottom:20px;">
<img src="https://github.com/infiniflow/ragflow/assets/12318111/d6ac5664-c237-4200-a7c2-a4a00691b485" width="1000"/>
</div>
## 🎬 Mulai
### 📝 Prasyarat
- CPU >= 4 inti
- RAM >= 16 GB
- Disk >= 50 GB
- Docker >= 24.0.0 & Docker Compose >= v2.26.1
2025-05-16 16:28:21 +08:00
- [gVisor ](https://gvisor.dev/docs/user_guide/install/ ): Hanya diperlukan jika Anda ingin menggunakan fitur eksekutor kode (sandbox) dari RAGFlow.
> [!TIP]
> Jika Anda belum menginstal Docker di komputer lokal Anda (Windows, Mac, atau Linux), lihat [Install Docker Engine](https://docs.docker.com/engine/install/).
2024-11-11 18:33:23 +07:00
### 🚀 Menjalankan Server
1. Pastikan `vm.max_map_count` >= 262144:
> Untuk memeriksa nilai `vm.max_map_count`:
>
> ```bash
> $ sysctl vm.max_map_count
> ```
>
> Jika nilainya kurang dari 262144, setel ulang `vm.max_map_count` ke setidaknya 262144:
>
> ```bash
> # Dalam contoh ini, kita atur menjadi 262144:
> $ sudo sysctl -w vm.max_map_count=262144
> ```
>
> Perubahan ini akan hilang setelah sistem direboot. Untuk membuat perubahan ini permanen, tambahkan atau perbarui nilai
2025-01-21 00:22:29 -03:00
> `vm.max_map_count` di **/etc/sysctl.conf**:
2024-11-11 18:33:23 +07:00
>
> ```bash
> vm.max_map_count=262144
> ```
2. Clone repositori:
```bash
$ git clone https://github.com/infiniflow/ragflow.git
```
3. Bangun image Docker pre-built dan jalankan server:
2025-03-04 19:21:28 +08:00
> [!CAUTION]
> Semua gambar Docker dibangun untuk platform x86. Saat ini, kami tidak menawarkan gambar Docker untuk ARM64.
> Jika Anda menggunakan platform ARM64, [silakan gunakan panduan ini untuk membangun gambar Docker yang kompatibel dengan sistem Anda](https://ragflow.io/docs/dev/build_docker_image).
2025-08-01 20:41:44 +08:00
> Perintah di bawah ini mengunduh edisi v0.20.0-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.20.0-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.20.0 untuk edisi lengkap v0.20.0.
2024-11-11 18:33:23 +07:00
2025-04-13 23:07:39 -03:00
```bash
$ cd ragflow/docker
# Use CPU for embedding and DeepDoc tasks:
$ docker compose -f docker-compose.yml up -d
2025-03-17 09:51:13 +08:00
2025-04-13 23:07:39 -03:00
# To use GPU to accelerate embedding and DeepDoc tasks:
# docker compose -f docker-compose-gpu.yml up -d
```
2024-11-11 18:33:23 +07:00
2025-04-13 23:07:39 -03:00
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
2025-08-01 20:41:44 +08:00
| v0.20.0 | ≈9 | :heavy_check_mark: | Stable release |
| v0.20.0-slim | ≈2 | ❌ | Stable release |
2025-04-13 23:07:39 -03:00
| nightly | ≈9 | :heavy_check_mark: | _ Unstable _ nightly build |
| nightly-slim | ≈2 | ❌ | _ Unstable _ nightly build |
2024-11-11 18:33:23 +07:00
2025-03-04 19:21:28 +08:00
1. Periksa status server setelah server aktif dan berjalan:
2024-11-11 18:33:23 +07:00
```bash
$ docker logs -f ragflow-server
```
_ Output berikut menandakan bahwa sistem berhasil diluncurkan: _
```bash
2025-01-21 00:22:29 -03:00
__ __ ___ ____ __ ____ __ _ _
2024-11-11 18:33:23 +07:00
/ _ _ \ / | / __ __ // __ __ // /____ _ _ _
/ /_/ // /| | / / _ _ / /_ / // _ _ \| | /| / /
2025-01-21 00:22:29 -03:00
/ _ , _ // ___ |/ /_/ // __ / / // /_/ /| |/ |/ /
/_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
2024-11-11 18:33:23 +07:00
* Running on all addresses (0.0.0.0)
```
2025-01-21 00:22:29 -03:00
2024-11-14 00:08:55 +08:00
> Jika Anda melewatkan langkah ini dan langsung login ke RAGFlow, browser Anda mungkin menampilkan error `network anormal`
2025-01-21 00:22:29 -03:00
> karena RAGFlow mungkin belum sepenuhnya siap.
2024-11-11 18:33:23 +07:00
2025-03-04 19:21:28 +08:00
2. Buka browser web Anda, masukkan alamat IP server Anda, dan login ke RAGFlow.
2025-01-21 00:22:29 -03:00
> Dengan pengaturan default, Anda hanya perlu memasukkan `http://IP_DEVICE_ANDA` (**tanpa** nomor port) karena
> port HTTP default `80` bisa dihilangkan saat menggunakan konfigurasi default.
2025-03-04 19:21:28 +08:00
3. Dalam [service_conf.yaml.template ](./docker/service_conf.yaml.template ), pilih LLM factory yang diinginkan di `user_default_llm` dan perbarui
2024-11-11 18:33:23 +07:00
bidang `API_KEY` dengan kunci API yang sesuai.
> Lihat [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) untuk informasi lebih lanjut.
_ Sistem telah siap digunakan! _
## 🔧 Konfigurasi
Untuk konfigurasi sistem, Anda perlu mengelola file-file berikut:
- [.env ](./docker/.env ): Menyimpan pengaturan dasar sistem, seperti `SVR_HTTP_PORT` , `MYSQL_PASSWORD` , dan
`MINIO_PASSWORD` .
2024-12-10 10:19:50 +08:00
- [service_conf.yaml.template ](./docker/service_conf.yaml.template ): Mengonfigurasi aplikasi backend.
2024-11-11 18:33:23 +07:00
- [docker-compose.yml ](./docker/docker-compose.yml ): Sistem ini bergantung pada [docker-compose.yml ](./docker/docker-compose.yml ) untuk memulai.
Untuk memperbarui port HTTP default (80), buka [docker-compose.yml ](./docker/docker-compose.yml ) dan ubah `80:80`
menjadi `<YOUR_SERVING_PORT>:80` .
Pembaruan konfigurasi ini memerlukan reboot semua kontainer agar efektif:
> ```bash
2025-02-19 13:19:36 +08:00
> $ docker compose -f docker-compose.yml up -d
2024-11-11 18:33:23 +07:00
> ```
## 🔧 Membangun Docker Image tanpa Model Embedding
2024-12-09 12:44:57 +08:00
Image ini berukuran sekitar 2 GB dan bergantung pada aplikasi LLM eksternal dan embedding.
2024-11-11 18:33:23 +07:00
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
2025-04-13 23:07:39 -03:00
docker build --platform linux/amd64 --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
2024-11-11 18:33:23 +07:00
```
## 🔧 Membangun Docker Image Termasuk Model Embedding
Image ini berukuran sekitar 9 GB. Karena sudah termasuk model embedding, ia hanya bergantung pada aplikasi LLM eksternal.
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
2025-04-13 23:07:39 -03:00
docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly .
2024-11-11 18:33:23 +07:00
```
## 🔨 Menjalankan Aplikasi dari untuk Pengembangan
2025-01-14 11:49:43 +08:00
1. Instal uv, atau lewati langkah ini jika sudah terinstal:
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
```bash
2025-04-24 00:25:33 -03:00
pipx install uv pre-commit
2024-11-11 18:33:23 +07:00
```
2. Clone kode sumber dan instal dependensi Python:
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
2025-01-14 11:49:43 +08:00
uv sync --python 3.10 --all-extras # install RAGFlow dependent python modules
2025-05-06 14:39:05 +08:00
uv run download_deps.py
2025-04-24 00:25:33 -03:00
pre-commit install
2024-11-11 18:33:23 +07:00
```
3. Jalankan aplikasi yang diperlukan (MinIO, Elasticsearch, Redis, dan MySQL) menggunakan Docker Compose:
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
```bash
docker compose -f docker/docker-compose-base.yml up -d
```
2024-12-10 10:19:50 +08:00
Tambahkan baris berikut ke `/etc/hosts` untuk memetakan semua host yang ditentukan di **conf/service_conf.yaml ** ke `127.0.0.1` :
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
```
2025-05-16 11:14:57 +08:00
127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager
2025-01-21 00:22:29 -03:00
```
2024-11-11 18:33:23 +07:00
4. Jika Anda tidak dapat mengakses HuggingFace, atur variabel lingkungan `HF_ENDPOINT` untuk menggunakan situs mirror:
```bash
export HF_ENDPOINT=https://hf-mirror.com
```
2025-05-14 15:44:24 +08:00
5. Jika sistem operasi Anda tidak memiliki jemalloc, instal sebagai berikut:
```bash
# ubuntu
sudo apt-get install libjemalloc-dev
# centos
sudo yum install jemalloc
```
6. Jalankan aplikasi backend:
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
```bash
source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh
```
2025-05-14 15:44:24 +08:00
7. Instal dependensi frontend:
2024-11-11 18:33:23 +07:00
```bash
cd web
2024-12-30 18:19:58 +08:00
npm install
2024-11-28 17:37:46 +08:00
```
2025-05-14 15:44:24 +08:00
8. Jalankan aplikasi frontend:
2025-01-21 00:22:29 -03:00
2024-11-11 18:33:23 +07:00
```bash
2025-01-21 00:22:29 -03:00
npm run dev
```
2024-11-11 18:33:23 +07:00
_ Output berikut menandakan bahwa sistem berhasil diluncurkan: _

2025-05-14 15:44:24 +08:00
9. Hentikan layanan front-end dan back-end RAGFlow setelah pengembangan selesai:
```bash
pkill -f "ragflow_server.py|task_executor.py"
```
2024-11-11 18:33:23 +07:00
## 📚 Dokumentasi
- [Quickstart ](https://ragflow.io/docs/dev/ )
2025-03-18 19:49:06 +08:00
- [Configuration ](https://ragflow.io/docs/dev/configurations )
- [Release notes ](https://ragflow.io/docs/dev/release_notes )
- [User guides ](https://ragflow.io/docs/dev/category/guides )
- [Developer guides ](https://ragflow.io/docs/dev/category/developers )
- [References ](https://ragflow.io/docs/dev/category/references )
- [FAQs ](https://ragflow.io/docs/dev/faq )
2024-11-11 18:33:23 +07:00
## 📜 Roadmap
2024-12-27 10:48:11 +08:00
Lihat [Roadmap RAGFlow 2025 ](https://github.com/infiniflow/ragflow/issues/4214 )
2024-11-11 18:33:23 +07:00
## 🏄 Komunitas
2025-04-07 12:18:43 +08:00
- [Discord ](https://discord.gg/NjYzJD3GM3 )
2024-11-11 18:33:23 +07:00
- [Twitter ](https://twitter.com/infiniflowai )
- [GitHub Discussions ](https://github.com/orgs/infiniflow/discussions )
## 🙌 Kontribusi
RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas.
2025-05-16 16:28:21 +08:00
Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi ](https://ragflow.io/docs/dev/contributing ).