Official Repository

Last pushed: 9 days ago
Short Description
Node.js is a JavaScript-based platform for server-side and networking applications.
Full Description

Supported tags and respective Dockerfile links

For more information about this image and its history, please see the relevant manifest file (library/node). This image is updated via pull requests to the docker-library/official-images GitHub repo.

For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the repos/node/tag-details.md file in the docker-library/repo-info GitHub repo.

What is Node.js?

Node.js is a software platform for scalable server-side and networking applications. Node.js applications are written in JavaScript and can be run within the Node.js runtime on Mac OS X, Windows, and Linux without changes.

Node.js applications are designed to maximize throughput and efficiency, using non-blocking I/O and asynchronous events. Node.js applications run single-threaded, although Node.js uses multiple threads for file and network events. Node.js is commonly used for real-time applications due to its asynchronous nature.

Node.js internally uses the Google V8 JavaScript engine to execute code; a large percentage of the basic modules are written in JavaScript. Node.js contains a built-in, asynchronous I/O library for file, socket, and HTTP communication. The HTTP and socket support allows Node.js to act as a web server without additional software such as Apache.

wikipedia.org/wiki/Node.js

How to use this image

Create a Dockerfile in your Node.js app project

FROM node:4-onbuild
# 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

Notes

The image assumes that your application has a file named package.json listing its dependencies and defining its start script.

Run a single Node.js script

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:4 node your-daemon-or-script.js

Image Variants

The node images come in many flavors, each designed for a specific use case.

node:<version>

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-deps. buildpack-deps is 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.

node:alpine

This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

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.

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 for examples of how to install packages if you are unfamiliar).

node:onbuild

This image makes building derivative images easier. For most use cases, creating a Dockerfile in the base of your project directory with the line FROM node:onbuild will be enough to create a stand-alone image for your project.

While the onbuild variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over when the ONBUILD triggers fire (see also docker/docker#5714, docker/docker#8240, docker/docker#11917).

Once you've got a handle on how your project functions within Docker, you'll probably want to adjust your Dockerfile to inherit from a non-onbuild variant and copy the commands from the onbuild variant Dockerfile (moving the ONBUILD lines to the end and removing the ONBUILD keywords) into your own file so that you have tighter control over them and more transparency for yourself and others looking at your Dockerfile as to what it does. This also makes it easier to add additional requirements as time goes on (such as installing more packages before performing the previously-ONBUILD steps).

node:slim

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 image will be deployed and you have space constraints, we highly recommend using the default image of this repository.

License

View license information for the software contained in this image.

Supported Docker versions

This image is officially supported on Docker version 1.13.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.

User Feedback

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue. If the issue is related to a CVE, please check for a cve-tracker issue on the official-images repository first.

You can also reach many of the official image maintainers via the #docker-library IRC channel on Freenode.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Documentation

Documentation for this image is stored in the node/ directory of the docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository's README.md file before attempting a pull request.

Docker Pull Command

Comments (53)
rosadoft
a month ago

Why add an user? having permission issues all over the place...

chorrell
8 months ago

Hi all,

I'm one of the maintainers for the Docker Node.js.

We're not able to monitor comments here due to limitations in the comment system. Chances are if you comment here we probably won't see it for a long time.

If you have an issue with the image, or a question, you can file an issue on GitHub here:

https://github.com/nodejs/docker-node/issues

Thanks,

otassel
9 months ago

Hi,

Any ETA for an Alpine Linux image ?

chorrell
10 months ago

Hi all,

I'm one of the maintainers for the Docker Node.js.

We're not able to monitor comments here due to limitations in the comment system. Chances are if you comment here we probably won't see it for a long time.

If you have an issue with the image, or a question, you can file an issue on GitHub here:

https://github.com/nodejs/docker-node/issues

Thanks,

geshan
10 months ago

Having images with alpine base would be great.

chorrell
10 months ago

Hi all,

I'm one of the maintainers for the Docker Node.js.

We're not able to monitor comments here due to limitations in the comment system. Chances are if you comment here we probably won't see it for a long time.

If you have an issue with the image, or a question, you can file an issue on GitHub here:

https://github.com/nodejs/docker-node/issues

Thanks,

soledadvac
a year ago

刚安好docker...嘿嘿

tjaart
a year ago

Anyone know if it is possible to require private npm packages?

I was hoping the following entry in my Dockerfile would work:
ENV NPM_TOKEN="xxxxxxxxxxxxxxxxx"

But so far no luck.

matiasdecarli
a year ago

Im having this issue for a while now

https://github.com/npm/npm/issues/10656

Anyone have the same?

starefossen
a year ago

@sportinum: argon is the current LTS tag. Having a general lts tag will break whenever there is a new LTS version which means that you can not use the lts tag for production- it would be just as reckless as using the latest tag for production applications.

Feel free to join the discussion here: https://github.com/nodejs/docker-node/issues/104