About

A pre-built NGINX packages and modules for container.

Source

Docker Hub

Note

This repository will operate autonomously via GitHub scheduled workflow.

Due to limitations of GitHub Actions, in a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days.

If you are expecting a new builds for new NGINX releases and it is not available, feel free to submit a ticket.

See https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#disabling-and-enabling-workflows

Usage

The module is shipped using scratch as base image and contains the following structure:

• /module-available.d: Represent the available modules
• /packages: The content of the modules as os specific package

# Use `{version}` for debian variant and `{version}-alpine` for alpine variant
ARG NGINX_VERSION=stable-alpine 
# or
# NGINX_VERSION=1.25-alpine (Not available yet)
# NGINX_VERSION=1.25.0-alpine
FROM chocolatefrappe/nginx-modules:${NGINX_VERSION}-brotli

Example:

This is an example of how to use the pre-built NGINX packages and modules for container.

Alpine example

```Dockerfile # Use `{version}` for debian variant and `{version}-alpine` for alpine variant ARG NGINX_VERSION=stable-alpine # Modules FROM chocolatefrappe/nginx-modules:${NGINX_VERSION}-brotli AS mod-brotli FROM chocolatefrappe/nginx-modules:${NGINX_VERSION}-echo AS mod-echo # NGINX FROM nginx:${NGINX_VERSION} COPY --from=mod-brotli / /tmp/nginx-modules COPY --from=mod-echo / /tmp/nginx-modules # Alpine RUN set -ex \ && cd /tmp/nginx-modules \ && for mod in module-available.d/*; do \ module=$(basename $mod); \ apk add --no-cache --allow-untrusted packages/nginx-module-${module}-${NGINX_VERSION}*.apk; \ done \ && rm -rf /tmp/nginx-modules ```

Debian example

```Dockerfile # Use `{version}` for debian variant and `{version}-alpine` for alpine variant ARG NGINX_VERSION=stable # Modules FROM chocolatefrappe/nginx-modules:${NGINX_VERSION}-brotli AS mod-brotli FROM chocolatefrappe/nginx-modules:${NGINX_VERSION}-echo AS mod-echo # NGINX FROM nginx:${NGINX_VERSION} COPY --from=mod-brotli / /tmp/nginx-modules COPY --from=mod-echo / /tmp/nginx-modules RUN set -ex \ && chmod 1777 /tmp \ && apt update \ && cd /tmp/nginx-modules \ && for mod in module-available.d/*; do \ module=$(basename $mod); \ apt install --no-install-suggests --no-install-recommends -y /tmp/nginx-modules/packages/nginx-module-${module}_${NGINX_VERSION}*.deb; \ done \ && rm -rf /tmp/nginx-modules \ && rm -rf /var/lib/apt/lists/ ```

Supported releases

The supported releases are available in the following format:

• {version}, {version}-alpine
• {major}.{minor}, {major}.{minor}-alpine

See tags section below for more information.

Releases

The following releases are available:

Channel releases:

• mainline, mainline-alpine
• stable, stable-alpine

Versioned releases:

• 1.29
• 1.29.2
• mainline
• stable

Modules

All modules are shipped using scratch as base image to reduce the size of the image and avoid unnecessary dependencies.

Note

This repository will automatically continue to build modules and releases if any changes made to the NGINX oss-pkg repository.

See https://github.com/nginx/pkg-oss/

The following modules are available:

• acme: An NGINX module with the implementation of the automatic certificate management (ACMEv2) protocol
• auth-spnego: 3rd-party kerberos authentication dynamic module
• brotli: 3rd-party brotli compression dynamic modules
• echo: Brings echo, sleep, time, exec and more shell-style goodies to Nginx config file
• encrypted-session: 3rd-party encrypted session dynamic module
• fips-check: 3rd-party FIPS status check dynamic module
• geoip: GeoIP dynamic modules
• geoip2: 3rd-party GeoIP2 dynamic modules
• headers-more: 3rd-party headers-more dynamic module
• image-filter: image filter dynamic module
• lua: 3rd-party Lua dynamic modules
• ndk: 3rd-party NDK dynamic module
• njs: njs dynamic modules
• otel: NGINX Native OpenTelemetry (OTel) Module
• passenger: 3rd-party Passenger dynamic module
• perl: Perl dynamic module
• rtmp: 3rd-party RTMP dynamic module
• set-misc: 3rd-party set-misc dynamic module
• subs-filter: 3rd-party substitution dynamic module
• vts: 3rd-party virtual host traffic status dynamic module
• xslt: xslt dynamic module
• zip: 3rd-party zip dynamic module

Tags

The following tags are available:

