Skip to content

Commit de89ef4

Browse files
committed
docs(release): clarify linux libc requirements
1 parent 357ebd6 commit de89ef4

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

architecture/build.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ OpenShell builds these main artifacts:
2020

2121
Sandbox community images are built outside this repository.
2222

23+
## Linux Runtime Environments
24+
25+
OpenShell uses different Linux libc environments for different host artifacts.
26+
The standalone `openshell` CLI is built as a static musl binary so it can run on
27+
a wide range of Linux distributions without depending on the host's glibc. Host
28+
runtime binaries that use the GNU/Linux runtime environment, including
29+
`openshell-gateway` and `openshell-driver-vm`, are GNU-linked and built with a
30+
glibc 2.31 floor.
31+
2332
## Container Builds
2433

2534
The Docker image pipeline is a two-step flow: build the Rust binary natively

docs/reference/support-matrix.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ OpenShell publishes multi-architecture gateway images for `linux/amd64` and `lin
1919
| macOS (Docker Desktop) | Apple Silicon (arm64) | Supported |
2020
| Windows (WSL 2 + Docker Desktop) | x86_64 | Experimental |
2121

22+
On Linux, the `openshell` CLI is a static musl binary and does not require glibc at runtime.
23+
2224
## Standalone Gateway Binary
2325

2426
OpenShell publishes standalone `openshell-gateway` release assets for manual download on these platforms:
@@ -31,7 +33,7 @@ OpenShell publishes standalone `openshell-gateway` release assets for manual dow
3133

3234
These artifacts are attached to GitHub releases. Kubernetes deployments should use the Helm chart and the published gateway image.
3335

34-
Linux package installs and standalone GNU gateway artifacts require glibc 2.31 or newer. This supports Ubuntu 20.04 and later, Ubuntu 22.04, RHEL 9-compatible distributions, and Amazon Linux 2023.
36+
On Linux, `openshell-gateway` requires glibc 2.31 or newer. Compatible systems include, for example, Ubuntu 20.04+, RHEL 9+, Amazon Linux 2023+, and Fedora 32+.
3537

3638
## Compute Drivers
3739

0 commit comments

Comments
 (0)