Skip to content

docs: add instructions to upgrade npm #2579

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
+22 −0
Open

docs: add instructions to upgrade npm #2579

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
22 changes: 22 additions & 0 deletions docs/BestPractices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
## Table of Contents

- [Environment Variables](#environment-variables)
- [Upgrading npm](#upgrading-npm)
- [Global npm dependencies](#global-npm-dependencies)
- [Handling Kernel Signals](#handling-kernel-signals)
- [Non-root User](#non-root-user)
Expand All @@ -27,6 +28,25 @@ Run with `NODE_ENV` set to `production`. This is the way you would pass in secre
-e "NODE_ENV=production"
```

## Upgrading npm

Each `node` Docker image includes npm, bundled with Node.js.
You can check the version from the CLI, for example:

```shell
docker run --rm --entrypoint npm node:lts --version
```

The bundled npm version is also listed in the detail information on the
[Node.js Releases](https://nodejs.org/en/about/previous-releases) page.
If you need to upgrade (or downgrade) the version of npm,
add the following to your `Dockerfile`, replacing `<version>` with the desired value.
View the [npm registry listing](https://www.npmjs.com/package/npm?activeTab=versions) for available versions and tags.

```Dockerfile
RUN npm install --global npm@<version>
```

## Global npm dependencies

If you need to install global npm dependencies, it is recommended to place those dependencies in the [non-root user](#non-root-user) directory. To achieve this, add the following line to your `Dockerfile`
Expand All @@ -37,6 +57,8 @@ ENV NPM_CONFIG_PREFIX=/home/node/.npm-global
ENV PATH=$PATH:/home/node/.npm-global/bin # optionally if you want to run npm global bin without specifying path
```

This recommendation does not apply to npm itself, which is installed in `/usr/local/bin/npm`.

## Handling Kernel Signals

Node.js was not designed to run as PID 1 which leads to unexpected behaviour when running inside of Docker. For example, a Node.js process running as PID 1 will not respond to `SIGINT` (`CTRL-C`) and similar signals. As of Docker 1.13, you can use the `--init` flag to wrap your Node.js process with a [lightweight init system](https://github.com/krallin/tini) that properly handles running as PID 1.
Expand Down