• stable-acme, stable-alpine-acme
• stable-auth-spnego, stable-alpine-auth-spnego
• stable-brotli, stable-alpine-brotli
• stable-echo, stable-alpine-echo
• stable-encrypted-session, stable-alpine-encrypted-session
• stable-fips-check, stable-alpine-fips-check
• stable-geoip, stable-alpine-geoip
• stable-geoip2, stable-alpine-geoip2
• stable-headers-more, stable-alpine-headers-more
• stable-image-filter, stable-alpine-image-filter
• stable-lua, stable-alpine-lua
• stable-ndk, stable-alpine-ndk
• stable-njs, stable-alpine-njs
• stable-otel, stable-alpine-otel
• stable-passenger, stable-alpine-passenger
• stable-perl, stable-alpine-perl
• stable-rtmp, stable-alpine-rtmp
• stable-set-misc, stable-alpine-set-misc
• stable-subs-filter, stable-alpine-subs-filter
• stable-vts, stable-alpine-vts
• stable-xslt, stable-alpine-xslt
• stable-zip, stable-alpine-zip
• mainline-acme, mainline-alpine-acme
• mainline-auth-spnego, mainline-alpine-auth-spnego
• mainline-brotli, mainline-alpine-brotli
• mainline-echo, mainline-alpine-echo
• mainline-encrypted-session, mainline-alpine-encrypted-session
• mainline-fips-check, mainline-alpine-fips-check
• mainline-geoip, mainline-alpine-geoip
• mainline-geoip2, mainline-alpine-geoip2
• mainline-headers-more, mainline-alpine-headers-more
• mainline-image-filter, mainline-alpine-image-filter
• mainline-lua, mainline-alpine-lua
• mainline-ndk, mainline-alpine-ndk
• mainline-njs, mainline-alpine-njs
• mainline-otel, mainline-alpine-otel
• mainline-passenger, mainline-alpine-passenger
• mainline-perl, mainline-alpine-perl
• mainline-rtmp, mainline-alpine-rtmp
• mainline-set-misc, mainline-alpine-set-misc
• mainline-subs-filter, mainline-alpine-subs-filter
• mainline-vts, mainline-alpine-vts
• mainline-xslt, mainline-alpine-xslt
• mainline-zip, mainline-alpine-zip

Versioning releases:

• 1.29-acme, 1.29-alpine-acme
• 1.29-auth-spnego, 1.29-alpine-auth-spnego
• 1.29-brotli, 1.29-alpine-brotli
• 1.29-echo, 1.29-alpine-echo
• 1.29-encrypted-session, 1.29-alpine-encrypted-session
• 1.29-fips-check, 1.29-alpine-fips-check
• 1.29-geoip, 1.29-alpine-geoip
• 1.29-geoip2, 1.29-alpine-geoip2
• 1.29-headers-more, 1.29-alpine-headers-more
• 1.29-image-filter, 1.29-alpine-image-filter
• 1.29-lua, 1.29-alpine-lua
• 1.29-ndk, 1.29-alpine-ndk
• 1.29-njs, 1.29-alpine-njs
• 1.29-otel, 1.29-alpine-otel
• 1.29-passenger, 1.29-alpine-passenger
• 1.29-perl, 1.29-alpine-perl
• 1.29-rtmp, 1.29-alpine-rtmp
• 1.29-set-misc, 1.29-alpine-set-misc
• 1.29-subs-filter, 1.29-alpine-subs-filter
• 1.29-vts, 1.29-alpine-vts
• 1.29-xslt, 1.29-alpine-xslt
• 1.29-zip, 1.29-alpine-zip
• 1.29.2-acme, 1.29.2-alpine-acme
• 1.29.2-auth-spnego, 1.29.2-alpine-auth-spnego
• 1.29.2-brotli, 1.29.2-alpine-brotli
• 1.29.2-echo, 1.29.2-alpine-echo
• 1.29.2-encrypted-session, 1.29.2-alpine-encrypted-session
• 1.29.2-fips-check, 1.29.2-alpine-fips-check
• 1.29.2-geoip, 1.29.2-alpine-geoip
• 1.29.2-geoip2, 1.29.2-alpine-geoip2
• 1.29.2-headers-more, 1.29.2-alpine-headers-more
• 1.29.2-image-filter, 1.29.2-alpine-image-filter
• 1.29.2-lua, 1.29.2-alpine-lua
• 1.29.2-ndk, 1.29.2-alpine-ndk
• 1.29.2-njs, 1.29.2-alpine-njs
• 1.29.2-otel, 1.29.2-alpine-otel
• 1.29.2-passenger, 1.29.2-alpine-passenger
• 1.29.2-perl, 1.29.2-alpine-perl
• 1.29.2-rtmp, 1.29.2-alpine-rtmp
• 1.29.2-set-misc, 1.29.2-alpine-set-misc
• 1.29.2-subs-filter, 1.29.2-alpine-subs-filter
• 1.29.2-vts, 1.29.2-alpine-vts
• 1.29.2-xslt, 1.29.2-alpine-xslt
• 1.29.2-zip, 1.29.2-alpine-zip

Contributing

Contributions are welcome!

See CONTRIBUTING.md for more information.

License

Licensed under the MIT License.