Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openhands.dev/llms.txt

Use this file to discover all available pages before exploring further.

A backend is an agent server and the workspace it operates in. All conversations, settings, and automations run against whichever backend is currently selected.

Connecting to a Backend

Any Agent Canvas frontend can connect to any Agent Canvas backend. Use the backend switcher in the UI to open Manage Backends, where you can add, edit, or remove entries. Each entry stores a display name, host URL, and an API key for authentication. Settings, LLM configuration, MCP servers, and automations are all scoped to the active backend — switching backends switches all of these.
SetupWhen to useHow
Default localQuick local work on your machineRun agent-canvas — a local backend is created automatically
Backend-only (local)Multiple projects, or separate frontend and backend processesRun agent-canvas --backend-only (optionally on different ports), connect with --frontend-only. See Local Backend.
Backend-only (remote)Always-on server, more powerful hardware, or team-shared accessRun agent-canvas --backend-only --public on a VM with a LOCAL_BACKEND_API_KEY, connect via SSH tunnel or reverse proxy. See VM / Self-Hosted Backend.
CloudManaged sandboxes without local resourcesConnect to OpenHands Cloud from Manage Backends. See Cloud Backend.