Contributing

Contributions to docker-openresty are welcome! Whether it's reporting a bug, suggesting an improvement, or submitting a pull request, your help is appreciated.

Reporting Issues

Please report any bugs or feedback as GitHub Issues:

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

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

Local Development

If you want to build the images locally for testing or development, the project includes a Taskfile.yml for use with the Task build tool.

Setting up Task

First, install Task.

Building Images Locally

Once Task is installed, you can use it to build various image flavors. The Taskfile provides convenient targets that mirror the CI build matrix.

To see a list of all available tasks:

task --list-all

To build all upstream-based images for the amd64 architecture:

task build-all-upstream-amd64

To build all source-based images for the arm64 architecture (must be run on an arm64 host):

task build-all-source-arm64

These commands are defined in Taskfile.yml and are wrappers around docker build commands with the correct arguments for each flavor.

Contribution Policies

The project maintainers operate under the following policies:

  • We track OpenResty releases for build-from-upstream images.
  • We track stable releases for build-from-source images (Alpine stable and 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 often, we may remove it.
  • We operate in English, and PRs must be in English.
  • All are welcome to participate but must show mutual respect to the community.

Authors

We'd like to thank the following people for their commits: