Skip to content

Commit 2f3e7c9

Browse files
committed
Updated README.md to include information about windoservercore images.
1 parent dbe54a6 commit 2f3e7c9

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.md

+22-7
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The official Node.js docker image, made with love by the node community.
99

1010
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1111
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
12+
1213
## Table of Contents
1314

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

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

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

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

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

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

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

207211
### `node:bullseye`
208212

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

231+
### `node:windowsservercore-ltsc<2019|2022>`
232+
233+
This image is based on Windows Server Core and is the recommended image
234+
for users who require Windows-based environments.
235+
It is available in two versions:`node:windowsservercore-ltsc2019` and `node:windowsservercore-ltsc2022`.
236+
You can run this image on Windows Server 2019 or Windows Server 2022 or on Windows desktop versions
237+
that support Windows containers.
238+
Keep in mind that these images are significantly larger than the Linux-based
239+
variants due to the Windows Server Core base.
240+
227241
## License
228242

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

243257
## Supported Node.js versions
244258

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

247262
## Governance and Current Members
248263

0 commit comments

Comments
 (0)