number5 / docker-openresty

Docker tooling for OpenResty

docker-openresty - Docker tooling for OpenResty

Supported tags and respective Dockerfile links

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

• centos, centos-rpm, (centos/Dockerfile)
• stretch, (stretch/Dockerfile)
• stretch-fat, (stretch/Dockerfile.fat)
• windows, (windows/Dockerfile)

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

• alpine, (alpine/Dockerfile)
• alpine-fat, (alpine/Dockerfile.fat)
• xenial, (xenial/Dockerfile)

Starting with 1.13.6.1, 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).

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.13.6.2-0-xenial.

Table of Contents

• Description
• Usage
• OPM
• LuaRocks
• Tips & Pitfalls
• Docker CMD
• Building (from source)
• Building (RPM based)
• Building (DEB based)
• Building (Windows based)
• Feedback & Bug Reports
• Changelog & Authors
• Copyright & License

Description

docker-openresty is Docker tooling for OpenResty (https://www.openresty.org).

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.

From non-RPM/DEB flavors, the following modules are included by default, but one can easily increase or decrease that with custom build options :

• file-aio
• http_addition_module
• http_auth_request_module
• http_dav_module
• http_flv_module
• http_geoip_module=dynamic
• http_gunzip_module
• http_gzip_static_module
• http_image_filter_module=dynamic
• http_mp4_module
• http_random_index_module
• http_realip_module
• http_secure_link_module
• http_slice_module
• http_ssl_module
• http_stub_status_module
• http_sub_module
• http_v2_module
• http_xslt_module=dynamic
• ipv6
• mail
• mail_ssl_module
• md5-asm
• pcre-jit
• sha1-asm
• stream
• stream_ssl_module
• threads

Usage

If you are happy with the build defaults, then you can use the openresty image from the Docker Hub. The image tags available there are listed at the top of this README.

docker run [options] openresty/openresty:stetch-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.

nginx config files

The Docker tooling installs its own nginx.conf file. 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 default virtual host configuration has the original OpenResty configuration and is copied to /etc/nginx/conf.d/default.conf.

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

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

OPM

Starting at version 1.11.2.2, OpenResty for Linux includes a package manager called opm, which can be found at /usr/local/openresty/bin/opm.

opm is built in all the images except alpine and stretch.

To use opm in the alpine image, you must also install the curl and perl packages; they are not included by default because they double the image size. You may install them like so: apk add --no-cache curl perl.

To use opm within the stretch image, you can either use the stretch-fat image or install the openresty-opm package in a custom build (which you would need to do to install your own opm packages anyway), as shown in this example.

LuaRocks

LuaRocks is included in the alpine-fat, centos, and xenial variants. It is excluded from alpine because it generally requires a build system and we want to keep that variant lean.

It is available at /usr/local/openresty/luajit/bin/luarocks. Packages can be added in your dependent Dockerfiles like so:

RUN /usr/local/openresty/luajit/bin/luarocks install <rock>

Tips & Pitfalls

• The envsubst utility is included in all images except alpine and windows; this utility is also included in the Nginx docker image and is used to template environment variables into configuration files.

• Docker Hub does not currently support ARM builds, thus an armhf-xenial image is not available (See #26). You can build an image yourself using the RESTY_DEBIAN_BASE build argument:

docker build -f xenial/Dockerfile --build-arg "RESTY_DEBIAN_BASE=armv7/armhf-ubuntu" .

• By default, OpenResty is built with SSE4.2 optimizations if the build machine supports it. If run on machine without SSE4.2, there will be invalid opcode issues. Thus all the Docker Hub images require SSE4.2. You can build a custom image from source explicitly without SSE4.2 support, using build arguments like so:

docker build -f xenial/Dockerfile --build-arg "RESTY_CONFIG_OPTIONS_MORE=--with-luajit-xcflags='-mno-sse4.2'" .

• All of the image flavors use OpenSSL 1.1.0h. Be careful of compatibility between your opm and LuaRocks packages -- they must all use the same OpenSSL version.

• The 1.13.6.2-alpine is built from OpenSSL 1.0.2.k because of build issues on Alpine.

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:xenial openresty

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

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

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

Building (from source)

This Docker image can be built and customized by cloning the repo and running docker build with the desired Dockerfile:

git clone https://github.com/openresty/docker-openresty.git
cd docker-openresty
docker build -t myopenresty -f xenial/Dockerfile .
docker run myopenresty

Dockerfiles are provided for the following base systems, selecting the Dockerfile path with -f:

• Alpine (alpine/Dockerfile)
• Alpine Fat (alpine-fat/Dockerfile)
• Ubuntu Xenial (xenial/Dockerfile)

We used to support more build flavors but have trimmed that down. Older Dockerfiles are archived in the archive folder.

The following are the available build-time options. They can be set using the --build-arg CLI argument, like so:

docker build --build-arg RESTY_J=4 -f xenial/Dockerfile .

Key	Default	Description
RESTY_IMAGE_BASE	"ubuntu" / "alpine"	The Debian or Alpine Docker image base to build FROM.
RESTY_IMAGE_TAG	"xenial" / "3.7"	The Debian or Alpine Docker image tag to build FROM.
RESTY_VERSION	1.13.6.2	The version of OpenResty to use.
RESTY_LUAROCKS_VERSION	2.4.4	The version of LuaRocks to use.
RESTY_OPENSSL_VERSION	1.1.0h / 1.0.2k	The version of OpenSSL to use.
RESTY_PCRE_VERSION	8.42	The version of PCRE to use.
RESTY_J	1	Sets the parallelism level (-jN) for the builds.
RESTY_CONFIG_OPTIONS	"--with-file-aio --with-http_addition_module --with-http_auth_request_module --with-http_dav_module --with-http_flv_module --with-http_geoip_module=dynamic --with-http_gunzip_module --with-http_gzip_static_module --with-http_image_filter_module=dynamic --with-http_mp4_module --with-http_perl_module=dynamic --with-http_random_index_module --with-http_realip_module --with-http_secure_link_module --with-http_slice_module --with-http_ssl_module --with-http_stub_status_module --with-http_sub_module --with-http_v2_module --with-http_xslt_module=dynamic --with-ipv6 --with-mail --with-mail_ssl_module --with-md5-asm --with-pcre-jit --with-sha1-asm --with-stream --with-stream_ssl_module --with-threads"	Options to pass to OpenResty's ./configure script.
RESTY_CONFIG_OPTIONS_MORE	""	More options to pass to OpenResty's ./configure script.

Back to TOC

Building (RPM based)

OpenResty now now has RPMs available. The centos images use these RPMs rather than building from source.

This Docker image can be built and customized by cloning the repo and running docker build with the desired Dockerfile:

• CentOS 7 RPM (centos/Dockerfile)

The following are the available build-time options. They can be set using the --build-arg CLI argument, like so:

docker build --build-arg RESTY_RPM_FLAVOR="-debug" centos

Key	Default	Description
RESTY_IMAGE_BASE	"centos"	The Centos Docker image base to build FROM.
RESTY_IMAGE_TAG	"7"	The CentOS Docker image tag to build FROM.
RESTY_LUAROCKS_VERSION	2.4.4	The version of LuaRocks to use.
RESTY_RPM_FLAVOR	""	The openresty package flavor to use. Possibly "-debug" or "-valgrind".
RESTY_RPM_VERSION	1.13.6.2-1.el7.centos	The openresty package version to install.
RESTY_RPM_ARCH	x86_64	The openresty package architecture to install.

Back to TOC

Building (DEB based)

OpenResty now now has Debian Packages (DEBs) available. The stretch image use these DEBs rather than building from source.

You can derive your own Docker images from this to install your own packages. See Dockerfile.opm_example and Dockerfile.luarocks_example.

This Docker image can be built and customized by cloning the repo and running docker build with the desired Dockerfile:

• Debian Stretch 9 DEB (stretch/Dockerfile)

The following are the available build-time options. They can be set using the --build-arg CLI argument, like so:

docker build --build-arg RESTY_DEB_FLAVOR="-debug" -f stretch/Dockerfile .

Key	Default	Description
RESTY_IMAGE_BASE	"debian"	The Debian Docker image base to build FROM.
RESTY_IMAGE_TAG	"stretch-slim"	The Debian Docker image tag to build FROM.
RESTY_DEB_FLAVOR	""	The openresty package flavor to use. Possibly "-debug" or "-valgrind".
RESTY_DEB_VERSION	"=1.13.6.2-1~stretch1"	The Debian package version to use, with = prepended.

Back to TOC

Building (Windows based)

This Docker image can be built and customized by cloning the repo and running docker build with the desired Dockerfile:

• Windows (windows/Dockerfile)

The following are the available build-time options. They can be set using the --build-arg CLI argument, like so:

docker build --build-arg RESTY_VERSION="1.13.6.2" -f windows/Dockerfile .

Key	Default	Description
RESTY_VERSION	1.13.6.2	The version of OpenResty to use.

Back to TOC

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

• CHANGELOG
• AUTHORS

Back to TOC

Copyright & License

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

Copyright (c) 2017, Evan Wies [e-mail].

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