mirror of https://github.com/bytedance/deer-flow.git synced 2026-10-26 21:26:39 +00:00

History

fix(config): upgrade the config.yaml the Gateway loads (#5991 )

* fix(config): upgrade the config.yaml the Gateway loads

scripts/config-upgrade.sh resolved DEER_FLOW_CONFIG_PATH, then
backend/config.yaml, then <checkout>/config.yaml. make dev exports
DEER_FLOW_PROJECT_ROOT=<checkout>, so the Gateway reads the checkout copy
first: with both files present the script upgraded a file nothing loads
and left the live config outdated while reporting success. It also
ignored DEER_FLOW_PROJECT_ROOT and a DEER_FLOW_CONFIG_PATH set in .env,
and fell back to another file when DEER_FLOW_CONFIG_PATH named a
missing one.

Ask the harness resolver (AppConfig.resolve_config_path) instead of
copying its order, defaulting DEER_FLOW_PROJECT_ROOT to the checkout as
serve.sh does. A missing DEER_FLOW_CONFIG_PATH or invalid project root
now fails with the Gateway's error; no config anywhere still creates
<checkout>/config.yaml from the example.

* docs(changelog): reference #5991

* test(config): pin config-upgrade seeding a missing config from the example

---------

Co-authored-by: Willem Jiang <willem.jiang@gmail.com>

2026-09-29 22:10:29 +08:00

API.md

feat(models): add declarative reasoning capability contract (#5780 )

2026-09-24 20:39:30 +08:00

APPLE_CONTAINER.md

docs(sandbox): fix Apple Container verification instructions (#5605 )

2026-09-20 17:56:30 +08:00

ARCHITECTURE.md

feat(projects): Projects MVP Phase 2 — instructions, document shelf, promotion, trash (#5443 )

2026-09-16 18:46:18 +08:00

AUTH_DESIGN.md

fix(auth): claim the first admin atomically instead of counting first (#5776 )

2026-09-24 16:30:36 +08:00

AUTH_TEST_DOCKER_GAP.md

docs: clean gateway runtime transition remnants (#3334 )

2026-06-02 10:03:28 +08:00

AUTH_TEST_PLAN.md

docs: clean standalone LangGraph server remnants (#3301 )

2026-05-29 11:36:45 +08:00

AUTH_UPGRADE.md

docs: clean gateway runtime transition remnants (#3334 )

2026-06-02 10:03:28 +08:00

AUTO_TITLE_GENERATION.md

fix(title): avoid default LLM call before stream end (#3885 )

2026-06-30 18:58:02 +08:00

blob-storage.md

feat(storage): add a content-addressed blob store contract (issue #4189 item 2) (#5361 )

2026-09-24 09:35:03 +08:00

BLOCKING_IO_DETECTION.md

feat(skill): add blocking-io-guard — SOP skill for blocking-IO triage and runtime anchors (#3503 )

2026-06-12 10:20:38 +08:00

checkpoint-retention-contract.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

CONFIGURATION.md

fix(config): upgrade the config.yaml the Gateway loads (#5991 )

2026-09-29 22:10:29 +08:00

extension-model-invocation.md

feat(extensions): grant bounded host model invocation (#5796 )

2026-09-25 15:24:09 +08:00

FILE_UPLOAD.md

feat(tools): add stable pagination to historical upload discovery (#5570 )

2026-09-24 20:30:45 +08:00

GITHUB_AGENTS.md

fix(agents): make SQL store signatures content-sensitive (#4709 )

2026-08-08 20:36:13 +08:00

GUARDRAILS.md

feat(memory): add Jev pre-screening and signal classification over a shared TypeSafe client (#5906 )

2026-09-27 20:28:05 +08:00

IM_CHANNEL_CONNECTIONS.md

feat(channels): select custom agents per conversation (#5168 )

2026-09-06 16:46:51 +08:00

LOOP_DETECTION.md

fix(agents): isolate loop detection state by run (#5344 )

2026-09-11 13:45:52 +08:00

MCP_SERVER.md

fix(mcp): restore task owners for background credential selection (#5870 )

2026-09-26 15:37:52 +08:00

MEMORY_COGNITIVE_STYLE.md

feat(memory): add cognitiveStyle for collaboration preferences (#3182 )

2026-09-23 18:29:12 +08:00

MEMORY_IMPROVEMENTS_SUMMARY.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

MEMORY_IMPROVEMENTS.md

feat(memory): add Jev pre-screening and signal classification over a shared TypeSafe client (#5906 )

2026-09-27 20:28:05 +08:00

MEMORY_SETTINGS_REVIEW.md

feat(memory): bulk-load sample for registered users (#4066 )

2026-09-24 09:08:32 +08:00

memory-settings-sample.json

feat: support manual add and edit for memory facts (#1538 )

2026-03-29 23:53:23 +08:00

middleware-execution-flow.md

perf(middleware): stop checkpointing view_image base64 payloads (#5014 )

2026-08-27 09:12:37 +08:00

PATH_EXAMPLES.md

docs(backend): drop references to APIs that do not exist (#5798 )

2026-09-25 14:15:59 +08:00

plan_mode_usage.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

README.md

fix(run): add run event stream contract (#4342 )

2026-07-23 21:33:57 +08:00

REPLAY_E2E.md

fix(replay-e2e): key fixtures by caller and conversation (#3453 )

2026-06-09 21:58:31 +08:00

rfc-create-deerflow-agent.md

feat(subagents): add unified capacity and durable batch execution (#4998 )

2026-08-25 07:49:38 +08:00

rfc-extract-shared-modules.md

refactor: extract shared skill installer and upload manager to harness (#1202 )

2026-03-25 16:28:33 +08:00

rfc-grep-glob-tools.md

feat(sandbox): add built-in grep and glob tools (#1784 )

2026-04-03 16:03:06 +08:00

RUN_EVENT_STREAM.md

feat(runtime): persist tool-progress phase transitions (#5214 )

2026-09-15 08:45:08 +08:00

RUN_INTERACTION_POLICY.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

runtime-guidance-details.md

fix(goal): preserve active goals when artifact delivery fails (#5980 )

2026-09-28 14:44:45 +08:00

SANDBOX_MEMORY_PROFILING.md

chore: add sandbox memory profiling tools (#3249 )

2026-06-03 22:02:27 +08:00

SETUP.md

fix(harness): resolve runtime paths from project root (#2642 )

2026-05-01 22:19:50 +08:00

SSO.md

feat(auth): add OIDC SSO support (#3506 )

2026-06-21 15:47:53 +08:00

STREAMING.md

fix(client): exclude prior turns from resumed stream events (#5811 )

2026-09-24 21:03:07 +08:00

summarization.md

fix(goal): show the active goal to the agent on every model call (#5917 )

2026-09-27 13:38:32 +08:00

task_tool_improvements.md

refactor: split backend into harness (deerflow.*) and app (app.*) (#1131 )

2026-03-14 22:55:52 +08:00

THREAD_LIFECYCLE.md

feat(chats): add archive and restore (#5236 )

2026-09-06 22:30:26 +08:00

TITLE_GENERATION_IMPLEMENTATION.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

TODO.md

docs: clean standalone LangGraph server remnants (#3301 )

2026-05-29 11:36:45 +08:00

TUI.md

fix(tui): report headless --print/--json failures instead of leaking tracebacks (#5963 )

2026-09-28 16:16:40 +08:00

README.md

Documentation

This directory contains detailed documentation for the DeerFlow backend.

Quick Links

Document	Description
ARCHITECTURE.md	System architecture overview
API.md	Complete API reference
AUTH_DESIGN.md	User authentication, CSRF, platform-trust (IM / Internal Auth), and per-user isolation
SSO.md	OIDC / SSO single sign-on
IM_CHANNEL_CONNECTIONS.md	IM channel user binding (`channel_connections`)
CONFIGURATION.md	Configuration options
SETUP.md	Quick setup guide

Feature Documentation

Document	Description
STREAMING.md	Token-level streaming design: Gateway vs DeerFlowClient paths, `stream_mode` semantics, per-id dedup
RUN_EVENT_STREAM.md	Persisted run event stream contract: envelope, producers, consumers, and known gaps
FILE_UPLOAD.md	File upload functionality
PATH_EXAMPLES.md	Path types and usage examples
SANDBOX_MEMORY_PROFILING.md	Sandbox memory baseline and runtime comparison guide
summarization.md	Context summarization feature
plan_mode_usage.md	Plan mode with TodoList
AUTO_TITLE_GENERATION.md	Automatic title generation

Development

Document	Description
TODO.md	Planned features and known issues

Getting Started

New to DeerFlow? Start with SETUP.md for quick installation
Configuring the system? See CONFIGURATION.md
Understanding the architecture? Read ARCHITECTURE.md
Building integrations? Check API.md for API reference

Document Organization

docs/
├── README.md                  # This file
├── ARCHITECTURE.md            # System architecture
├── API.md                     # API reference
├── AUTH_DESIGN.md             # User authentication and isolation design
├── CONFIGURATION.md           # Configuration guide
├── SETUP.md                   # Setup instructions
├── FILE_UPLOAD.md             # File upload feature
├── PATH_EXAMPLES.md           # Path usage examples
├── summarization.md           # Summarization feature
├── plan_mode_usage.md         # Plan mode feature
├── STREAMING.md               # Token-level streaming design
├── RUN_EVENT_STREAM.md        # Persisted run event stream contract
├── AUTO_TITLE_GENERATION.md   # Title generation
├── TITLE_GENERATION_IMPLEMENTATION.md  # Title implementation details
└── TODO.md                    # Roadmap and issues