From 18d2d6275ef599aa87a6311fbbeb70fbcd3786bf Mon Sep 17 00:00:00 2001 From: openhands Date: Fri, 25 Sep 2026 15:21:19 +0000 Subject: [PATCH] docs: update documentation for OpenHands v1.24.0 Reflect user-facing Canvas/App changes from the v1.24.0 release: - agent-canvas/conversations: document the Conversations header control that collapses/expands all visible workspace folders, and note that a newer failed message and its Retry control survive a history reload. - automations/creating-automations: document single-start stepped cron fields (start/step, e.g. 2/2) accepted by the schedule validator. - agent-canvas/managing-automations and automations/managing-automations: document read-only viewing of shared automation conversations on Cloud. - settings/llm-settings: document the Model not listed warning for saved profiles that reference an unavailable managed model. - settings/mcp-settings: document MCP OAuth credential retention across Cloud saves and consent skipping while tokens remain valid. - agent-canvas setup/overview/backend-setup/vm: align the Node.js prerequisite with engines.node >= 24. Refs: OpenHands/OpenHands v1.24.0 Co-authored-by: openhands --- openhands/usage/agent-canvas/backend-setup/vm.mdx | 8 ++++---- openhands/usage/agent-canvas/conversations.mdx | 8 ++++++++ openhands/usage/agent-canvas/managing-automations.mdx | 4 ++++ openhands/usage/agent-canvas/overview.mdx | 2 +- openhands/usage/agent-canvas/setup.mdx | 4 ++-- openhands/usage/automations/creating-automations.mdx | 2 ++ openhands/usage/automations/managing-automations.mdx | 2 ++ openhands/usage/settings/llm-settings.mdx | 2 ++ openhands/usage/settings/mcp-settings.mdx | 2 ++ 9 files changed, 27 insertions(+), 7 deletions(-) diff --git a/openhands/usage/agent-canvas/backend-setup/vm.mdx b/openhands/usage/agent-canvas/backend-setup/vm.mdx index 9e2a4c430..6a8c11967 100644 --- a/openhands/usage/agent-canvas/backend-setup/vm.mdx +++ b/openhands/usage/agent-canvas/backend-setup/vm.mdx @@ -38,7 +38,7 @@ Before starting Agent Canvas, restrict inbound traffic: Agent Canvas requires: -- [Node.js](https://nodejs.org/en/download) 22.12 or later, including `npm`. +- [Node.js](https://nodejs.org/en/download) 24 or later, including `npm`. - [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for the agent server runtime. - `git` and `curl`. - Optional: [`ngrok`](https://ngrok.com/download) for a public URL on a free ngrok domain or your own custom domain. @@ -46,14 +46,14 @@ Agent Canvas requires: ### Ubuntu 22.04 / 24.04 -Install Node.js 22.x, `uv`, and Agent Canvas: +Install Node.js 24.x, `uv`, and Agent Canvas: ```bash sudo apt-get update sudo apt-get install -y ca-certificates curl gnupg git -# Node.js 22.x from NodeSource. -curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - +# Node.js 24.x from NodeSource. +curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash - sudo apt-get install -y nodejs # uv for the agent server runtime. diff --git a/openhands/usage/agent-canvas/conversations.mdx b/openhands/usage/agent-canvas/conversations.mdx index 95999c98c..59bf140a8 100644 --- a/openhands/usage/agent-canvas/conversations.mdx +++ b/openhands/usage/agent-canvas/conversations.mdx @@ -21,6 +21,12 @@ Use the conversation list controls to manage automation runs and visible tags: Agent Canvas omits reserved tags and raw automation IDs from the chips. LLM metadata is also hidden by default. +### Collapse or Expand All Workspace Folders + +When conversations are grouped by workspace, the `Conversations` header in the sidebar doubles as a bulk control for the visible folders. Select it to collapse every visible workspace folder at once, then select it again to expand them all. + +Only the folders currently visible are affected; folders scrolled out of view keep their own state. + ## Follow Agent Activity While an agent is running, the composer shows a live activity chip for its current unresolved action, such as reading a file or running a command. If no action-specific label is available, it shows `Thinking`. The chip disappears when the agent pauses or completes its work. @@ -31,6 +37,8 @@ If a message fails to send, select `Retry` to send it again or `Dismiss` to remo A "Failed to send" bubble can appear while the connection is slow or reconnecting. Once the server confirms the message and it appears in the conversation, Agent Canvas clears the stale bubble automatically. Select `Retry` only if the message never arrives. +Reloading conversation history does not hide a newer failed message: the failed bubble and its `Retry` control are preserved across the reload. + ## Inline Markdown Artifact Previews When an agent creates a Markdown file, Agent Canvas renders it inline as a height-limited rich preview with an internal scrollbar instead of showing only the raw file content. Select `View` to open the full file in the Files drawer. diff --git a/openhands/usage/agent-canvas/managing-automations.mdx b/openhands/usage/agent-canvas/managing-automations.mdx index 04d2b96cd..f2efa3d6b 100644 --- a/openhands/usage/agent-canvas/managing-automations.mdx +++ b/openhands/usage/agent-canvas/managing-automations.mdx @@ -29,6 +29,10 @@ A run can be `PENDING`, `RUNNING`, `COMPLETED`, `FAILED`, `CANCELLED`, or `SKIPP Automation runs surface a live **phase** that reflects a run's current state: `PENDING`, `RUNNING`, or `FAILED`. The phase appears on automation cards, in the Activity Log, and on the home screen, and updates live as a run progresses. A failed run retains its last phase after it stops. +### Shared Automation Conversations on Cloud + +On OpenHands Cloud, a run's conversation can be viewed read-only by other members of your organization. Open the run's link — from the Activity Log or a `/conversations/` URL — and, if you are not the owner, Agent Canvas renders the conversation in read-only mode instead of reporting that it does not exist. Read-only viewers can follow the conversation history but cannot send messages or change the automation. + ### Script Automation Run Logs An automation that runs a script bundle executes its entrypoint directly instead of starting a conversation. For these runs, the run record has no conversation. Use **View logs** on the run to read the script's output; Agent Canvas resolves the logs from the run's sandbox on cloud backends. A run that executed a script shows `No conversation — this run executed a script. Use View logs for its output.` instead of `No Conversation`. diff --git a/openhands/usage/agent-canvas/overview.mdx b/openhands/usage/agent-canvas/overview.mdx index 8e69cb3b4..96646f408 100644 --- a/openhands/usage/agent-canvas/overview.mdx +++ b/openhands/usage/agent-canvas/overview.mdx @@ -120,7 +120,7 @@ A conversation belongs to one active backend and has its own history, agent conf For the normal local setup, you need: -- Node.js 22.12 or later +- Node.js 24 or later - `npm` - A model access path, such as a provider API key, OpenHands Cloud LLM key, ACP subscription login, or local model server - A folder, repository, or project workspace for the agent to work in diff --git a/openhands/usage/agent-canvas/setup.mdx b/openhands/usage/agent-canvas/setup.mdx index 59c5561a7..e8370a71e 100644 --- a/openhands/usage/agent-canvas/setup.mdx +++ b/openhands/usage/agent-canvas/setup.mdx @@ -28,7 +28,7 @@ The `agent-canvas` launcher can run the Canvas client with Agent Server, Automat - Install [Node.js](https://nodejs.org/en/download) 22.12 or later and [`uv`](https://docs.astral.sh/uv/getting-started/installation/), then verify both tools are available: + Install [Node.js](https://nodejs.org/en/download) 24 or later and [`uv`](https://docs.astral.sh/uv/getting-started/installation/), then verify both tools are available: ```bash node --version @@ -51,7 +51,7 @@ The `agent-canvas` launcher can run the Canvas client with Agent Server, Automat - Install [Node.js](https://nodejs.org/en/download) 22.12 or later and [`uv`](https://docs.astral.sh/uv/getting-started/installation/), then verify the tools are available: + Install [Node.js](https://nodejs.org/en/download) 24 or later and [`uv`](https://docs.astral.sh/uv/getting-started/installation/), then verify the tools are available: ```bash node --version diff --git a/openhands/usage/automations/creating-automations.mdx b/openhands/usage/automations/creating-automations.mdx index f3907ac51..cacb14ea5 100644 --- a/openhands/usage/automations/creating-automations.mdx +++ b/openhands/usage/automations/creating-automations.mdx @@ -127,6 +127,8 @@ The agent converts this to the appropriate cron schedule. If you're familiar with cron expressions, you can specify them directly: "Run on cron schedule `0 9 * * 1-5`" +Cron fields also accept a single-start step, written as `start/step`. The validator expands it from the start value up to the field maximum, so `2/2` in the month field means February, April, June, August, October, and December. For example, `0 0 31 2/2 *` is accepted as a valid schedule. A step with a wildcard start, such as `*/2`, remains valid. + ## Run Timeouts Each run stops after its timeout. The default is 10 minutes; you can request up to 30 minutes, for example: "Use a 20-minute timeout." diff --git a/openhands/usage/automations/managing-automations.mdx b/openhands/usage/automations/managing-automations.mdx index 8fd872803..ec44775f8 100644 --- a/openhands/usage/automations/managing-automations.mdx +++ b/openhands/usage/automations/managing-automations.mdx @@ -85,6 +85,8 @@ In an automation's `Activity Log`, use `Export JSON` or `Export CSV` to download Automations are user-scoped, so all your automation runs appear alongside your regular conversations. Look for them in your conversations list after each scheduled run. +On OpenHands Cloud, organization members can open a link to an automation-run conversation owned by another member and view it read-only. Start from the run link in the automation's activity log or a conversation URL of the form `/conversations/`. Read-only viewers can follow the full history but cannot send messages or change the agent configuration. + ### Run Statuses - **Pending**: Scheduled, waiting to start diff --git a/openhands/usage/settings/llm-settings.mdx b/openhands/usage/settings/llm-settings.mdx index e91c911b6..4eb11e0c8 100644 --- a/openhands/usage/settings/llm-settings.mdx +++ b/openhands/usage/settings/llm-settings.mdx @@ -85,6 +85,8 @@ Click the menu icon (three dots) on any profile to access these actions: - **Set as Active**: Make this profile the default for new conversations - **Delete**: Remove the profile +If a saved profile references a managed model that is no longer available in the installation, OpenHands shows a `Model not listed` warning next to the profile on the LLM settings page and in the conversation picker. The profile and your current selection remain unchanged; select a listed model to clear the warning. + You can save up to 10 LLM profiles per account. Delete unused profiles if you need to create new ones. diff --git a/openhands/usage/settings/mcp-settings.mdx b/openhands/usage/settings/mcp-settings.mdx index 04312bd60..98f75ba50 100644 --- a/openhands/usage/settings/mcp-settings.mdx +++ b/openhands/usage/settings/mcp-settings.mdx @@ -212,6 +212,8 @@ When you configure an OAuth-enabled MCP server: 3. **Token storage**: After authorization, tokens are securely stored locally in `~/.fastmcp/oauth-mcp-client-cache/` 4. **Automatic refresh**: FastMCP automatically refreshes tokens as needed +On OpenHands Cloud, saving MCP settings keeps the OAuth credential and its token state instead of flattening it into a request header, so installed servers keep their authorization across saves. When a server already holds working tokens, OpenHands probes them and skips the consent prompt; the browser window only opens when authorization is actually required. + ### Configuration