Official Repository

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

Supported tags and respective Dockerfile links

Quick reference

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 external 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

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; in the CMD in order for nginx to stay in the foreground, so that Docker can track the process properly (otherwise your container will stop immediately after starting)!

Then build the image with docker build -t custom-nginx . and run it as follows:

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

Using environment variables in nginx configuration

Out-of-the-box, nginx doesn't support 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:

web:
  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};

Running nginx in debug mode

Images since version 1.9.8 come with nginx-debug binary that produces verbose output when using higher log levels. It can be used with simple CMD substitution:

$ docker run --name my-nginx -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx nginx-debug -g 'daemon off;'

Similar configuration in docker-compose.yml may look like this:

web:
  image: nginx
  volumes:
    - ./nginx.conf:/etc/nginx/nginx.conf:ro
  command: [nginx-debug, '-g', 'daemon off;']

Monitoring nginx with Amplify

Amplify is a free monitoring tool that can be used to monitor microservice architectures based on nginx. Amplify is developed and maintained by the company behind the nginx software.

With Amplify it is possible to collect and aggregate metrics across containers, and present a coherent set of visualizations of the key performance data, such as active connections or requests per second. It is also easy to quickly check for any performance degradations, traffic anomalies, and get a deeper insight into the nginx configuration in general.

In order to use Amplify, a small Python-based agent software (Amplify Agent) should be installed inside the container.

For more information about Amplify, please check the official documentation here.

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

Docker Pull Command

Comments (93)
danfercf
2 days ago

To the problem with -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro
You need to create the file /host/path/nginx.conf with the needed configuration

dadadaya
15 days ago

Using simple example for run container with my nginx.conf:

docker run --name my-nginx -p 80:80 \
    -v /www/go/conf/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx:1.13.1-alpine

not work!)

docker: Error response from daemon: oci runtime error: container_linux.go:247: starting container process caused "process_linux.go:359: container init caused \"rootfs_linux.go:54: mounting \"/www/go/conf/nginx.conf\" to rootfs \"/var/lib/docker/overlay2/63c2486afbca113127ad930354630cf617319666336b7e3a3e34000bc8c4d074/merged\" at \"/var/lib/docker/overlay2/63c2486afbca113127ad930354630cf617319666336b7e3a3e34000bc8c4d074/merged/etc/nginx/conf.d/default.conf\" caused \"not a directory\"\""
: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type.

WTF? but this is stupid simple operation?

marian
20 days ago

What's the problem here with the security issues in nginx:1-alpine? Why is there still the vulnerable zlib version 1.2.8-r2 included, if alpine has a package for version 1.2.11-r0?

ganapathi
a month ago

plg give me important informatio about nginx

viable
2 months ago

I'm having issues loading config that I've loaded on older version of nginx. So it seems this container is missing something, but I'm not sure what. Can anyone help me solve this error?

nginx: [emerg] invalid condition "~*" in /etc/nginx/conf.d/spider.conf

The line it doesn't like is this, but this isn't the only operator I get.

if ($http_user_agent ~* "360Spider|aiHitBot")
{ return 444; }

Anybody know what module I'm missing, or is this operator really not allowed anymore?

Thanks!

piyushgyrix
2 months ago

URL rewrite for Angular App is not working,

app-nginx.conf

server {
listen 80;
server_name my-app;

location / {
    root /usr/share/nginx/html;
    index index.html index.htm;
    expires -1;
    add_header Pragma "no-cache";
    add_header Cache-Control "no-store, no-cache, must-revalidate, post-check=0, pre-check=0";
    try_files $uri$args $uri$args/ $uri $uri/ /index.html =404;
}

}

Dockerfile
FROM nginx
MAINTAINER Piyush Ramavat
COPY ./docker/qb-nginx.conf /etc/nginx/conf.d/qb-nginx.conf
COPY ./ /usr/share/nginx/html

Please help, everything is working fine, but when Page is refreshed, 404 is thrown.

damlys
2 months ago

I had to add '$$NGINX_HOST $$NGINX_PORT $$NGINX_ROOT $$NGINX_INDEX' to work with environment variables.

command: /bin/bash -c "envsubst '$$NGINX_HOST $$NGINX_PORT $$NGINX_ROOT $$NGINX_INDEX' < /etc/nginx/conf.d/default.template > /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'"
frankborkin
2 months ago

Any chance of upgrading OpenSSL to 1.0.2+ in the mainline image? It means HTTP/2 won't work as there's no ALPN (Alpine works fine).

puja31
3 months 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.