Skip to content

docs: clarify Debian/Ubuntu requirement for custom template builds (fixes #1280) #2488

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
AdaAibaby wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify Debian/Ubuntu requirement for custom template builds (fixes #1280) #2488

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65a4958
docs: note Debian-only requirement for custom template builds
adababys Apr 23, 2026
0b75cb3
Merge branch 'main' into docs/debian-only-template-note
AdaAibaby Apr 23, 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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ Supported cloud providers:
- 🟢 AWS (Beta)
- [ ] Azure
- [ ] General linux machine

## Limitations

- Custom template builds require Debian/Ubuntu-based base images (images that provide the apt package manager). Non-Debian images such as Alpine, CentOS/RHEL, or other distributions without apt are not supported and will fail during the template build/provisioning process. See [docs/limitations.md](docs/limitations.md) for details and suggested PR wording.

23 changes: 23 additions & 0 deletions docs/limitations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Custom template build: Debian/Ubuntu-only base images
===================================================

Summary
-------

E2B currently requires that base images used for custom template builds are Debian/Ubuntu-based and provide the `apt` package manager. The template build and provisioning scripts assume Debian package manager behavior and Debian-style filesystem layouts; using images without `apt` (for example, Alpine, CentOS, RHEL, or other non-Debian distributions) will cause the build to fail.

Why this limitation exists
-------------------------

- The provisioning scripts used during template build call `apt` and expect Debian-specific package names and file locations.
- Debian/Ubuntu images use a filesystem layout and package tooling the scripts rely upon.

Workarounds and contribution
---------------------------

There is no known workaround at the moment. If you need non-Debian support, please open an issue describing the use case or submit a PR that updates the provisioning scripts to support alternative package managers (e.g., `apk`, `yum`, `dnf`) and corresponding filesystem differences.

Suggested PR wording
--------------------

Add a short note in the docs: "Custom template builds require Debian/Ubuntu-based base images (apt). Non-Debian images (Alpine, CentOS/RHEL, etc.) are not supported and will fail during the build process. Contributions to add non-Debian support are welcome; please open an issue or PR."
Loading