Skip to content

docs: document boxlite sandbox disk_size_gb config #445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
omnigent-ci wants to merge 1 commit into
base: 0.9-docs
Choose a base branch
from
Open

docs: document boxlite sandbox disk_size_gb config #445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions app/docs/deploy/cloud-sandbox-host/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,30 @@ active gateway (`$OPENSHELL_GATEWAY` or `~/.config/openshell/active_gateway`).
(create, get, delete). Omit it to resolve `$OMNIGENT_OPENSHELL_WORKSPACE`, then
fall back to `"default"`.

**Boxlite:**

```
sandbox:
provider: boxlite
server_url: https://your-server.example.com
boxlite:
image: docker.io/me/omnigent-host:latest # optional, official image by default
env: [OPENAI_API_KEY, GIT_TOKEN] # server env vars to copy into sandbox
disk_size_gb: 100 # optional; box disk size in GB
cloud:
endpoint: https://boxlite.example.com:8100 # selects CLOUD mode
# local: {home_dir: /data/boxlite, registry: {...}} # LOCAL mode (default if omitted)
```

`env` lists env var names to copy from the server's environment into each box;
values never live in the config file. Provide exactly one mode: a `cloud` block
with an `endpoint` (CLOUD mode, authenticated with the `BOXLITE_API_KEY` env
var), or a `local` block with `home_dir` / `registry` (LOCAL mode, used by
default when neither is set).

`disk_size_gb` sets the box disk size in gigabytes and must be a positive
integer. Omit it to use the Boxlite SDK's own default disk size.

<div className="note">

**Islo idle pause and resume:** server-managed Islo sandboxes pause after 15
Expand Down