Skip to content

docs: update prerequisites Docker-driver wording #4165

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

Closed
glenn-agent wants to merge 2 commits into from
+10 −3
Closed

docs: update prerequisites Docker-driver wording #4165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84ae0de
docs: update prerequisites Docker-driver wording
glenn-agent May 25, 2026
5793770
docs: align Docker-driver memory guidance
glenn-agent May 25, 2026
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
8 changes: 6 additions & 2 deletions docs/get-started/prerequisites.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ Before getting started, check the prerequisites to ensure you have the necessary
| RAM | 8 GB | 16 GB |
| Disk | 20 GB free | 40 GB free |

The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance.
The sandbox image is approximately 2.4 GB compressed.
During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline.
The pipeline buffers decompressed layers in memory.
On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer.
If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance.

## Software

Expand Down Expand Up @@ -52,7 +56,7 @@ Avoid `openshell self-update`, `npm update -g openshell`, `openshell gateway sta
</Warning>

<Note title="Docker storage driver">
On Linux hosts running Docker 26 or later with the [containerd image store](https://docs.docker.com/engine/storage/containerd/) enabled (the install-time default for fresh `docker-ce` installations on Ubuntu 24.04 and similar distros), `nemoclaw onboard` transparently builds a `fuse-overlayfs`-enabled cluster image to bypass a kernel-level nested-overlay limitation in k3s.
On Linux hosts running Docker 26 or later with the [containerd image store](https://docs.docker.com/engine/storage/containerd/) enabled (the install-time default for fresh `docker-ce` installations on Ubuntu 24.04 and similar distros), `nemoclaw onboard` transparently builds a `fuse-overlayfs`-enabled OpenShell gateway image to bypass a kernel-level nested-overlay limitation.
No manual setup is required.
See the [troubleshooting guide](/reference/troubleshooting) for the override knobs and a manual `daemon.json` alternative.
</Note>
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ Then re-run the installer.

### Image push fails with out-of-memory errors

The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline, which buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer.
The sandbox image is approximately 2.4 GB compressed.
During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline.
The pipeline buffers decompressed layers in memory.
On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer.

If you cannot add memory, configure at least 8 GB of swap to work around the issue at the cost of slower performance.

Expand Down