docs: Add two-container architecture and agent-server env var documentation#370
Draft
docs: Add two-container architecture and agent-server env var documentation#370
Conversation
…tation This commit adds comprehensive documentation explaining: 1. The V1 two-container architecture (app-server vs agent-server) 2. Auto-forwarded environment variables (LLM_* prefixes) 3. The OH_AGENT_SERVER_ENV mechanism for explicit overrides 4. Agent-server networking configuration (including AGENT_SERVER_USE_HOST_NETWORK) 5. Practical examples for common use cases This documentation addresses user confusion from issues: - OpenHands/OpenHands#12120 - OpenHands/OpenHands#12227 - OpenHands/OpenHands#12857 - OpenHands/OpenHands#12859 - OpenHands/OpenHands#12854 Co-authored-by: openhands <openhands@all-hands.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation explaining how environment variables work in OpenHands' two-container architecture, addressing confusion from multiple user-reported issues.
Related Issues (in OpenHands/OpenHands repo)
Related Code PR
Changes
Added a new section "Two-Container Architecture (V1)" to
environment-variables.mdxthat explains:LLM_*prefixed variables are now automatically forwardedOH_AGENT_SERVER_ENVfor custom variablesAGENT_SERVER_USE_HOST_NETWORKand related settingsPreview
The new section includes:
Documentation Source
This documentation is based on:
sandbox_spec_service.py,docker_sandbox_service.py)