mirror of https://github.com/bytedance/deer-flow.git synced 2026-05-20 15:11:09 +00:00

Files

T

sunsine 0691c4dda3 fix(security): allow disabling API docs in production via GATEWAY_ENABLE_DOCS (#2651 )

* fix(security): allow disabling API docs in production via GATEWAY_ENABLE_DOCS

Expose /docs, /redoc, and /openapi.json only when GATEWAY_ENABLE_DOCS=true
(default). Setting GATEWAY_ENABLE_DOCS=false disables all three endpoints,
preventing unauthorized API surface discovery in production deployments.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* test(security): add unit tests and docs for GATEWAY_ENABLE_DOCS

Add 7 tests covering default behavior, env var parsing (case-insensitive,
fail-closed), endpoint visibility, and health endpoint independence.
Update CONFIGURATION.md and CLAUDE.md with the new toggle.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* style(security): apply ruff formatting to gateway app.py

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>

2026-04-30 10:58:32 +08:00

API.md

docs(api): document recursion_limit for LangGraph API runs (#1929 )

2026-04-10 09:28:57 +08:00

APPLE_CONTAINER.md

Fix command syntax for container image pull (#1349 )

2026-03-26 00:14:08 +08:00

ARCHITECTURE.md

fix: rename present_file to present_files in docs and prompts (#2393 )

2026-04-21 16:10:14 +08:00

AUTH_TEST_DOCKER_GAP.md

feat(auth): release-validation pass for 2.0-rc — 12 blockers + simplify follow-ups (#2008 )

2026-04-26 11:08:11 +08:00

AUTH_TEST_PLAN.md

feat(auth): release-validation pass for 2.0-rc — 12 blockers + simplify follow-ups (#2008 )

2026-04-26 11:08:11 +08:00

AUTH_UPGRADE.md

feat(auth): release-validation pass for 2.0-rc — 12 blockers + simplify follow-ups (#2008 )

2026-04-26 11:08:11 +08:00

AUTO_TITLE_GENERATION.md

docs: fix some broken links (#1864 )

2026-04-05 15:35:42 +08:00

CONFIGURATION.md

fix(security): allow disabling API docs in production via GATEWAY_ENABLE_DOCS (#2651 )

2026-04-30 10:58:32 +08:00

FILE_UPLOAD.md

[security] fix(uploads): require explicit opt-in for host-side document conversion (#2332 )

2026-04-18 22:47:42 +08:00

GUARDRAILS.md

fix: rename present_file to present_files in docs and prompts (#2393 )

2026-04-21 16:10:14 +08:00

HARNESS_APP_SPLIT.md

fix: resolve make dev and test-e2e errors (#2570 )

2026-04-26 17:27:32 +08:00

MCP_SERVER.md

feat(mcp): support custom tool interceptors via extensions_config.json (#2451 )

2026-04-25 09:18:13 +08:00

MEMORY_IMPROVEMENTS_SUMMARY.md

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

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

MEMORY_IMPROVEMENTS.md

fix(memory): inject stored facts into system prompt memory context (#1083 )

2026-03-13 14:37:40 +08:00

MEMORY_SETTINGS_REVIEW.md

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

2026-03-29 23:53:23 +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

feat: add create_deerflow_agent SDK entry point (Phase 1) (#1203 )

2026-03-29 15:31:18 +08:00

PATH_EXAMPLES.md

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

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

plan_mode_usage.md

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

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

README.md

fix(backend): stream DeerFlowClient AI text as token deltas (#1969 ) (#1974 )

2026-04-10 18:16:38 +08:00

rfc-create-deerflow-agent.md

feat: add create_deerflow_agent SDK entry point (Phase 1) (#1203 )

2026-03-29 15:31:18 +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

SETUP.md

docs(SETUP): correct setup documentation links (#1478 )

2026-03-27 22:44:01 +08:00

STREAMING.md

fix(backend): stream DeerFlowClient AI text as token deltas (#1969 ) (#1974 )

2026-04-10 18:16:38 +08:00

summarization.md

fix(middleware): avoid rescuing non-skill tool outputs during summarization (#2458 )

2026-04-24 21:19:46 +08:00

task_tool_improvements.md

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

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

TITLE_GENERATION_IMPLEMENTATION.md

feat(persistence):Unified persistence layer with event store, feedback, and rebase cleanup (#2134 )

2026-04-26 11:09:55 +08:00

TODO.md

feat: switch memory updater to async LLM calls (#2138 )

2026-04-14 11:10:42 +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
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
FILE_UPLOAD.md	File upload functionality
PATH_EXAMPLES.md	Path types and usage examples
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
├── 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
├── AUTO_TITLE_GENERATION.md   # Title generation
├── TITLE_GENERATION_IMPLEMENTATION.md  # Title implementation details
└── TODO.md                    # Roadmap and issues