RAGFlow は、深い文書理解に基づいたオープンソースの RAG (Retrieval-Augmented Generation) エンジンである。LLM(大規模言語モデル)を組み合わせることで、様々な複雑なフォーマットのデータから根拠のある引用に裏打ちされた、信頼できる質問応答機能を実現し、あらゆる規模のビジネスに適した RAG ワークフローを提供します。
デモをお試しください:https://demo.ragflow.io。
⭐️ リポジトリをスター登録して、エキサイティングな新機能やアップデートを最新の状態に保ちましょう!すべての新しいリリースに関する即時通知を受け取れます! 🌟
[!TIP] ローカルマシン(Windows、Mac、または Linux)に Docker をインストールしていない場合は、Docker Engine のインストール を参照してください。
vm.max_map_count >= 262144 であることを確認する:
vm.max_map_countの値をチェックするには:$ sysctl vm.max_map_count
vm.max_map_countが 262144 より大きい値でなければリセットする。# In this case, we set it to 262144: $ sudo sysctl -w vm.max_map_count=262144この変更はシステム再起動後にリセットされる。変更を恒久的なものにするには、/etc/sysctl.conf の
vm.max_map_count値を適宜追加または更新する:vm.max_map_count=262144
リポジトリをクローンする:
$ git clone https://github.com/infiniflow/ragflow.git
ビルド済みの Docker イメージをビルドし、サーバーを起動する:
[!CAUTION] 現在、公式に提供されているすべての Docker イメージは x86 アーキテクチャ向けにビルドされており、ARM64 用の Docker イメージは提供されていません。 ARM64 アーキテクチャのオペレーティングシステムを使用している場合は、このドキュメントを参照して Docker イメージを自分でビルドしてください。
以下のコマンドは、RAGFlow Docker イメージの v0.20.0-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.20.0-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.20.0 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.20.0 と設定します。
$ cd ragflow/docker
# Use CPU for embedding and DeepDoc tasks:
$ docker compose -f docker-compose.yml up -d
# To use GPU to accelerate embedding and DeepDoc tasks:
# docker compose -f docker-compose-gpu.yml up -d
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
|---|---|---|---|
| v0.20.0 | ≈9 | ✔️ | Stable release |
| v0.20.0-slim | ≈2 | ❌ | Stable release |
| nightly | ≈9 | ✔️ | Unstable nightly build |
| nightly-slim | ≈2 | ❌ | Unstable nightly build |
サーバーを立ち上げた後、サーバーの状態を確認する:
$ docker logs -f ragflow-server
以下の出力は、システムが正常に起動したことを確認するものです:
____ ___ ______ ______ __ / __ \ / | / ____// ____// /____ _ __ / /_/ // /| | / / __ / /_ / // __ \| | /| / / / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0)
もし確認ステップをスキップして直接 RAGFlow にログインした場合、その時点で RAGFlow が完全に初期化されていない可能性があるため、ブラウザーがネットワーク異常エラーを表示するかもしれません。
ウェブブラウザで、プロンプトに従ってサーバーの IP アドレスを入力し、RAGFlow にログインします。
デフォルトの設定を使用する場合、デフォルトの HTTP サービングポート
80は省略できるので、与えられたシナリオでは、http://IP_OF_YOUR_MACHINE(ポート番号は省略)だけを入力すればよい。
service_conf.yaml.template で、user_default_llm で希望の LLM ファクトリを選択し、API_KEY フィールドを対応する API キーで更新する。
詳しくは llm_api_key_setup を参照してください。
これで初期設定完了!ショーの開幕です!
システムコンフィグに関しては、以下のファイルを管理する必要がある:
SVR_HTTP_PORT、MYSQL_PASSWORD、MINIO_PASSWORD などのシステムの基本設定を保持する。.env ファイルの変更が service_conf.yaml.template ファイルの内容と一致していることを確認する必要があります。
./docker/README ファイル ./docker/README には、service_conf.yaml.template ファイルで ${ENV_VARS} として使用できる環境設定とサービス構成の詳細な説明が含まれています。
デフォルトの HTTP サービングポート(80)を更新するには、docker-compose.yml にアクセスして、80:80 を <YOUR_SERVING_PORT>:80 に変更します。
すべてのシステム設定のアップデートを有効にするには、システムの再起動が必要です:
$ docker compose -f docker-compose.yml up -d
RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトルを保存します。[Infinity]に切り替え(https://github.com/infiniflow/infinity/)、次の手順に従います。
実行中のすべてのコンテナを停止するには:
$ docker compose -f docker/docker-compose.yml down -v
Note: -v は docker コンテナのボリュームを削除し、既存のデータをクリアします。
docker/.env の「DOC _ ENGINE」を「infinity」に設定します。
起動コンテナ:
$ docker compose -f docker-compose.yml up -d
[!WARNING] Linux/arm64 マシンでの Infinity への切り替えは正式にサポートされていません。
この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
docker build --platform linux/amd64 --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
この Docker のサイズは約 9GB で、埋め込みモデルを含むため、外部の大モデルサービスのみが必要です。
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly .
uv をインストールする。すでにインストールされている場合は、このステップをスキップしてください:
pipx install uv pre-commit
ソースコードをクローンし、Python の依存関係をインストールする:
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
uv sync --python 3.10 --all-extras # install RAGFlow dependent python modules
uv run download_deps.py
pre-commit install
Docker Compose を使用して依存サービス(MinIO、Elasticsearch、Redis、MySQL)を起動する:
docker compose -f docker/docker-compose-base.yml up -d
/etc/hosts に以下の行を追加して、conf/service_conf.yaml に指定されたすべてのホストを 127.0.0.1 に解決します:
127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager
HuggingFace にアクセスできない場合は、HF_ENDPOINT 環境変数を設定してミラーサイトを使用してください:
export HF_ENDPOINT=https://hf-mirror.com
オペレーティングシステムにjemallocがない場合は、次のようにインストールします:
# ubuntu
sudo apt-get install libjemalloc-dev
# centos
sudo yum install jemalloc
バックエンドサービスを起動する:
source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh
フロントエンドの依存関係をインストールする:
cd web
npm install
フロントエンドサービスを起動する:
npm run dev
以下の画面で、システムが正常に起動したことを示します:
開発が完了したら、RAGFlow のフロントエンド サービスとバックエンド サービスを停止します:
pkill -f "ragflow_server.py|task_executor.py"
RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず コントリビューションガイドをご覧ください。