mirror of https://gitee.com/wanwujie/deer-flow synced 2026-04-03 06:12:14 +08:00

Files

hetao 5959ef87b8 feat: add Apple Container support with comprehensive documentation and dev tools

Add native Apple Container support for better performance on macOS while
maintaining full Docker compatibility. Enhance documentation with memory system
details, development guidelines, and sandbox setup instructions. Improve dev
experience with container image pre-pulling and unified cleanup tools.

Key changes:
- Auto-detect and prefer Apple Container on macOS with Docker fallback
- Add APPLE_CONTAINER.md with complete usage and troubleshooting guide
- Document memory system architecture in CLAUDE.md
- Add make setup-sandbox for pre-pulling container images
- Create cleanup-containers.sh for cross-runtime container cleanup
- Update all related documentation (README, SETUP, config examples)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

2026-02-03 20:41:36 +08:00

2.7 KiB

Raw Blame History

Setup Guide

Quick setup instructions for DeerFlow.

Configuration Setup

DeerFlow uses a YAML configuration file that should be placed in the project root directory.

Steps

Navigate to project root:
```
cd /path/to/deer-flow
```
Copy example configuration:
```
cp config.example.yaml config.yaml
```

Edit configuration:

# Option A: Set environment variables (recommended)
export OPENAI_API_KEY="your-key-here"

# Option B: Edit config.yaml directly
vim config.yaml  # or your preferred editor

Verify configuration:

cd backend
python -c "from src.config import get_app_config; print('✓ Config loaded:', get_app_config().models[0].name)"

Important Notes

Location: config.yaml should be in deer-flow/ (project root), not deer-flow/backend/
Git: config.yaml is automatically ignored by git (contains secrets)
Priority: If both backend/config.yaml and ../config.yaml exist, backend version takes precedence

Configuration File Locations

The backend searches for config.yaml in this order:

DEER_FLOW_CONFIG_PATH environment variable (if set)
backend/config.yaml (current directory when running from backend/)
deer-flow/config.yaml (parent directory - recommended location)

Recommended: Place config.yaml in project root (deer-flow/config.yaml).

Sandbox Setup (Optional but Recommended)

If you plan to use Docker/Container-based sandbox (configured in config.yaml under sandbox.use: src.community.aio_sandbox:AioSandboxProvider), it's highly recommended to pre-pull the container image:

# From project root
make setup-sandbox

Why pre-pull?

The sandbox image (~500MB+) is pulled on first use, causing a long wait
Pre-pulling provides clear progress indication
Avoids confusion when first using the agent

If you skip this step, the image will be automatically pulled on first agent execution, which may take several minutes depending on your network speed.

Troubleshooting

Config file not found

# Check where the backend is looking
cd deer-flow/backend
python -c "from src.config.app_config import AppConfig; print(AppConfig.resolve_config_path())"

If it can't find the config:

Ensure you've copied config.example.yaml to config.yaml
Verify you're in the correct directory
Check the file exists: ls -la ../config.yaml

Permission denied

chmod 600 ../config.yaml  # Protect sensitive configuration

2.7 KiB Raw Blame History