Docker OpenResty Overview

Welcome to the documentation for docker-openresty, the official Docker tooling for OpenResty.

OpenResty® is a full-fledged web platform that integrates the standard Nginx core, the latest LuaJIT, many high-quality 3rd-party Nginx modules, and most of their external dependencies. It is designed to help developers easily build scalable web applications, web services, and dynamic web gateways.

This project provides a comprehensive set of Docker images for OpenResty, catering to a wide variety of use cases, from simple deployments to highly customized builds. The images are available for multiple operating system flavors, architectures, and OpenResty versions.

Key Features

  • Multiple Flavors: Choose from a wide range of base images, including Alpine, Debian, Ubuntu, CentOS, and Windows, to best fit your environment.
  • Upstream Packages & Source Builds: Use images built directly from official OpenResty packages for stability, or build from source for maximum customization.
  • Multi-Architecture Support: Images are built for amd64 (x86_64), aarch64 (arm64), and s390x (on select flavors), ensuring compatibility across modern hardware.
  • Production-Ready: Images are configured with sensible defaults, including logging to stdout/stderr and graceful shutdown handling, making them suitable for production environments.
  • Extensible: Easily extend the base images to add your own Nginx configurations, Lua code, or install additional packages and LuaRocks.

This documentation site will guide you through getting started, choosing the right image, configuring Nginx, and building your own custom images.

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