Skip to content

docs: base images support Fedora/RHEL/Arch/Alpine (drop Debian-only restriction) - #313

Merged
beran-t merged 5 commits into
mainfrom
fix/multi-distro-base-image-docs
Aug 3, 2026
Merged

docs: base images support Fedora/RHEL/Arch/Alpine (drop Debian-only restriction)#313
beran-t merged 5 commits into
mainfrom
fix/multi-distro-base-image-docs

Conversation

@tomassrnka

@tomassrnka tomassrnka commented Jul 26, 2026

Copy link
Copy Markdown
Member

What

Corrects docs/template/base-image.mdx. It stated verbatim "E2B currently supports only Debian-based images … Alpine, RedHat-based … not supported" — now false.

  • Replaces the Debian-only Warning with an accurate supported-set Note: E2B identifies the distro from /etc/os-release and supports Debian/Ubuntu, Fedora + RHEL family (Rocky/AlmaLinux via ID_LIKE), Arch, Alpine. No-os-release images (scratch/distroless/pure nixos/nix) and minimal-repo images (UBI-minimal) are rejected with a clear error.
  • Adds fromFedoraImage/fromAlpineImage/fromArchImage (+ Python from_*_image) to the convenience-method examples.

Merge order — this PR must land after the SDK release

This is the last of three pieces:

  1. Engine — infra #3381 / #3411: distro-aware provisioning, verified booting Ubuntu/Fedora/Arch/Alpine on real KVM. Merged.
  2. SDK helpers — E2B #1612: adds the from*Image helpers these examples call. Merged, release pending (its changeset has not been consumed yet).
  3. Docs — this PR.

Hold until the SDK release ships. #1612 is merged but not yet published, so merging this first would document methods users cannot call from a released SDK.

The example versions (fedora:44, alpine:3.24) match the pinned SDK defaults. E2B #1625 brings the Python defaults in line with JS at those same tags, and they are the tags the orchestrator's distro build tests cover.

Note: the same text also exists in the private e2b-dev/docs-private mirror — worth syncing there too.

🤖 Generated with Claude Code

…Debian-only

The base-image page stated "E2B currently supports only Debian-based images …
Alpine, RedHat-based … not supported." That's no longer true — the orchestrator
now identifies the distro from /etc/os-release and provisions Debian/Ubuntu,
Fedora + RHEL family (Rocky/Alma via ID_LIKE), Arch, and Alpine (infra #3381,
proven on real KVM). Correct the restriction to an accurate supported-set note,
and add the new fromFedoraImage/fromAlpineImage/fromArchImage (and Python
from_*_image) convenience helpers to the examples (SDK: E2B #1612).

Images with no identifiable distro (no /etc/os-release: scratch/distroless/
pure nixos-nix) and minimal images missing required packages (UBI-minimal) are
called out as rejected-with-a-clear-error.
@cla-bot cla-bot Bot added the cla-signed label Jul 26, 2026
@cursor

cursor Bot commented Jul 26, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only change with no runtime or security impact.

Overview
docs/template/base-image.mdx no longer claims Debian-only support. It documents distro detection via /etc/os-release, lists supported families (Debian/Ubuntu, Fedora/RHEL, Arch, Alpine) and unsupported cases (no os-release, UBI-minimal), and replaces the old Warning with NixOS guidance pointing to e2bdev/nixos.

Predefined-image examples add fromFedoraImage, fromAlpineImage, and fromArchImage (and Python from_*_image equivalents). A new NixOS base image section explains why raw nixos/nix fails and how to use e2bdev/nixos.

Reviewed by Cursor Bugbot for commit 5c1bb32. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟢 Ready View Preview Jul 26, 2026, 8:12 PM

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit b73ffb9. Configure here.

Comment thread docs/template/base-image.mdx
@mintlify

mintlify Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟡 Building Jul 26, 2026, 8:10 PM

@tomassrnka
tomassrnka marked this pull request as draft July 27, 2026 07:33
@tomassrnka tomassrnka changed the title docs: base images support Fedora/RHEL/Arch/Alpine (drop Debian-only restriction) — FEAT-145 docs: base images support Fedora/RHEL/Arch/Alpine (drop Debian-only restriction) Jul 27, 2026
The SDK helpers pin fedora:44 and alpine:3.24; fedora:42 is end-of-life.
Add a NixOS base image subsection and reconcile the supported-distros
Note to point readers at the official e2bdev/nixos image instead of a
raw NixOS image.
Break the dense base-image note into scannable supported/not-supported
lists, drop em-dashes, and surface the NixOS guidance as a warning.
@beran-t
beran-t marked this pull request as ready for review August 3, 2026 09:14
@beran-t
beran-t merged commit 29af619 into main Aug 3, 2026
9 checks passed
@beran-t
beran-t deleted the fix/multi-distro-base-image-docs branch August 3, 2026 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants