Skip to content

docs(BestPractices): multi-architecture images and the wrong-arch node_modules trap #2636

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
happy520ai wants to merge 2 commits into from
Closed

docs(BestPractices): multi-architecture images and the wrong-arch node_modules trap #2636

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a57404
docs(BestPractices): warn that one node_modules tree cannot serve two…
happy520ai Sep 29, 2026
98a01a7
docs(BestPractices): move the warning into the node-gyp section, as r…
happy520ai Sep 29, 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
7 changes: 7 additions & 0 deletions docs/BestPractices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,13 @@ FROM node:alpine as app
COPY --from=builder node_modules .
```

Note that this multistage pattern only produces a tree that works on the architecture the builder ran on.
Native addons are compiled or downloaded for that host, so `COPY --from=builder node_modules .` into a stage
built for a different architecture puts a mismatched binary in the image while the manifest still looks
correct, and the first `require()` of it fails with `invalid ELF header`. Under
`docker buildx build --platform linux/amd64,linux/arm64`, install or `npm rebuild` inside each platform's
stage instead of sharing one tree between them.

## Smaller images without npm/yarn

To remove npm and Yarn package managers, use a multi-stage build.
Expand Down
Loading