Skip to content

Commit

Permalink
Updated README.md to include information about windoservercore images.
Browse files Browse the repository at this point in the history
  • Loading branch information
zZHorizonZz committed Sep 9, 2024
1 parent dbe54a6 commit 2f3e7c9
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The official Node.js docker image, made with love by the node community.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

## Table of Contents

- [What is Node.js?](#what-is-nodejs)
Expand All @@ -26,6 +27,7 @@ The official Node.js docker image, made with love by the node community.
- [`node:bullseye`](#nodebullseye)
- [`node:bookworm`](#nodebookworm)
- [`node:slim`](#nodeslim)
- [`node:windowsservercore-ltsc<2019|2022>`](#nodewindowsservercore-ltsc20192022)
- [License](#license)
- [Supported Docker versions](#supported-docker-versions)
- [Supported Node.js versions](#supported-nodejs-versions)
Expand Down Expand Up @@ -112,7 +114,8 @@ $ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/sr

Prior to 8.7.0 and 6.11.4, the docker images overrode the default npm log
level from `warn` to `info`. However, due to improvements to npm and new Docker
patterns (e.g. multi-stage builds) the working group reached a [consensus](https://github.com/nodejs/docker-node/issues/528)
patterns (e.g. multi-stage builds) the working group reached
a [consensus](https://github.com/nodejs/docker-node/issues/528)
to revert the log level to npm defaults. If you need more verbose output, please
use one of the following methods to change the verbosity level.

Expand Down Expand Up @@ -189,20 +192,21 @@ One common issue that may arise is a missing shared library required for use of
`process.dlopen`. To add the missing shared libraries to your image:

- For Alpine v3.18 and earlier, adding the
[`libc6-compat`](https://pkgs.alpinelinux.org/package/v3.18/main/x86/libc6-compat)
package in your Dockerfile is recommended: `apk add --no-cache libc6-compat`
[`libc6-compat`](https://pkgs.alpinelinux.org/package/v3.18/main/x86/libc6-compat)
package in your Dockerfile is recommended: `apk add --no-cache libc6-compat`

- Starting from Alpine v3.19, you can use the
[`gcompat`](https://pkgs.alpinelinux.org/package/v3.19/main/x86/gcompat) package
to add the missing shared libraries: `apk add --no-cache gcompat`
[`gcompat`](https://pkgs.alpinelinux.org/package/v3.19/main/x86/gcompat) package
to add the missing shared libraries: `apk add --no-cache gcompat`

To minimize image size, it's uncommon for additional related tools
(such as `git` or `bash`) to be included in Alpine-based images. Using this
image as a base, add the things you need in your own Dockerfile
(see the [`alpine` image description](https://hub.docker.com/_/alpine/) for
examples of how to install packages if you are unfamiliar).

To make the image size even smaller, you can [bundle without npm/yarn](./docs/BestPractices.md#smaller-images-without-npmyarn).
To make the image size even smaller, you
can [bundle without npm/yarn](./docs/BestPractices.md#smaller-images-without-npmyarn).

### `node:bullseye`

Expand All @@ -224,6 +228,16 @@ in an environment where *only* the Node.js image will be deployed and you have
space constraints, we highly recommend using the default image of this
repository.

### `node:windowsservercore-ltsc<2019|2022>`

This image is based on Windows Server Core and is the recommended image
for users who require Windows-based environments.
It is available in two versions:`node:windowsservercore-ltsc2019` and `node:windowsservercore-ltsc2022`.
You can run this image on Windows Server 2019 or Windows Server 2022 or on Windows desktop versions
that support Windows containers.
Keep in mind that these images are significantly larger than the Linux-based
variants due to the Windows Server Core base.

## License

[License information](https://github.com/nodejs/node/blob/master/LICENSE) for
Expand All @@ -242,7 +256,8 @@ upgrade your Docker daemon.

## Supported Node.js 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).
This project will support Node.js versions as still under active support as per
the [Node.js release schedule](https://github.com/nodejs/Release).

## Governance and Current Members

Expand Down

0 comments on commit 2f3e7c9

Please sign in to comment.