Skip to content

πŸ™Œ OpenHands: AI-Driven Development

3.3 KB
Raw Blame
{
  "_comment": "Single source of truth for version pins, ports, paths, and defaults shared across the npm and Docker install paths. Read by scripts/dev-safe.mjs, scripts/dev-with-automation.mjs, docker/entrypoint.sh (via generated defaults.env), and .github/workflows/docker.yml.",
  "versions": {
    "agentServer": "1.58.1",
    "agentCanvas": "1.32.0",
    "automation": "1.25.1"
  },
  "compatibility": {
    "minimumAgentServer": "1.55.0"
  },
  "python": {
    "_comment": "Interpreter request the npm and desktop launchers pass to uvx as --python for agent-server and automation. Without it uvx downloads the newest CPython when it finds no suitable interpreter, which breaks every autumn until the SDK's compiled dependencies (lmnr-claude-code-proxy, fastuuid) publish wheels for the new release (OpenHands/OpenHands#18654). Raise the upper bound once they do. UV_PYTHON in the environment replaces it.",
    "uvxRequest": ">=3.12,<3.15"
  },
  "images": {
    "agentServer": "ghcr.io/openhands/agent-server",
    "agentCanvas": "ghcr.io/openhands/agent-canvas"
  },
  "ports": {
    "agentServer": 18000,
    "automation": 18001,
    "proxy": 8000,
    "_vscodeComment": "Port the bundled editor binds to inside the container; agent-server's own default. Only the Docker entrypoint reads this β€” the npm launchers derive the editor port from the agent-server port so several stacks can run side by side. It is never published: the editor is reached through paths.vscodeBasePath on the proxy port.",
    "vscode": 8001
  },
  "paths": {
    "stateSubdir": "agent-canvas",
    "conversations": "agent-canvas/conversations",
    "bashEvents": "agent-canvas/bash_events",
    "automationDb": "automation/automations.db",
    "canvasBasePath": "/canvas",
    "_vscodeBasePathComment": "Path prefix the bundled editor is served under, on the same origin as the canvas. Passed to agent-server as OH_VSCODE_BASE_PATH (it launches openvscode-server with --server-base-path and advertises the prefix in /api/vscode/url), and registered as an ingress route to the VSCode port. Keeping one value on both sides is what lets a single-origin deployment reach the editor without publishing a second port. Tradeoff: a path prefix routes but does not isolate, so the editor shares the canvas's browser origin and therefore its localStorage β€” see docs/SELF_HOSTING.md and OpenHands/OpenHands#16492.",
    "vscodeBasePath": "/vscode"
  },
  "packages": {
    "agentServer": "openhands-agent-server",
    "automation": "openhands-automation",
    "tools": "openhands-tools",
    "workspace": "openhands-workspace"
  },
  "mars": {
    "_comment": "DigitalOcean Managed Agents: the Electron desktop app and the web build (its server hosts the experimental bridge only with MARS_WEB=1). apiBaseUrl is the harness API both use. oauthClientId (desktop only; the web build offers personal access tokens only) is the public client ID of the DigitalOcean OAuth app registered with redirect URI http://127.0.0.1:53682/callback; implicit grant needs no secret. Leave empty to offer personal access tokens only. Overridden at runtime by DO_OAUTH_CLIENT_ID / MARS_API_BASE_URL. Read by scripts/mars-tunnel-bridge.mjs.",
    "apiBaseUrl": "https://api.digitalocean.com",
    "oauthClientId": ""
  },
  "telemetry": {
    "posthogApiKey": "phc_kBtz5nKmxVRRQ7HtPwr2QX9eMC5j65zE86QKocVNwb4U",
    "posthogHost": "https://us.i.posthog.com"
  }
}