.env.sample

# OpenHands Agent Server target
# These defaults assume you are manually pointing the frontend at a backend on
# 127.0.0.1:8000. The recommended local workflow is `npm run dev`, which starts
# an isolated local backend for this checkout. Use `npm run dev:frontend` only
# when you intentionally want to point at a separately managed backend.
VITE_BACKEND_HOST="127.0.0.1:8000" # Host:port used by the Vite dev proxy
VITE_BACKEND_BASE_URL="http://127.0.0.1:8000" # Base URL used by browser-side direct requests
# To drive a containerized ACP agent-server, point this at the published port,
# e.g. VITE_BACKEND_BASE_URL="http://localhost:8010" — see examples/acp-docker/
# and docs/ACP_AGENTS.md → "Running ACP agents in a Docker container".
# VITE_SESSION_API_KEY="" # Set to the same value as backend SESSION_API_KEY or OH_SESSION_API_KEYS_0 when auth is enabled
# VITE_WORKING_DIR="/workspace/project/agent-canvas" # Base dir for per-conversation working_dirs. Each conversation's working_dir is <VITE_WORKING_DIR>/<id_hex>. Defaults to <OH_CANVAS_SAFE_STATE_DIR>/workspaces, which is the sibling of the agent server's <state_dir>/conversations/ persistence dir — both share the same <id_hex> per conversation.
# VITE_ENABLE_BROWSER_TOOLS="true" # Set to false to omit BrowserToolSet from new conversations

# Frontend dev server
VITE_FRONTEND_PORT="3001" # Port to run the frontend application
VITE_USE_TLS="false" # Use HTTPS/WSS for proxied backend connections
VITE_INSECURE_SKIP_VERIFY="false" # Skip TLS certificate verification for proxied backend requests
# VITE_BASE_PATH="/canvas" # Build/serve the SPA under a subpath. Leave unset for root-local development.

# Public PostHog client key compiled into source builds. Precompiled library
# consumers can instead pass apiKey/apiHost/uiHost to AgentServerUIProviders.
# VITE_POSTHOG_API_KEY="phc_..."
# VITE_DO_NOT_TRACK="1" # Disable all telemetry, including anonymous install counts

# Mocking / test helpers
VITE_MOCK_API="false" # Enable/disable API mocking with MSW

# `npm run dev` (scripts/dev-safe.mjs) — isolated local backend via uvx
# OH_CANVAS_SAFE_BACKEND_PORT="18000" # Port the spawned agent-server listens on
# OH_CANVAS_SAFE_VSCODE_PORT="18001" # Port forwarded to the embedded VS Code (defaults to backend port + 1)
# OH_CANVAS_SAFE_STATE_DIR="$HOME/.openhands/agent-canvas" # Where conversations and bash events are stored (tmux sockets live under /tmp)

# Agent server version selection (uvx) — listed in order of precedence (highest first)
# OH_AGENT_SERVER_LOCAL_PATH="" # Absolute path to a local software-agent-sdk checkout. Runs the local checkout via uvx with editable openhands-sdk/tools/workspace installs so source edits are picked up on restart. Highest precedence.
# OH_AGENT_SERVER_GIT_REF="" # Git commit SHA or branch name (e.g., "main", "abc1234"). Takes precedence over version.
# OH_AGENT_SERVER_VERSION="" # Specific PyPI version (e.g., "1.18.0"). Uses latest release if unset.