Official Repository

Last pushed: 21 days ago
Short Description
Official build of Nginx.
Full Description

Supported tags and respective Dockerfile links

For more information about this image and its history, please see the relevant manifest file (library/nginx). 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/nginx/tag-details.md file in the docker-library/repo-info GitHub repo.

What is Nginx?

Nginx (pronounced "engine-x") is an open source reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer, HTTP cache, and a web server (origin server). The nginx project started with a strong focus on high concurrency, high performance and low memory usage. It is licensed under the 2-clause BSD-like license and it runs on Linux, BSD variants, Mac OS X, Solaris, AIX, HP-UX, as well as on other *nix flavors. It also has a proof of concept port for Microsoft Windows.

wikipedia.org/wiki/Nginx

How to use this image

hosting some simple static content

$ docker run --name some-nginx -v /some/content:/usr/share/nginx/html:ro -d nginx

Alternatively, a simple Dockerfile can be used to generate a new image that includes the necessary content (which is a much cleaner solution than the bind mount above):

FROM nginx
COPY static-html-directory /usr/share/nginx/html

Place this file in the same directory as your directory of content ("static-html-directory"), run docker build -t some-content-nginx ., then start your container:

$ docker run --name some-nginx -d some-content-nginx

exposing the port

$ docker run --name some-nginx -d -p 8080:80 some-content-nginx

Then you can hit http://localhost:8080 or http://host-ip:8080 in your browser.

complex configuration

$ docker run --name my-custom-nginx-container -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx

For information on the syntax of the Nginx configuration files, see the official documentation (specifically the Beginner's Guide).

If you wish to adapt the default configuration, use something like the following to copy it from a running Nginx container:

$ docker run --name tmp-nginx-container -d nginx
$ docker cp tmp-nginx-container:/etc/nginx/nginx.conf /host/path/nginx.conf
$ docker rm -f tmp-nginx-container

As above, this can also be accomplished more cleanly using a simple Dockerfile (in /host/path/):

FROM nginx
COPY nginx.conf /etc/nginx/nginx.conf

If you add a custom CMD in the Dockerfile, be sure to include -g daemon off; to CMD that Nginx stays in the foreground so that Docker can track the process properly (otherwise your container will stop immediately after starting)!

Then, build with docker build -t custom-nginx . and run:

$ docker run --name my-custom-nginx-container -d custom-nginx

using environment variables in nginx configuration

Out-of-the-box, Nginx doesn't support using environment variables inside most configuration blocks. But envsubst may be used as a workaround if you need to generate your nginx configuration dynamically before nginx starts.

Here is an example using docker-compose.yml:

  image: nginx
  volumes:
   - ./mysite.template:/etc/nginx/conf.d/mysite.template
  ports:
   - "8080:80"
  environment:
   - NGINX_HOST=foobar.com
   - NGINX_PORT=80
  command: /bin/bash -c "envsubst < /etc/nginx/conf.d/mysite.template > /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'"

The mysite.template file may then contain variable references like this :

listen ${NGINX_PORT};

Image Variants

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

nginx:<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.

nginx: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).

Supported Docker versions

This image is officially supported on Docker version 17.03.0-ce.

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 nginx/ 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 (84)
puja31
4 days ago

How to mount a folder.? I get below error

docker run --name my-nginx -d -p 80:80 -v ~/Users/Puja Dudhat/Dockers/nginx.conf:/etc/nginx/nginx.conf:ro -v ~/Users/Puja Dudhat/Dockers/src:/usr/share/nginx/html:ro nginx:1.10.1-alpine

Error: docker: Error parsing reference: "Dudhat/Dockers/nginx.conf:/etc/nginx/nginx.conf:ro" is not a valid repository/tag: invalid reference format.

chielsen
20 days ago

Since there is a in teh config that includes *.conf files:

include /etc/nginx/conf.d/*.conf

How can i mount a file only, since i get all these errors when i try to mount a file only and everybody says to only mount directories?
See:
https://forums.docker.com/t/docker-compose-host-path-error-with-nginx/27991/4
https://github.com/docker/compose/issues/4039

parris
2 months ago

@fpliu

It is because you are trying to mount a directory to "/etc/nginx/nginx.conf/". nginx.conf is a file, not a directory. I think your command should instead be:

sudo docker run -d -p 8080:80 -p 8081:443 -v ~/nginx/config/nginx.conf:/etc/nginx/nginx.conf -v ~/nginx/html:/usr/share/nginx/html/ -v ~/nginx/log/:/var/log/nginx/ --name nginx nginx

fpliu
2 months ago

sudo docker run -d -p 8080:80 -p 8081:443 -v ~/nginx/config/:/etc/nginx/nginx.conf/ -v ~/nginx/html:/usr/share/nginx/html/ -v ~/nginx/log/:/var/log/nginx/ --name nginx nginx

got follow error:

docker: Error response from daemon: oci runtime error: rootfs_linux.go:53: mounting "/var/lib/docker/aufs/mnt/a27c45f25d4bc50ee72f0b6f1075ebf8dae8ad71ecbeff65ef5b1022560f8840/etc/nginx/nginx.conf" to rootfs "/var/lib/docker/aufs/mnt/a27c45f25d4bc50ee72f0b6f1075ebf8dae8ad71ecbeff65ef5b1022560f8840" caused "not a directory"

why?

mahsa727
2 months ago

neda72
2 months ago

yealon
2 months ago

How to install nginx_ajp_moudle to this image ?