Skip to content

docs: add supported architectures section #2498

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
MikeMcC399 wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

docs: add supported architectures section #2498

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The official Node.js docker image, made with love by the node community.
- [License](#license)
- [Supported Docker versions](#supported-docker-versions)
- [Supported Node.js versions](#supported-nodejs-versions)
- [Supported architectures](#supported-architectures)
- [musl builds for Alpine](#musl-builds-for-alpine)
- [Yarn v1 Classic bundling](#yarn-v1-classic-bundling)
- [Governance and Current Members](#governance-and-current-members)
- [Docker Maintainers](#docker-maintainers)
Expand Down Expand Up @@ -268,6 +270,23 @@ for current Engine versions.

This project will support Node.js versions as still under active support as per the [Node.js release schedule](https://github.com/nodejs/Release).

## Supported architectures

`node` images are built for the Linux operating system and architecture combinations defined in [versions.json](https://github.com/nodejs/docker-node/blob/main/versions.json).

- The [Node.js Platform list](https://github.com/nodejs/node/blob/main/BUILDING.md#official-binary-platforms-and-toolchains) defines [Support Tiers](https://github.com/nodejs/node/blob/main/BUILDING.md#strategy) 1, 2 and Experimental for platform and architecture combinations of Node.js builds and for each separate Node.js release line
- The [Docker official images library](https://github.com/docker-library/official-images#architectures-other-than-amd64) lists the supported architectures in the Docker build environment

Each of the architectures for Debian images belong to the Node.js support tier 1 or 2, recommended for production applications.

### musl builds for Alpine

`musl` builds for `amd64` are listed under support tier "Experimental" and are tested by the Node.js build process before being used in Docker images. "Experimental" status for Node.js is defined as:

> Experimental: May not compile or test suite may not pass. The core team does not create releases for these platforms. Test failures on experimental platforms do not block releases. Contributions to improve support for these platforms are welcome.

`musl` builds for other architectures, including `arm64`, are not rigorously tested before release.

## Yarn v1 Classic bundling

The [Yarn v1 Classic](https://classic.yarnpkg.com/) package manager is bundled in `node` image
Expand Down