Skip to content

Commit ad13f83

Browse files
committed
docs: update Alpine musl descriptions
1 parent 9c26dbe commit ad13f83

1 file changed

Lines changed: 9 additions & 17 deletions

File tree

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -179,23 +179,15 @@ This image is based on the popular
179179
much smaller than most distribution base images (~5MB), and thus leads to much
180180
slimmer images in general.
181181

182-
This variant is highly recommended when final image size being as small as
183-
possible is desired. The main caveat to note is that it does use
184-
[musl libc](https://musl.libc.org/) instead of
185-
[glibc and friends](https://www.etalabs.net/compare_libcs.html), so certain
186-
software might run into issues depending on the depth of their libc
187-
requirements. However, most software doesn't have an issue with this, so this
188-
variant is usually a very safe choice. See
189-
[this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897)
190-
for more discussion of the issues that might arise and some pro/con comparisons
191-
of using Alpine-based images.
192-
193-
One common issue that may arise is a missing shared library required for use of
194-
`process.dlopen`. To add the missing shared libraries to your image:
195-
196-
- Starting from Alpine v3.19, you can use the
197-
[`gcompat`](https://pkgs.alpinelinux.org/package/v3.19/main/x86/gcompat) package
198-
to add the missing shared libraries: `apk add --no-cache gcompat`
182+
Alpine images use the C library
183+
[musl libc](https://musl.libc.org/), not the GNU C library
184+
[glibc](https://sourceware.org/glibc/) used by Debian.
185+
186+
Generally, applications written for Debian (`glibc`) will not run under Alpine (`musl`).
187+
Some compatibility issues may be resolvable by installing the Alpine
188+
[`gcompat`](https://pkgs.alpinelinux.org/package/v3.23/main/x86/gcompat)
189+
GNU C Library compatibility layer for musl package.
190+
Use `apk add --no-cache gcompat` to install.
199191

200192
To minimize image size, it's uncommon for additional related tools
201193
(such as `git` or `bash`) to be included in Alpine-based images. Using this

0 commit comments

Comments
 (0)