Skip to content

fix(docker): don't abort Docker startup when .env is missing #4956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WillemJiang merged 4 commits into from
Aug 24, 2026
Merged

fix(docker): don't abort Docker startup when .env is missing #4956

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
516a58b
fix(docker): create compose env files and keep Windows compose paths …
YZJF Aug 23, 2026
5b4cbc7
fix(docker): make dev compose env files optional and repair test fixture
YZJF Aug 24, 2026
0bedc01
fix(docker): declare Compose 2.24 floor and keep non-start commands r…
YZJF Aug 24, 2026
abf0c6b
fix(docker): reuse the probed Compose binary for wrapper operations
YZJF Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 46 additions & 19 deletions scripts/docker.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,46 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
DOCKER_DIR="$PROJECT_ROOT/docker"

# Docker Compose command with project name
COMPOSE_CMD="docker compose -p deer-flow-dev -f docker-compose-dev.yaml"
# Docker Compose command with project name.
# Use a filename relative to DOCKER_DIR (we always `cd` there) so Windows
# Docker Desktop does not receive a Git Bash `/c/...` path it cannot open.
# See https://github.com/bytedance/deer-flow/issues/2416
COMPOSE_FILE="docker-compose-dev.yaml"
COMPOSE_CMD="docker compose -p deer-flow-dev -f $COMPOSE_FILE"

ensure_from_example() {
local dest="$1"
local src="$2"
local label="$3"

if [ -f "$dest" ]; then
return 0
fi
if [ -f "$src" ]; then
cp "$src" "$dest"
echo -e "${BLUE}Created ${label} from $(basename "$src")${NC}"
return 0
fi
echo -e "${YELLOW}✗ ${label} not found and no $(basename "$src") to copy from.${NC}"
echo "Create ${dest} before starting Docker."
exit 1
}

# Compose env_file entries fail closed on Windows when .env is missing
# ("The specified file cannot be found" / "Le fichier spécifique est introuvable").
prepare_compose_env() {
if [ ! -f "$DOCKER_DIR/$COMPOSE_FILE" ]; then
echo -e "${YELLOW}✗ ${COMPOSE_FILE} not found at ${DOCKER_DIR}/${COMPOSE_FILE}${NC}"
echo "Run this from the DeerFlow repository root, e.g. 'make docker-start'."
echo "Do not run 'docker compose -f docker/${COMPOSE_FILE}' from inside docker/ — that resolves to docker/docker/${COMPOSE_FILE}."
exit 1
fi
if [ -z "$DEER_FLOW_ROOT" ]; then
export DEER_FLOW_ROOT="$PROJECT_ROOT"
fi
ensure_from_example "$PROJECT_ROOT/.env" "$PROJECT_ROOT/.env.example" ".env"
ensure_from_example "$PROJECT_ROOT/frontend/.env" "$PROJECT_ROOT/frontend/.env.example" "frontend/.env"
}

load_proxy_env_from_dotenv() {
local env_file="$PROJECT_ROOT/.env"
Expand Down Expand Up @@ -207,7 +245,7 @@ start() {
exit 1
fi
echo -e "${YELLOW}Mounting host Docker socket into gateway (DooD = host root-equivalent). See SECURITY.md.${NC}"
COMPOSE_CMD="$COMPOSE_CMD -f $DOCKER_DIR/docker-compose.dood.yaml"
COMPOSE_CMD="$COMPOSE_CMD -f docker-compose.dood.yaml"
fi

echo -e "${BLUE}Runtime: Gateway embedded agent runtime${NC}"
Expand Down Expand Up @@ -260,6 +298,7 @@ start() {
fi
fi

prepare_compose_env
load_proxy_env_from_dotenv

echo "Building and starting containers..."
Expand All @@ -283,12 +322,8 @@ start() {
logs() {
local service=""

# DEER_FLOW_ROOT is referenced in docker-compose-dev.yaml; set it before
# reading logs so Compose does not resolve mounted paths from an empty root.
if [ -z "$DEER_FLOW_ROOT" ]; then
export DEER_FLOW_ROOT="$PROJECT_ROOT"
fi

prepare_compose_env

@willem-bd willem-bd Aug 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Please keep logs, stop, and restart read-only with respect to configuration. prepare_compose_env calls ensure_from_example for both env files, so these commands now mutate a fresh checkout and can even refuse to stop running containers if an example file is unavailable. Since the Compose entries are optional after this change, split the shared preflight into compose-file validation plus DEER_FLOW_ROOT setup, and run env-file creation only from start.


case "$1" in
--frontend)
service="frontend"
Expand Down Expand Up @@ -325,11 +360,7 @@ logs() {

# Stop Docker development environment
stop() {
# DEER_FLOW_ROOT is referenced in docker-compose-dev.yaml; set it before
# running compose down to suppress "variable is not set" warnings.
if [ -z "$DEER_FLOW_ROOT" ]; then
export DEER_FLOW_ROOT="$PROJECT_ROOT"
fi
prepare_compose_env
echo "Stopping Docker development services..."
cd "$DOCKER_DIR" && $COMPOSE_CMD down
echo "Cleaning up sandbox containers..."
Expand All @@ -339,11 +370,7 @@ stop() {

# Restart Docker development environment
restart() {
# DEER_FLOW_ROOT is referenced in docker-compose-dev.yaml; set it before
# restarting services so Compose resolves mounted paths from this checkout.
if [ -z "$DEER_FLOW_ROOT" ]; then
export DEER_FLOW_ROOT="$PROJECT_ROOT"
fi
prepare_compose_env
echo "========================================"
echo " Restarting DeerFlow Docker Services"
echo "========================================"
Expand Down
Loading