Skip to content

fix: correct env var names in Docker execution docs - #870

Merged
DevinVinson merged 3 commits into
mainfrom
dv/fix-docker-execution-env-vars
Oct 4, 2026
Merged

DevinVinson merged 3 commits into
mainfrom
dv/fix-docker-execution-env-vars

Conversation

@DevinVinson

Copy link
Copy Markdown
Member
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

The Docker execution docs page (openhands/usage/agent-canvas/backend-setup/docker-execution.mdx) referenced environment variables that do not exist anywhere in the codebase. This PR replaces them with the correct OH_CONVERSATION_* variable names that match the actual implementation.

Changes:

  • OH_EXECUTION_RUNTIME → OH_CONVERSATION_RUNTIME
  • OH_EXECUTION_IMAGE → OH_CONVERSATION_IMAGE
  • Removed OH_EXECUTION_PLATFORM — platform is not configurable via env var
  • Removed OH_EXECUTION_VOLUMES — volumes are not configurable via env var
  • Removed the associated volume-mounting example and linux/arm64 platform note
  • Added the real container config vars to the Configuration Reference table:
    • OH_CONVERSATION_CONTAINER_MEMORY
    • OH_CONVERSATION_CONTAINER_CPUS
    • OH_CONVERSATION_CONTAINER_PIDS_LIMIT
    • OH_CONVERSATION_CONTAINER_STARTUP_TIMEOUT
  • Consolidated the ephemeral sandbox/persistence info to avoid duplication

Fixes #869

This PR was created by an AI agent (OpenHands) on behalf of @DevinVinson.

Replace non-existent OH_EXECUTION_* env vars with the correct
OH_CONVERSATION_* names that match the actual codebase:
- OH_EXECUTION_RUNTIME → OH_CONVERSATION_RUNTIME
- OH_EXECUTION_IMAGE → OH_CONVERSATION_IMAGE
- Remove OH_EXECUTION_PLATFORM (not configurable)
- Remove OH_EXECUTION_VOLUMES (not configurable via env var)
- Add real container config vars: MEMORY, CPUS, PIDS_LIMIT, STARTUP_TIMEOUT

Fixes #869

Co-authored-by: openhands <openhands@all-hands.dev>
@mintlify

mintlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Oct 4, 2026, 1:51 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Verified against software-agent-sdk docker_runtime/registry.py and config.py:
- Each container is a full agent-server (OH_CONVERSATION_RUNTIME=local, own
  secret key, session API key and persistence) proxied by the outer server;
  drop the DockerExecutionWorkspace / execution-only endpoint / fixed tool
  list description.
- Containers always bind-mount the conversation dir, a persistence dir and
  the host workspace, so files and history persist; remove the ephemeral and
  no-mounts claims.
- Fill in real defaults (4g, 2.0 CPUs, 512 PIDs, 120s startup) and document
  OH_CONVERSATION_IDLE_TTL_SECONDS (20 min).
- Fix the verification steps (agent-server-conversation- names, three mounts).
- Update title/description and the llms.txt entries.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-authored-by: openhands <openhands@all-hands.dev>
@DevinVinson
DevinVinson merged commit f39a24e into main Oct 4, 2026
5 checks passed
@DevinVinson
DevinVinson deleted the dv/fix-docker-execution-env-vars branch October 4, 2026 01:51

This branch was successfully deployed

1 active deployment
staging — da03efc9 Deployed Oct 4, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docker execution docs use incorrect env var names (OH_EXECUTION_* instead of OH_CONVERSATION_*)

2 participants