Skip to content

Commit 05e9d51

Browse files
docs: document sandbox provider selection via RUNTIME
Co-authored-by: openhands <openhands@all-hands.dev>
1 parent 21a2d2b commit 05e9d51

5 files changed

Lines changed: 55 additions & 3 deletions

File tree

‎openhands/usage/advanced/configuration-options.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ These are some commonly used variables in V1 deployments:
4242
- <code>AGENT_SERVER_IMAGE_REPOSITORY</code>
4343
- <code>AGENT_SERVER_IMAGE_TAG</code>
4444

45+
46+
## Sandbox provider selection
47+
48+
Some deployments still use the legacy <code>RUNTIME</code> environment variable to
49+
choose which sandbox provider to use:
50+
51+
- <code>RUNTIME=docker</code> (default)
52+
- <code>RUNTIME=process</code> (aka legacy <code>RUNTIME=local</code>)
53+
- <code>RUNTIME=remote</code>
54+
55+
See [Sandboxes overview](/openhands/usage/sandboxes/overview) for details.
56+
4557
## Need legacy options?
4658

4759
If you are looking for the old <code>config.toml</code> reference or V0 “runtime”

‎openhands/usage/sandboxes/docker.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ description: The recommended sandbox provider for running OpenHands locally.
66
The **Docker sandbox** runs the agent server inside a Docker container. This is
77
the default and recommended option for most users.
88

9+
<Note>
10+
In some self-hosted deployments, the sandbox provider is controlled via the
11+
legacy <code>RUNTIME</code> environment variable. Docker is the default.
12+
</Note>
13+
14+
915
## Why Docker?
1016

1117
- Isolation: reduces risk when the agent runs commands.

‎openhands/usage/sandboxes/overview.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ OpenHands supports multiple sandbox “providers”, with different tradeoffs:
2424
- Runs the agent server in a remote environment.
2525
- Used by managed deployments and some hosted setups.
2626

27+
## Selecting a provider (current behavior)
28+
29+
In some deployments, the provider selection is still controlled via the legacy
30+
<code>RUNTIME</code> environment variable:
31+
32+
- <code>RUNTIME=docker</code> (default)
33+
- <code>RUNTIME=process</code> (aka legacy <code>RUNTIME=local</code>)
34+
- <code>RUNTIME=remote</code>
35+
36+
<Note>
37+
The user-facing terminology in V1 is <b>sandbox</b>, but the configuration knob
38+
may still be called <code>RUNTIME</code> while the migration is in progress.
39+
</Note>
40+
2741
## Terminology note (V0 vs V1)
2842

2943
Older documentation refers to these environments as **runtimes**.

‎openhands/usage/sandboxes/process.mdx‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,13 @@ regular process.
2323

2424
## Choosing process mode
2525

26-
Exact configuration depends on how you run OpenHands (CLI launcher, Docker, or
27-
a self-hosted deployment). In some setups this may still be exposed under a
28-
legacy “runtime” selector.
26+
In some deployments, this is selected via the legacy <code>RUNTIME</code>
27+
environment variable:
28+
29+
```bash
30+
export RUNTIME=process
31+
# (legacy alias)
32+
# export RUNTIME=local
33+
```
2934

3035
If you are unsure, prefer the [Docker Sandbox](/openhands/usage/sandboxes/docker).

‎openhands/usage/sandboxes/remote.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,21 @@ instead of on your local machine.
99
This is typically used by managed deployments (e.g., OpenHands Cloud) and
1010
advanced self-hosted setups.
1111

12+
## Selecting remote mode
13+
14+
In some self-hosted deployments, remote sandboxes are selected via the legacy
15+
<code>RUNTIME</code> environment variable:
16+
17+
```bash
18+
export RUNTIME=remote
19+
```
20+
21+
Remote sandboxes require additional configuration (API URL + API key). The exact
22+
variable names depend on your deployment, but you may see legacy names like:
23+
24+
- <code>SANDBOX_REMOTE_RUNTIME_API_URL</code>
25+
- <code>SANDBOX_API_KEY</code>
26+
1227
## Notes
1328

1429
- Remote sandboxes may expose additional service URLs (e.g., VS Code, app ports)

0 commit comments

Comments
 (0)