# ragflow - Doramagic AI Context Pack

> Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated.

## Project

- canonical_name: `infiniflow/ragflow`
- capability: 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
- expected_user_outcome: 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

## Operating Boundaries

- Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it.
- Project facts must come from repo evidence, Claim Graph, or explicit source references.
- When a capability is not verified, mark it as unverified instead of completing it as fact.
- publish_status: `publishable`
- blocking_gaps: none

---

## Doramagic Context Augmentation

The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints.

## Human Manual Outline

Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph.

Host AI hard rules:
- Do not treat page titles, section order, summaries, or importance values as factual project evidence.
- When explaining the Human Manual outline, state that it is only a reading route or salience signal.
- Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph.

- **Project Overview and System Architecture**: importance `high`
  - source_paths: README.md, api/ragflow_server.py, cmd/server_main.go, cmd/admin_server.go, cmd/ragflow_cli.go
- **Core RAG Engine: Parsing, Chunking, Retrieval, and Knowledge**: importance `high`
  - source_paths: deepdoc/parser/pdf_parser.py, deepdoc/parser/docx_parser.py, deepdoc/parser/mineru_parser.py, deepdoc/parser/docling_parser.py, deepdoc/parser/opendataloader_parser.py
- **Agent System, Tools, and Workflow Orchestration**: importance `high`
  - source_paths: agent/canvas.py, agent/component/base.py, agent/component/begin.py, agent/component/llm.py, agent/component/retrieval (via tools/retrieval.py)
- **Deployment, Configuration, Administration, and Model Integration**: importance `high`
  - source_paths: docker/docker-compose.yml, docker/docker-compose-base.yml, docker/docker-compose-CN-oc9.yml, docker/.env, docker/service_conf.yaml.template

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `b1a2210d06c751c10fff89a904012e1875b983b0`
- inspected_files: `uv.lock`, `Dockerfile`, `pyproject.toml`, `README.md`, `docs/_category_.json`, `docs/faq.mdx`, `docs/release_notes.md`, `docs/quickstart.mdx`, `docs/basics/rag.md`, `docs/basics/agent_context_engine.md`, `docs/basics/_category_.json`, `docs/develop/deepwiki.md`, `docs/develop/_category_.json`, `docs/develop/switch_doc_engine.md`, `docs/develop/build_docker_image.mdx`, `docs/develop/contributing.md`, `docs/develop/launch_ragflow_from_source.md`, `docs/develop/acquire_ragflow_api_key.md`, `docs/references/python_api_reference.md`, `docs/references/_category_.json`

Host AI hard rules:
- Without repo_clone_verified=true, do not claim that the source code has been read.
- Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts.
- Without quick_start_verified=true, do not claim that the Quick Start path has run successfully.

## Doramagic Pitfall Constraints

These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes.

### Constraint 1: Configuration risk requires verification

- Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | cevd_7154f1df73d9467aa3d747477287e392 | https://github.com/infiniflow/ragflow/issues/15714
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 2: Security or permission risk requires verification

- Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | cevd_8d8565f17f754fe3a6f7ad1f3b4be33d | https://github.com/infiniflow/ragflow/issues/15525
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 3: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | cevd_408303dfb4fb43a781b7dc14724082b9 | https://github.com/infiniflow/ragflow/issues/15751
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 4: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.23.1
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.23.1. Context: Observed when using docker
- Why it matters: Upgrade or migration may change expected behavior: v0.23.1
- Evidence: failure_mode_cluster:github_release | fmev_38f958bf7c9ad232f6049339e1321be7 | https://github.com/infiniflow/ragflow/releases/tag/v0.23.1
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 5: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.24.0
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.24.0. Context: Observed when using docker
- Why it matters: Upgrade or migration may change expected behavior: v0.24.0
- Evidence: failure_mode_cluster:github_release | fmev_0ca2840fc49d848176cce456864aafa3 | https://github.com/infiniflow/ragflow/releases/tag/v0.24.0
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 6: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.25.0
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.25.0. Context: Observed when using python, docker
- Why it matters: Upgrade or migration may change expected behavior: v0.25.0
- Evidence: failure_mode_cluster:github_release | fmev_7154c897fed0437e0ca58d1f443b8d97 | https://github.com/infiniflow/ragflow/releases/tag/v0.25.0
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 7: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.25.1
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.25.1. Context: Observed during version upgrade or migration.
- Why it matters: Upgrade or migration may change expected behavior: v0.25.1
- Evidence: failure_mode_cluster:github_release | fmev_12ff69cd8f090474bcc8768ed255e16a | https://github.com/infiniflow/ragflow/releases/tag/v0.25.1
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 8: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.25.2
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.25.2. Context: Observed when using python
- Why it matters: Upgrade or migration may change expected behavior: v0.25.2
- Evidence: failure_mode_cluster:github_release | fmev_7f58552889f29288945720d487e8fbb7 | https://github.com/infiniflow/ragflow/releases/tag/v0.25.2
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 9: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.25.3
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.25.3. Context: Observed when using docker
- Why it matters: Upgrade or migration may change expected behavior: v0.25.3
- Evidence: failure_mode_cluster:github_release | fmev_14af37b03860695c40160c241d23e5b1 | https://github.com/infiniflow/ragflow/releases/tag/v0.25.3
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 10: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.25.4
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.25.4. Context: Source discussion did not expose a precise runtime context.
- Why it matters: Upgrade or migration may change expected behavior: v0.25.4
- Evidence: failure_mode_cluster:github_release | fmev_026d052ebdc28ef87ab4152d11b96502 | https://github.com/infiniflow/ragflow/releases/tag/v0.25.4
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
