Official Docker Image for Node.js :whale: :turtle: :rocket:
The official Node.js docker image, made with love by the node community.
Dockerfilein your Node.js app project
# specify the node base image with your desired version node: FROM node:10 # replace this with your application's default port EXPOSE 8888
You can then build and run the Docker image:
$ docker build -t my-nodejs-app . $ docker run -it --rm --name my-running-app my-nodejs-app
If you prefer Docker Compose:
version: "2" services: node: image: "node:8" user: "node" working_dir: /home/node/app environment: - NODE_ENV=production volumes: - ./:/home/node/app expose: - "8081" command: "npm start"
You can then run using Docker Compose:
$ docker-compose up -dstart script.
We have assembled a Best Practices Guide for those using these images on a daily basis.
For many simple, single file projects, you may find it inconvenient to write a complete
Dockerfile. In such cases, you can run a Node.js script by using the Node.js Docker image directly:
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app node:8 node your-daemon-or-script.js
Prior to 8.7.0 and 6.11.4 the docker images overrode the default npm log level from
info. However due to improvements to npm and new Docker patterns (e.g. multi-stage builds) the working group reached a consensus 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.
If you create your own
Dockerfilewhich inherits from the
nodeimage you can simply use
FROM node ENV NPM_CONFIG_LOGLEVEL info ...
If you run the node image using
docker runyou can use the
-eflag to override
$ docker run -e NPM_CONFIG_LOGLEVEL=info node ...
If you are running npm commands you can use
--loglevelto control the verbosity of the output.
$ docker run node npm --loglevel=warn ...
nodeimages come in many flavors, each designed for a specific use case. All of the images contain pre-installed versions of
yarn. For each supported architecture, the supported variants are different. In the file: versions.json, it lists all supported variants for all of the architectures that we support now.
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of. This tag is based off of
buildpack-depsis designed for the average user of docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system.
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images. 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, adding the
libc6-compatpackage in your Dockerfile is recommended:
apk add --no-cache libc6-compat
To minimize image size, it's uncommon for additional related tools (such as
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
alpineimage description for examples of how to install packages if you are unfamiliar).
This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run
node. Unless you are working 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.
This image is officially supported on Docker version 1.9.1.
Support for older versions (down to 1.6) is provided on a best-effort basis.
Please see the Docker installation documentation for details on how to upgrade your Docker daemon.
This project will support Node.js versions as still under active support as per the Node.js release schedule.
The Node.js Docker Image is governed by the Docker Working Group. See GOVERNANCE.md to learn more about the group's structure and CONTRIBUTING.md for guidance about the expectations for all contributors to this project.