openresty/openresty

https://github.com/openresty/docker-openresty

https://github.com/openresty/docker-openresty/blob/master/README.md

https://github.com/openresty/docker-openresty/blob/master/BUILDING.md

docker-openresty - Docker tooling for OpenResty

![Travis Status]([] ![Appveyor status]([]

docker-openresty is Docker tooling for OpenResty ([***]

Docker is a container management platform. OpenResty is a full-fledged web application server by bundling the standard nginx core, lots of 3rd-party nginx modules, as well as most of their external dependencies.

Thank you to Travis CI for donating their build infrastructure to this project for over seven years!

We provide a series of pre-built images for various operating systems. Some are built-from the upstream OpenResty pre-built images and some are built from source.

You can learn more about building your own custom and derived images in BUILDING.md.

---

Table of Contents

• OpenResty Image Tags
• Table of Contents
• Usage
• Policies
• Nginx Config Files
• Image Labels
• Docker CMD
• Feedback & Bug Reports
• Changelog & Authors
• Copyright & License

---

OpenResty Image Tags

It is best practice to pin your images to an explicit image tag. The next section below covers the conventions in detail, but here are some common examples:

These are examples of untagged image names, for reference:

There are also specific tags for Debug and Valgrind OpenResty variants:

As of 1.27.1.2-1, we also mirror to the GitHub Container Registry. Simply prefix the registry path with ghcr.io/:

• ghcr.io/openresty/openresty:1.27.1.2-1-bullseye

---

Usage

If you are happy with the build defaults, then you can use the openresty image from the https://hub.docker.com/r/openresty/openresty/. The image tags available there are listed at the top of this README.

docker run [options] openresty/openresty:bullseye-fat

[options] would be things like -p to map ports, -v to map volumes, and -d to daemonize.

docker-openresty symlinks /usr/local/openresty/nginx/logs/access.log and error.log to /dev/stdout and /dev/stderr respectively, so that Docker logging works correctly. If you change the log paths in your nginx.conf, you should symlink those paths as well. This is not possible with the windows image.

Temporary directories such as client_body_temp_path are stored in /var/run/openresty/. You may *** mounting that volume, rather than writing to a container-local directory. This is not done for windows.

Supported tags and respective Dockerfile links

The following "flavors" are available and built from upstream OpenResty packages:

• https://github.com/openresty/docker-openresty/blob/master/alpine-apk/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/centos/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/bookworm/Dockerfile.buildpack
• https://github.com/openresty/docker-openresty/blob/master/bookworm/Dockerfile.fat
• https://github.com/openresty/docker-openresty/blob/master/bookworm/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/bullseye/Dockerfile.fat
• https://github.com/openresty/docker-openresty/blob/master/bullseye/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/centos/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/centos7/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/fedora/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/fedora/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/windows/Dockerfile

The following "flavors" are built from source and are intended for more advanced and custom usage, caveat emptor:

• https://github.com/openresty/docker-openresty/blob/master/alpine/Dockerfile.fat
• https://github.com/openresty/docker-openresty/blob/master/alpine/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/alpine/Dockerfile, stripped Alpine image)
• https://github.com/openresty/docker-openresty/blob/master/bionic/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/focal/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/jammy/Dockerfile
• https://github.com/openresty/docker-openresty/blob/master/noble/Dockerfile

The openresty/openresty:latest tag points to the latest bookworm image.

Since 1.19.3.2-1, all flavors support multi-architecture builds, both amd64 and aarch64. Since 1.21.4.1-1, the s390x architecture is supported for build-from-source Ubuntu flavors (like jammy); prior to version 1.27.1.2-3, https://github.com/zherczeg/sljit/issues/89 is disabled for s390x.

Releases are tagged with <openresty-version>-<image-version>-<flavor>. The latest image-version will also be tagged <openresty-version>-<flavor>. The HEAD of the master branch is also labeled plainly as <flavor>. The builds are managed by Travis-CI and Appveyor (for Windows images).

There are architecture-specific tags as well, <openresty-version>-<image-version>-<flavor>-<arch>, but one would generally pull from the multi-architecture name above.

It is highly recommended that you use the upstream-based images for best support. For best stability, pin your images to the full tag, for example 1.21.4.1-0-bionic.

-fat images are ones that have LuaRocks and OPM installed in them. -buildpack images are based on https://hub.docker.com/_/buildpack-deps#what-is-buildpack-deps; they might be useful when more build scaffolding is required in your application.

Policies

The Maintainers of this OpenResty Docker Tooling operate under the following policies:

• We track OpenResty releases for build-from-upstream and will continue to add new upstream releases:

  • https://github.com/openresty/docker-openresty/blob/master/alpine-apk/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/centos/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/bullseye/Dockerfile.fat
  • https://github.com/openresty/docker-openresty/blob/master/bullseye/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/centos/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/centos7/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/fedora/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/fedora/Dockerfile
  • https://github.com/openresty/docker-openresty/blob/master/windows/Dockerfile

• We track build-from-source images as follows:

  • Alpine stable
  • Ubuntu "LTS"

• We try to include popular architectures (x86_64, aarch64, s390x)

• RC versions of upstream releases will be made available on tags

• If an image fails CI/CD too much, we will remove it.

• We operate in English and PRs must be English as well, unless for localization purposes.

• We will accept issues in any language. We will provide our translations to English for clarity.

• All are welcome to particpate, but must show mutual respect to the community.

Nginx Config Files

The Docker tooling installs its own https://github.com/openresty/docker-openresty/blob/master/nginx.conf. If you want to directly override it, you can replace it in your own Dockerfile or via volume bind-mounting.

For the Linux images, that nginx.conf has the directive include /etc/nginx/conf.d/*.conf; so all nginx configurations in that directory will be included. The https://github.com/openresty/docker-openresty/blob/master/nginx.vh.default.conf has the original OpenResty configuration and is copied to /etc/nginx/conf.d/default.conf.

Since 1.25.3.2-2, the nginx.conf also contains include /etc/nginx/conf.d/*.main; at the main stanza level (rather than the http level of *.conf). stream and other main level directives can be included there; see https://github.com/openresty/docker-openresty/issues/257 for an example.

You can override that default.conf directly or volume bind-mount the /etc/nginx/conf.d directory to your own set of configurations:

docker run -v /my/custom/conf.d:/etc/nginx/conf.d openresty/openresty:alpine

If you are running on an selinux host (e.g. CentOS), you may need to add :Z to your volume bind-mount argument:

docker run -v /my/custom/conf.d:/etc/nginx/conf.d:Z openresty/openresty:alpine

When using the windows image you can change the main configuration directly:

docker run -v C:/my/custom/nginx.conf:C:/openresty/conf/nginx.conf openresty/openresty:windows

Image Labels

The image builds are labeled with various information, such as the versions of OpenResty and its dependent libraries. Here's an example of printing the labels using jq:

$ docker pull openresty/openresty:1.17.8.1-0-bionic
$ docker inspect openresty/openresty:1.17.8.1-0-bionic | jq '.[].Config.Labels'

Docker CMD

The -g "daemon off;" directive is used in the Dockerfile CMD to keep the Nginx daemon running after container creation. If this directive is added to the nginx.conf, then the docker run should explicitly invoke openresty (or nginx for windows images):

docker run [options] openresty/openresty:bionic openresty

Invoke another CMD, for example the resty utility, like so:

docker run [options] openresty/openresty:bionic resty [script.lua]

NOTE The alpine images do not include the packages perl and ncurses, which is needed by the resty utility.

Feedback & Bug Reports

You're very welcome to report bugs and give feedback as GitHub Issues:

https://github.com/openresty/docker-openresty/issues

Back to TOC

Changelog & Authors

• https://github.com/openresty/docker-openresty/blob/master/CHANGELOG.md
• https://github.com/openresty/docker-openresty/blob/master/AUTHORS.md

Back to TOC

Copyright & License

docker-openresty is licensed under the 2-clause BSD license.

Copyright (c) 2017-2024, Evan Wies <***>.

This module is licensed under the terms of the BSD license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC