Skip to content

docs: use ghcr.io/openhands/agent-canvas:latest as Docker base image#542

Open
rbren wants to merge 13 commits into
mainfrom
fix/docker-base-image-agent-canvas
Open

docs: use ghcr.io/openhands/agent-canvas:latest as Docker base image#542
rbren wants to merge 13 commits into
mainfrom
fix/docker-base-image-agent-canvas

Conversation

@rbren

@rbren rbren commented Jun 2, 2026

Copy link
Copy Markdown
Member

Summary

Updates the Docker backend setup guide to use ghcr.io/openhands/agent-canvas:latest as the base image instead of ghcr.io/openhands/agent-server:1-python.

The agent-canvas image is the all-in-one image that bundles the agent server, automation backend, and frontend — making it the correct base for custom Agent Canvas Docker backends.

Changes

  • Base image: FROM ghcr.io/openhands/agent-server:1-pythonFROM ghcr.io/openhands/agent-canvas:latest
  • Description text: Updated to reference "Agent Canvas image" instead of "Agent Server image"
  • Pinning tip: Updated to suggest 1.0.0-beta.5 as an example version tag instead of 1.24.0-python
  • Multi-arch tip: Simplified since agent-canvas already supports both amd64 and arm64
  • Update command: docker pull now references ghcr.io/openhands/agent-canvas:latest

Tag verification

Confirmed that the following tags exist on ghcr.io/openhands/agent-canvas:

  • latest ✅ (multi-arch manifest)
  • main ✅ (multi-arch manifest)
  • 1.0.0-beta.5 ✅ (multi-arch manifest)

This PR was created by an AI agent (OpenHands) on behalf of the user.

openhands-agent and others added 13 commits May 28, 2026 12:58
- Rename 'Onboarding OpenHands' group to 'Onboarding Agent Canvas'
- Add agent-canvas docs (overview, setup, backends, llm-profiles,
  customize-and-settings, automations, self-hosting, development,
  troubleshooting) under Onboarding Agent Canvas
- Move Hooks to Product Guides section
- Update Quick Start to single 'Install OpenHands Agent Canvas' card
  with OpenHands Cloud as a bullet item

Co-authored-by: openhands <openhands@all-hands.dev>
- Remove bullet points from Agent Canvas card in Quick Start
- Add OpenHands Cloud as a single bullet below the card
- Move Repository Customization to Product Guides, after Automations

Co-authored-by: openhands <openhands@all-hands.dev>
- Rename 'Setup' page title to 'Install'
- Add 'Setup a Pre-built Automation' group with placeholder sub-pages:
  GitHub PR Review Assistant, GitHub Repository Monitor, Slack Channel Monitor
- Remove LLM Profiles and Model Configuration from nav
- Add links to Skills and MCP Servers under Customize header in customize-and-settings
- Remove stale llm-profiles link from Related Guides

Co-authored-by: openhands <openhands@all-hands.dev>
- Convert flat backends entry to a nav group
- Add placeholder sub-pages: Local, VM, Docker, OpenHands Cloud

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

- Move automations.mdx content into prebuilt-automations.mdx
- Add intro section at top of prebuilt-automations linking to the
  three pre-built automation sub-pages (PR review, repo monitor, Slack)
- Delete automations.mdx
- Remove automations from Onboarding Agent Canvas nav

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Covers all four onboarding steps with screenshots:
- Step 1: Choose your agent (OpenHands, Claude Code, Codex, Gemini CLI via ACP)
- Step 2: Check your backend (local default, link to backends guide)
- Step 3: Set up your LLM (BYOK + OpenHands Cloud link)
- Step 4: Start from a proven workflow (GitHub PR Review Copilot + pre-built automations)

Co-authored-by: openhands <openhands@all-hands.dev>
* docs: add custom Agent Server image guide for Docker backend

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>

* docs: use agent-server-java name, port 8001, add multi-backend section

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

* docs: pin agent server version in FROM example

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

* docs: use 1-python base tag with short pinning tip

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

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Replace ghcr.io/openhands/agent-server:1-python with
ghcr.io/openhands/agent-canvas:latest as the base image for custom
Docker backend builds. The agent-canvas image is the all-in-one image
that bundles the agent server, automation backend, and frontend.

Co-authored-by: openhands <openhands@all-hands.dev>
Base automatically changed from docs/onboarding-agent-canvas to main June 3, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants