Bitnami Docker Image for NGINX Open Source
In order to unify the approaches followed for Bitnami containers and Bitnami Helm charts, we are moving the different bitnami/bitnami-docker-<container>
repositories to a single monorepo bitnami/containers
. Please follow bitnami/containers to keep you updated about the latest Bitnami images.
More information here: https://blog.bitnami.com/2022/07/new-source-of-truth-bitnami-containers.html
NGINX Open Source is a web server that can be also used as a reverse proxy, load balancer, and HTTP cache. Recommended for high-demanding sites due to its ability to provide faster content.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
$ docker run --name nginx bitnami/nginx:latest
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-nginx/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
DOCKER_CONTENT_TRUST=1
to verify the integrity of the images.Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami NGINX Open Source Chart GitHub repository.
Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
1.23
, 1.23-debian-11
, 1.23.1
, 1.23.1-debian-11-r2
, latest
(1.23/debian-11/Dockerfile)
1.22
, 1.22-debian-11
, 1.22.0
, 1.22.0-debian-11-r20
(1.22/debian-11/Dockerfile)
1.21
, 1.21-debian-11
, 1.21.6
, 1.21.6-debian-11-r20
(1.21/debian-11/Dockerfile)
The recommended way to get the Bitnami NGINX Open Source Docker Image is to pull the prebuilt image from the Docker Hub Registry.
$ docker pull bitnami/nginx:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
$ docker pull bitnami/nginx:[TAG]
If you wish, you can also build the image yourself.
$ docker build -t bitnami/nginx:latest 'https://github.com/bitnami/bitnami-docker-nginx.git#master:1.23/debian-11'
This NGINX Open Source image exposes a volume at /app
. Content mounted here is served by the default catch-all server block.
$ docker run -v /path/to/app:/app bitnami/nginx:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
nginx:
...
volumes:
- /path/to/app:/app
...
To access your web server from your host machine you can ask Docker to map a random port on your host to ports 8080
and 8443
exposed in the container.
$ docker run --name nginx -P bitnami/nginx:latest
Run docker port
to determine the random ports Docker assigned.
$ docker port nginx
8080/tcp -> 0.0.0.0:32769
You can also manually specify the ports you want forwarded from your host to the container.
$ docker run -p 9000:8080 bitnami/nginx:latest
Access your web server in the browser by navigating to http://localhost:9000
.
The default nginx.conf
includes server blocks placed in /opt/bitnami/nginx/conf/server_blocks/
. You can mount a my_server_block.conf
file containing your custom server block at this location.
For example, in order add a server block for www.example.com
:
my_server_block.conf
file with the following content.server {
listen 0.0.0.0:8080;
server_name www.example.com;
root /app;
index index.htm index.html;
}
$ docker run --name nginx \
-v /path/to/my_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_server_block.conf:ro \
bitnami/nginx:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
nginx:
...
volumes:
- /path/to/my_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_server_block.conf:ro
...
NOTE: The steps below assume that you are using a custom domain name and that you have already configured the custom domain name to point to your server.
In your local computer, create a folder called certs
and put your certificates files. Make sure you rename both files to server.crt
and server.key
respectively:
$ mkdir -p /path/to/nginx-persistence/certs
$ cp /path/to/certfile.crt /path/to/nginx-persistence/certs/server.crt
$ cp /path/to/keyfile.key /path/to/nginx-persistence/certs/server.key
Write your my_server_block.conf
file with the SSL configuration and the relative path to the certificates:
server {
listen 8443 ssl;
ssl_certificate bitnami/certs/server.crt;
ssl_certificate_key bitnami/certs/server.key;
ssl_session_cache shared:SSL:1m;
ssl_session_timeout 5m;
ssl_ciphers HIGH:!aNULL:!MD5;
ssl_prefer_server_ciphers on;
location / {
root html;
index index.html index.htm;
}
}
Run the NGINX Open Source image, mounting the certificates directory from your host.
$ docker run --name nginx \
-v /path/to/my_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_server_block.conf:ro \
-v /path/to/nginx-persistence/certs:/certs \
bitnami/nginx:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
nginx:
...
volumes:
- /path/to/nginx-persistence/certs:/certs
- /path/to/my_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_server_block.conf:ro
...
By default redirections issued by NGINX Open Source image will be relative. If you need to activate absolute redirections you can set NGINX_ENABLE_ABSOLUTE_REDIRECT
to yes
. You should pay attention to the port where the container is listening, because it won't appear in redirections unless you set also NGINX_ENABLE_PORT_IN_REDIRECT
to yes
.
In the following lines you can see different examples what explain how redirections work. All of them will assume that we have the following content in the server block my_redirect_server_block.conf
:
server {
listen 0.0.0.0:8080;
server_name www.example.com;
root /app;
index index.htm index.html;
location /test/ {
return 301 /index.html;
}
}
$ docker run --name nginx --rm -p 9000:8080 \
-v /path/to/my_redirect_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_redirect.conf:ro \
bitnami/nginx:latest
As mentioned, default redirections issued by NGINX Open Source image will be relative. The client should build the final URL
$ curl -kI http://localhost:9000/test/
HTTP/1.1 301 Moved Permanently
...
Location: /index.html
...
$ curl -w %{redirect_url}\\n -o /dev/null http://localhost:9000/test/
http://localhost:9000/index.html
Please keep in mind that some old clients could be not compatible with relative redirections.
$ docker run --name nginx --rm -p 9000:8080 \
-v /path/to/my_redirect_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_redirect.conf:ro \
-e NGINX_ENABLE_ABSOLUTE_REDIRECT=yes \
bitnami/nginx:latest
As result, the container will reply with a full URL in the Location
header but it doesn't have the port. This is useful if you are exposing the container in standard ports (80 or 443)
$ curl -kI http://localhost:9000/test/
HTTP/1.1 301 Moved Permanently
...
Location: http://localhost/index.html
...
$ docker run --name nginx --rm -p 9000:8080 \
-v /path/to/my_redirect_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_redirect.conf:ro \
-e NGINX_ENABLE_ABSOLUTE_REDIRECT=yes \
-e NGINX_ENABLE_PORT_IN_REDIRECT=yes \
bitnami/nginx:latest
In this case the container will include the port where it is listening to in redirections, not the port where it is exposed (in the example 8080
vs 9000
)
$ curl -kI http://localhost:9000/test/
HTTP/1.1 301 Moved Permanently
...
Location: http://localhost:8080/index.html
...
To amend this situation and build reachable URLs, you have to run the container listening in the same port that you are exposing
$ docker run --name nginx --rm -p 9000:9000 \
-v /path/to/my_redirect_server_block.conf:/opt/bitnami/nginx/conf/server_blocks/my_redirect.conf:ro \
-e NGINX_ENABLE_ABSOLUTE_REDIRECT=yes \
-e NGINX_ENABLE_PORT_IN_REDIRECT=yes \
-e NGINX_HTTP_PORT_NUMBER=9000
bitnami/nginx:latest
The image looks for configurations in /opt/bitnami/nginx/conf/nginx.conf
. You can overwrite the nginx.conf
file using your own custom configuration file.
$ docker run --name nginx \
-v /path/to/your_nginx.conf:/opt/bitnami/nginx/conf/nginx.conf:ro \
bitnami/nginx:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
nginx:
...
volumes:
- /path/to/your_nginx.conf:/opt/bitnami/nginx/conf/nginx.conf:ro
...
NGINX can be used to reverse proxy to other containers using Docker's linking system. This is particularly useful if you want to serve dynamic content through an NGINX frontend. To do so, add a server block like the following in the /opt/bitnami/nginx/conf/server_blocks/
folder:
server {
listen 0.0.0.0:8080;
server_name yourapp.com;
access_log /opt/bitnami/nginx/logs/yourapp_access.log;
error_log /opt/bitnami/nginx/logs/yourapp_error.log;
location / {
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header HOST $http_host;
proxy_set_header X-NginX-Proxy true;
proxy_pass http://[your_container_alias]:[your_container_port];
proxy_redirect off;
}
}
Further Reading:
The Bitnami NGINX Open Source Docker image sends the container logs to the stdout
. To view the logs:
$ docker logs nginx
or using Docker Compose:
$ docker-compose logs nginx
You can configure the containers logging driver using the --log-driver
option if you wish to consume the container logs differently. In the default configuration docker uses the json-file
driver.
The Bitnami NGINX Open Source Docker image is built using a Dockerfile with the structure below:
FROM bitnami/minideb
...
## Install required system packages and dependencies
RUN install_packages xxx yyy zzz
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "nginx" "a.b.c-0"
...
COPY rootfs /
RUN /opt/bitnami/scripts/nginx/postunpack.sh
...
ENV BITNAMI_APP_NAME="nginx" ...
EXPOSE 8080 8443
WORKDIR /app
USER 1001
...
ENTRYPOINT [ "/opt/bitnami/scripts/nginx/entrypoint.sh" ]
CMD [ "/opt/bitnami/scripts/nginx/run.sh" ]
The Dockerfile has several sections related to:
The Bitnami NGINX Open Source Docker image is designed to be extended so it can be used as the base image for your custom web applications.
Note: Read the previous section to understand the Dockerfile structure before extending this image.
Before extending this image, please note there are certain configuration settings you can modify using the original image:
NGINX_HTTP_PORT_NUMBER
.If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
FROM bitnami/nginx
### Put your customizations below
...
Here is an example of extending the image with the following modifications:
vim
editorFROM bitnami/nginx
### Change user to perform privileged actions
USER 0
### Install 'vim'
RUN install_packages vim
### Revert to the original non-root user
USER 1001
### Modify 'worker_connections' on NGINX config file to '512'
RUN sed -i -r "s#(\s+worker_connections\s+)[0-9]+;#\1512;#" /opt/bitnami/nginx/conf/nginx.conf
### Modify the ports used by NGINX by default
ENV NGINX_HTTP_PORT_NUMBER=8181 # It is also possible to change this environment variable at runtime
EXPOSE 8181 8143
### Modify the default container user
USER 1002
Based on the extended image, you can use a Docker Compose file like the one below to add other features:
version: '2'
services:
nginx:
build: .
ports:
- '80:8181'
- '443:8443'
depends_on:
- cloner
volumes:
- ./config/my_server_block.conf:/opt/bitnami/nginx/conf/conf.d/server_blocks/my_server_block.conf:ro
- ./certs:/certs
- data:/app
cloner:
image: 'bitnami/git:latest'
command:
- clone
- https://github.com/cloudacademy/static-website-example
- /app
volumes:
- data:/app
volumes:
data:
driver: local
To add a custom NGINX module, it is necessary to compile NGINX with that module and copy over the appropriate files to the Bitnami image.
Below is an example Dockerfile to build and install the NGINX Perl module (ngx_http_perl_module
) over to the Bitnami image:
ARG NGINX_VERSION=1.22.0
ARG BITNAMI_NGINX_REVISION=r0
ARG BITNAMI_NGINX_TAG=${NGINX_VERSION}-debian-11-${BITNAMI_NGINX_REVISION}
FROM bitnami/nginx:${BITNAMI_NGINX_TAG} AS builder
USER root
## Redeclare NGINX_VERSION so it can be used as a parameter inside this build stage
ARG NGINX_VERSION
## Install required packages and build dependencies
RUN install_packages dirmngr gpg gpg-agent curl build-essential libpcre3-dev zlib1g-dev libperl-dev
## Add trusted NGINX PGP key for tarball integrity verification
RUN gpg --keyserver pgp.mit.edu --recv-key 520A9993A1C052F8
## Download NGINX, verify integrity and extract
RUN cd /tmp && \
curl -O http://nginx.org/download/nginx-${NGINX_VERSION}.tar.gz && \
curl -O http://nginx.org/download/nginx-${NGINX_VERSION}.tar.gz.asc && \
gpg --verify nginx-${NGINX_VERSION}.tar.gz.asc nginx-${NGINX_VERSION}.tar.gz && \
tar xzf nginx-${NGINX_VERSION}.tar.gz
## Compile NGINX with desired module
RUN cd /tmp/nginx-${NGINX_VERSION} && \
rm -rf /opt/bitnami/nginx && \
./configure --prefix=/opt/bitnami/nginx --with-compat --with-http_perl_module=dynamic && \
make && \
make install
FROM bitnami/nginx:${BITNAMI_NGINX_TAG}
USER root
## Install ngx_http_perl_module system package dependencies
RUN install_packages libperl-dev
## Install ngx_http_perl_module files
COPY --from=builder /usr/local/lib/x86_64-linux-gnu/perl /usr/local/lib/x86_64-linux-gnu/perl
COPY --from=builder /opt/bitnami/nginx/modules/ngx_http_perl_module.so /opt/bitnami/nginx/modules/ngx_http_perl_module.so
## Enable module
RUN echo "load_module modules/ngx_http_perl_module.so;" | cat - /opt/bitnami/nginx/conf/nginx.conf > /tmp/nginx.conf && \
cp /tmp/nginx.conf /opt/bitnami/nginx/conf/nginx.conf
## Set the container to be run as a non-root user by default
USER 1001
Bitnami provides up-to-date versions of NGINX Open Source, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
$ docker pull bitnami/nginx:latest
or if you're using Docker Compose, update the value of the image property to
bitnami/nginx:latest
.
Stop the currently running container using the command
$ docker stop nginx
or using Docker Compose:
$ docker-compose stop nginx
$ docker rm -v nginx
or using Docker Compose:
$ docker-compose rm -v nginx
Re-create your container from the new image.
$ docker run --name nginx bitnami/nginx:latest
or using Docker Compose:
$ docker-compose up nginx
1.16.1-centos-7-r173
is considered the latest image based on CentOS./opt/bitnami/nginx/conf/vhosts
to /opt/bitnami/nginx/conf/server_blocks
. Remember to update your Docker Compose files to user the new mount point.NGINX Open Source's branch 1.21 is no longer maintained by upstream and is now internally tagged as to be deprecated. This branch will no longer be released in our catalog a month after this notice is published, but already released container images will still persist in the registries. Valid to be removed starting on: 07-22-2022
We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:
docker version
)docker info
Copyright © 2022 Bitnami
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.