diff --git a/openhands/usage/advanced/custom-sandbox-guide.mdx b/openhands/usage/advanced/custom-sandbox-guide.mdx index 93b4b615..0cb745ce 100644 --- a/openhands/usage/advanced/custom-sandbox-guide.mdx +++ b/openhands/usage/advanced/custom-sandbox-guide.mdx @@ -52,7 +52,7 @@ This will produce a new image called `custom-image`, which will be available in ## Using the Docker Command When running OpenHands using [the docker command](/usage/run-openhands/local-setup#start-the-app), replace -`-e SANDBOX_RUNTIME_CONTAINER_IMAGE=...` with `-e SANDBOX_BASE_CONTAINER_IMAGE=`: +the `AGENT_SERVER_IMAGE_REPOSITORY` and `AGENT_SERVER_IMAGE_TAG` environment variables with `-e SANDBOX_BASE_CONTAINER_IMAGE=`: ```commandline docker run -it --rm --pull=always \ diff --git a/openhands/usage/cli/installation.mdx b/openhands/usage/cli/installation.mdx index a7eda768..4849540a 100644 --- a/openhands/usage/cli/installation.mdx +++ b/openhands/usage/cli/installation.mdx @@ -65,7 +65,8 @@ description: Install the OpenHands CLI on your system ```bash docker run -it \ --pull=always \ - -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.openhands.dev/openhands/runtime:1.2-nikolaik \ + -e AGENT_SERVER_IMAGE_REPOSITORY=docker.openhands.dev/openhands/runtime \ + -e AGENT_SERVER_IMAGE_TAG=1.2-nikolaik \ -e SANDBOX_USER_ID=$(id -u) \ -e SANDBOX_VOLUMES=$SANDBOX_VOLUMES \ -v /var/run/docker.sock:/var/run/docker.sock \ diff --git a/openhands/usage/environment-variables.mdx b/openhands/usage/environment-variables.mdx index cf4efde3..82887738 100644 --- a/openhands/usage/environment-variables.mdx +++ b/openhands/usage/environment-variables.mdx @@ -107,7 +107,8 @@ These variables correspond to the `[sandbox]` section in `config.toml`: | `SANDBOX_RUNTIME_STARTUP_ENV_VARS` | dict | `{}` | Environment variables for runtime | | `SANDBOX_BROWSERGYM_EVAL_ENV` | string | `""` | BrowserGym evaluation environment | | `SANDBOX_VOLUMES` | string | `""` | Volume mounts (replaces deprecated workspace settings) | -| `SANDBOX_RUNTIME_CONTAINER_IMAGE` | string | `""` | Pre-built runtime container image | +| `AGENT_SERVER_IMAGE_REPOSITORY` | string | `""` | Runtime container image repository (e.g., `docker.openhands.dev/openhands/runtime`) | +| `AGENT_SERVER_IMAGE_TAG` | string | `""` | Runtime container image tag (e.g., `1.2-nikolaik`) | | `SANDBOX_KEEP_RUNTIME_ALIVE` | boolean | `false` | Keep runtime alive after session ends | | `SANDBOX_PAUSE_CLOSED_RUNTIMES` | boolean | `false` | Pause instead of stopping closed runtimes | | `SANDBOX_CLOSE_DELAY` | integer | `300` | Delay before closing idle runtimes (seconds) | diff --git a/openhands/usage/llms/local-llms.mdx b/openhands/usage/llms/local-llms.mdx index b4fcbe56..74da18f4 100644 --- a/openhands/usage/llms/local-llms.mdx +++ b/openhands/usage/llms/local-llms.mdx @@ -71,7 +71,8 @@ Download and install the LM Studio desktop app from [lmstudio.ai](https://lmstud docker pull docker.openhands.dev/openhands/runtime:1.2-nikolaik docker run -it --rm --pull=always \ - -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.openhands.dev/openhands/runtime:1.2-nikolaik \ + -e AGENT_SERVER_IMAGE_REPOSITORY=docker.openhands.dev/openhands/runtime \ + -e AGENT_SERVER_IMAGE_TAG=1.2-nikolaik \ -e LOG_ALL_EVENTS=true \ -v /var/run/docker.sock:/var/run/docker.sock \ -v ~/.openhands:/.openhands \ diff --git a/openhands/usage/run-openhands/local-setup.mdx b/openhands/usage/run-openhands/local-setup.mdx index 9d5aaf6f..56a6514f 100644 --- a/openhands/usage/run-openhands/local-setup.mdx +++ b/openhands/usage/run-openhands/local-setup.mdx @@ -124,7 +124,8 @@ Note that you'll still need `uv` installed for the default MCP servers to work p docker pull docker.openhands.dev/openhands/runtime:1.2-nikolaik docker run -it --rm --pull=always \ - -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.openhands.dev/openhands/runtime:1.2-nikolaik \ + -e AGENT_SERVER_IMAGE_REPOSITORY=docker.openhands.dev/openhands/runtime \ + -e AGENT_SERVER_IMAGE_TAG=1.2-nikolaik \ -e LOG_ALL_EVENTS=true \ -v /var/run/docker.sock:/var/run/docker.sock \ -v ~/.openhands:/.openhands \ diff --git a/openhands/usage/runtimes/docker.mdx b/openhands/usage/runtimes/docker.mdx index 143a15a1..9c0b4284 100644 --- a/openhands/usage/runtimes/docker.mdx +++ b/openhands/usage/runtimes/docker.mdx @@ -4,8 +4,9 @@ description: This is the default Runtime that's used when you start OpenHands. --- ## Image -The `SANDBOX_RUNTIME_CONTAINER_IMAGE` from nikolaik is a pre-built runtime image +The runtime image from nikolaik is a pre-built runtime image that contains our Runtime server, as well as some basic utilities for Python and NodeJS. +You can specify a custom runtime image using the `AGENT_SERVER_IMAGE_REPOSITORY` and `AGENT_SERVER_IMAGE_TAG` environment variables. You can also [build your own runtime image](/openhands/usage/advanced/custom-sandbox-guide). ## Connecting to Your filesystem diff --git a/openhands/usage/troubleshooting/troubleshooting.mdx b/openhands/usage/troubleshooting/troubleshooting.mdx index abcf2bf6..6db60848 100644 --- a/openhands/usage/troubleshooting/troubleshooting.mdx +++ b/openhands/usage/troubleshooting/troubleshooting.mdx @@ -86,7 +86,8 @@ To fix this: ```bash docker run -it --rm \ -e SANDBOX_VSCODE_PORT=41234 \ - -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.openhands.dev/openhands/runtime:latest \ + -e AGENT_SERVER_IMAGE_REPOSITORY=docker.openhands.dev/openhands/runtime \ + -e AGENT_SERVER_IMAGE_TAG=latest \ -v /var/run/docker.sock:/var/run/docker.sock \ -v ~/.openhands:/.openhands \ -p 3000:3000 \