docs: add custom Agent Server image guide for Docker backend#541
Merged
rbren merged 4 commits intoJun 2, 2026
Conversation
Replace the placeholder Docker backend page with a full walkthrough: build a custom Agent Server image (FROM ghcr.io/openhands/agent-server, add JDK + utilities), run it locally with a SESSION_API_KEY, and register it as a backend in Agent Canvas. Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
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
1 participant
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
Replaces the "Coming soon." placeholder at
openhands/usage/agent-canvas/backend-setup/docker.mdxwith a full walkthrough for building a custom Agent Server image and using it as an Agent Canvas backend.The guide covers:
FROM ghcr.io/openhands/agent-server:latest-python, adding the JDK, Maven, and common utilities on top.docker runwith a generatedSESSION_API_KEY, plus acurlhealth check and safety guidance for exposing the port.Manage Backends → Add Backend, paste the URL + API key, mark it asLocal, and switch to it as the active backend.Includes cross-links to the related guides:
Target
This PR targets the
docs/onboarding-agent-canvasbranch so it stacks onto #533.This PR was created by an AI agent (OpenHands) on behalf of @rbren.