From 21a2d2b423b0151e1b5ef2d920c937d76b2d65aa Mon Sep 17 00:00:00 2001 From: enyst Date: Mon, 26 Jan 2026 10:31:37 +0000 Subject: [PATCH 01/10] docs: add Web_V0 tab and V1 sandbox docs Co-authored-by: openhands --- .github/CODEOWNERS | 2 +- docs.json | 94 +++- openapi/{openapi.json => V0_openapi.json} | 0 .../usage/advanced/configuration-options.mdx | 452 ++---------------- openhands/usage/api/v1.mdx | 42 ++ openhands/usage/cli/gui-server.mdx | 2 +- openhands/usage/cli/installation.mdx | 2 +- openhands/usage/llms/openhands-llms.mdx | 11 +- openhands/usage/run-openhands/local-setup.mdx | 2 +- openhands/usage/runtimes/overview.mdx | 40 -- openhands/usage/sandboxes/docker.mdx | 46 ++ openhands/usage/sandboxes/overview.mdx | 30 ++ openhands/usage/sandboxes/process.mdx | 30 ++ openhands/usage/sandboxes/remote.mdx | 18 + .../v0/advanced/V0_configuration-options.mdx | 446 +++++++++++++++++ .../runtimes/V0_daytona.mdx} | 7 +- .../docker.mdx => v0/runtimes/V0_docker.mdx} | 7 +- .../e2b.mdx => v0/runtimes/V0_e2b.mdx} | 7 +- .../local.mdx => v0/runtimes/V0_local.mdx} | 7 +- .../modal.mdx => v0/runtimes/V0_modal.mdx} | 7 +- openhands/usage/v0/runtimes/V0_overview.mdx | 45 ++ .../remote.mdx => v0/runtimes/V0_remote.mdx} | 7 +- .../runtimes/V0_runloop.mdx} | 7 +- 23 files changed, 818 insertions(+), 493 deletions(-) rename openapi/{openapi.json => V0_openapi.json} (100%) create mode 100644 openhands/usage/api/v1.mdx delete mode 100644 openhands/usage/runtimes/overview.mdx create mode 100644 openhands/usage/sandboxes/docker.mdx create mode 100644 openhands/usage/sandboxes/overview.mdx create mode 100644 openhands/usage/sandboxes/process.mdx create mode 100644 openhands/usage/sandboxes/remote.mdx create mode 100644 openhands/usage/v0/advanced/V0_configuration-options.mdx rename openhands/usage/{runtimes/daytona.mdx => v0/runtimes/V0_daytona.mdx} (88%) rename openhands/usage/{runtimes/docker.mdx => v0/runtimes/V0_docker.mdx} (96%) rename openhands/usage/{runtimes/e2b.mdx => v0/runtimes/V0_e2b.mdx} (86%) rename openhands/usage/{runtimes/local.mdx => v0/runtimes/V0_local.mdx} (93%) rename openhands/usage/{runtimes/modal.mdx => v0/runtimes/V0_modal.mdx} (68%) create mode 100644 openhands/usage/v0/runtimes/V0_overview.mdx rename openhands/usage/{runtimes/remote.mdx => v0/runtimes/V0_remote.mdx} (75%) rename openhands/usage/{runtimes/runloop.mdx => v0/runtimes/V0_runloop.mdx} (82%) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 73bd45874..5cd186cca 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,5 +1,5 @@ /openhands/ @mamoodi -/openapi/openapi.json @tofarr +/openapi/V0_openapi.json @tofarr /openapi/agent-sdk.json @xingyaoww @enyst /sdk/ @xingyaoww @enyst /success-stories/ @jamiechicago312 \ No newline at end of file diff --git a/docs.json b/docs.json index 3738b7679..4d1cb34c9 100644 --- a/docs.json +++ b/docs.json @@ -105,7 +105,9 @@ }, { "group": "REST API", - "openapi": "openapi/openapi.json" + "pages": [ + "openhands/usage/api/v1" + ] }, { "group": "Customizations & Settings", @@ -148,24 +150,15 @@ ] }, { - "group": "Runtime Configuration", + "group": "Sandbox Configuration", "pages": [ - "openhands/usage/runtimes/overview", + "openhands/usage/sandboxes/overview", { "group": "Providers", "pages": [ - "openhands/usage/runtimes/docker", - "openhands/usage/runtimes/remote", - "openhands/usage/runtimes/local", - { - "group": "Third-Party Providers", - "pages": [ - "openhands/usage/runtimes/modal", - "openhands/usage/runtimes/daytona", - "openhands/usage/runtimes/runloop", - "openhands/usage/runtimes/e2b" - ] - } + "openhands/usage/sandboxes/docker", + "openhands/usage/sandboxes/remote", + "openhands/usage/sandboxes/process" ] } ] @@ -177,6 +170,44 @@ } ] }, + { + "tab": "Web_V0", + "pages": [ + { + "group": "V0 REST API", + "openapi": "openapi/V0_openapi.json" + }, + { + "group": "V0 Runtime Configuration", + "pages": [ + "openhands/usage/v0/runtimes/V0_overview", + { + "group": "Providers", + "pages": [ + "openhands/usage/v0/runtimes/V0_docker", + "openhands/usage/v0/runtimes/V0_remote", + "openhands/usage/v0/runtimes/V0_local", + { + "group": "Third-Party Providers", + "pages": [ + "openhands/usage/v0/runtimes/V0_modal", + "openhands/usage/v0/runtimes/V0_daytona", + "openhands/usage/v0/runtimes/V0_runloop", + "openhands/usage/v0/runtimes/V0_e2b" + ] + } + ] + } + ] + }, + { + "group": "V0 Configuration Options", + "pages": [ + "openhands/usage/v0/advanced/V0_configuration-options" + ] + } + ] + }, { "tab": "CLI", "pages": [ @@ -578,6 +609,39 @@ { "source": "/openhands/usage/run-openhands/cli/resume", "destination": "/openhands/usage/cli/resume" + }, + { + "source": "/openhands/usage/runtimes/overview", + "destination": "/openhands/usage/sandboxes/overview" + }, + { + "source": "/openhands/usage/runtimes/docker", + "destination": "/openhands/usage/sandboxes/docker" + }, + { + "source": "/openhands/usage/runtimes/remote", + "destination": "/openhands/usage/sandboxes/remote" + }, + { + "source": "/openhands/usage/runtimes/local", + "destination": "/openhands/usage/sandboxes/process" + }, + { + "source": "/openhands/usage/runtimes/e2b", + "destination": "/openhands/usage/v0/runtimes/V0_e2b" + }, + { + "source": "/openhands/usage/runtimes/modal", + "destination": "/openhands/usage/v0/runtimes/V0_modal" + }, + { + "source": "/openhands/usage/runtimes/runloop", + "destination": "/openhands/usage/v0/runtimes/V0_runloop" + }, + { + "source": "/openhands/usage/runtimes/daytona", + "destination": "/openhands/usage/v0/runtimes/V0_daytona" } + ] } \ No newline at end of file diff --git a/openapi/openapi.json b/openapi/V0_openapi.json similarity index 100% rename from openapi/openapi.json rename to openapi/V0_openapi.json diff --git a/openhands/usage/advanced/configuration-options.mdx b/openhands/usage/advanced/configuration-options.mdx index 13f3523b0..c5179f21d 100644 --- a/openhands/usage/advanced/configuration-options.mdx +++ b/openhands/usage/advanced/configuration-options.mdx @@ -1,441 +1,51 @@ --- title: Configuration Options -description: This page outlines all available configuration options for OpenHands, allowing you to customize its - behavior and integrate it with other services. +description: How to configure OpenHands V1 (Web UI, env vars, and sandbox settings). --- - These settings are only available in [Local GUI](/openhands/usage/run-openhands/local-setup). OpenHands Cloud uses a web-based settings interface. - - - - In GUI Mode, any settings applied through the Settings UI will take precedence. - - - - **Looking for Environment Variables?** All configuration options can also be set using environment variables. - See the [Environment Variables Reference](/openhands/usage/environment-variables) for a complete list with examples. - - -## Location of the `config.toml` File - -When running OpenHands in CLI, headless, or development mode, you can use a project-specific `config.toml` file for configuration, which must be -located in the same directory from which the command is run. Alternatively, you may use the `--config-file` option to -specify a different path to the `config.toml` file. - -## Core Configuration - -The core configuration options are defined in the `[core]` section of the `config.toml` file. - -Core configuration options can be set as environment variables by converting to uppercase. For example: -- `debug` → `DEBUG` -- `cache_dir` → `CACHE_DIR` -- `runtime` → `RUNTIME` - -### Workspace -- `workspace_base` **(Deprecated)** - - Type: `str` - - Default: `"./workspace"` - - Description: Base path for the workspace. **Deprecated: Use `SANDBOX_VOLUMES` instead.** - -- `cache_dir` - - Type: `str` - - Default: `"/tmp/cache"` - - Description: Cache directory path - -### Debugging and Logging -- `debug` - - Type: `bool` - - Default: `false` - - Description: Enable debugging - -- `disable_color` - - Type: `bool` - - Default: `false` - - Description: Disable color in terminal output - -### Trajectories -- `save_trajectory_path` - - Type: `str` - - Default: `"./trajectories"` - - Description: Path to store trajectories (can be a folder or a file). If it's a folder, the trajectories will be saved in a file named with the session id name and .json extension, in that folder. - -- `replay_trajectory_path` - - Type: `str` - - Default: `""` - - Description: Path to load a trajectory and replay. If given, must be a path to the trajectory file in JSON format. The actions in the trajectory file would be replayed first before any user instruction is executed. - -### File Store -- `file_store_path` - - Type: `str` - - Default: `"/tmp/file_store"` - - Description: File store path - -- `file_store` - - Type: `str` - - Default: `"memory"` - - Description: File store type - -- `file_uploads_allowed_extensions` - - Type: `list of str` - - Default: `[".*"]` - - Description: List of allowed file extensions for uploads - -- `file_uploads_max_file_size_mb` - - Type: `int` - - Default: `0` - - Description: Maximum file size for uploads, in megabytes + This page documents the current V1 configuration model. -- `file_uploads_restrict_file_types` - - Type: `bool` - - Default: `false` - - Description: Restrict file types for file uploads - -- `file_uploads_allowed_extensions` - - Type: `list of str` - - Default: `[".*"]` - - Description: List of allowed file extensions for uploads - -### Task Management -- `max_budget_per_task` - - Type: `float` - - Default: `0.0` - - Description: Maximum budget per task (0.0 means no limit) - -- `max_iterations` - - Type: `int` - - Default: `100` - - Description: Maximum number of iterations - -### Sandbox Configuration -- `volumes` - - Type: `str` - - Default: `None` - - Description: Volume mounts in the format 'host_path:container_path[:mode]', e.g. '/my/host/dir:/workspace:rw'. Multiple mounts can be specified using commas, e.g. '/path1:/workspace/path1,/path2:/workspace/path2:ro' - -- `workspace_mount_path_in_sandbox` **(Deprecated)** - - Type: `str` - - Default: `"/workspace"` - - Description: Path to mount the workspace in the sandbox. **Deprecated: Use `SANDBOX_VOLUMES` instead.** - -- `workspace_mount_path` **(Deprecated)** - - Type: `str` - - Default: `""` - - Description: Path to mount the workspace. **Deprecated: Use `SANDBOX_VOLUMES` instead.** - -- `workspace_mount_rewrite` **(Deprecated)** - - Type: `str` - - Default: `""` - - Description: Path to rewrite the workspace mount path to. You can usually ignore this, it refers to special cases of running inside another container. **Deprecated: Use `SANDBOX_VOLUMES` instead.** - -### Miscellaneous -- `run_as_openhands` - - Type: `bool` - - Default: `true` - - Description: Run as OpenHands - -- `runtime` - - Type: `str` - - Default: `"docker"` - - Description: Runtime environment - -- `default_agent` - - Type: `str` - - Default: `"CodeActAgent"` - - Description: Name of the default agent - -- `jwt_secret` - - Type: `str` - - Default: `uuid.uuid4().hex` - - Description: JWT secret for authentication. Please set it to your own value. - -## LLM Configuration - -The LLM (Large Language Model) configuration options are defined in the `[llm]` section of the `config.toml` file. - -To use these with the docker command, pass in `-e LLM_