Lucee Docker Images

Lucee application engine running on Apache Tomcat J2EE application server.

Supported tags and respective Dockerfile links

Latest stable release (5.4)

Tomcat 9.0 with Java 11 (recommended)

• 5.4.4.38-tomcat9.0-jre11-temurin-jammy, 5.4.4.38, 5.4, latest (Dockerfile)
  • 5.4.4.38-nginx-tomcat9.0-jre11-temurin-jammy, 5.4.4.38-nginx, 5.4-nginx (Dockerfile.nginx)

Tomcat 9.0 with Java 8

• 5.4.4.38-tomcat9.0-jre8-temurin-jammy, (Dockerfile)
  • 5.4.4.38-nginx-tomcat9.0-jre8-temurin-jammy (Dockerfile.nginx)

How the tags work

The Lucee Docker image tags follow a naming convention which is used to produce "simple tags" that are updated with each release (e.g. 5.4, 5.4-nginx) as well as "full tags" which allow for very specific version targeting (e.g. 5.4.4.38-tomcat9.0-jre11-temurin-jammy).

The tag naming convention is;

LUCEE_VERSION[-RELEASE_TYPE][-light][-nginx][-TOMCAT_VERSION-JRE_VERSION]

• LUCEE_VERSION is the Lucee Version number string. For simple tags it may optionally be in the MAJOR.MINOR format (e.g. 5.4) and for full tags it's in the MAJOR.MINOR.PATCH.BUILD format (e.g. 5.4.4.38). Snapshot, RC and Beta builds always include the full version number.
• RELEASE_TYPE is the type of release; omitted for Releases, otherwise SNAPSHOT, RC or BETA
• -light (optional) is a build with the Lucee "Light" JAR file, WITHOUT any extensions (users must install extensions separately, this includes database drivers, ORM, ESAPI, S3, image handling, etc)
• -nginx (optional) is a build with the NGINX web server bundled and configured
• -TOMCAT_VERSION-JRE_VERSION is the Tomcat major and minor version and Java major version of the build to allow users to choose between different combinations (e.g. tomcat9.0-jre11-temurin-jammy vs tomcat9.0-jre8-temurin-jammy). This is omitted for "simple tags" where the recommended Tomcat and Java versions are used.

Base Image / Operating System Notes:

• The Lucee images are based on the Docker Tomcat images.
• The Docker Tomcat images were previously based on OpenJDK images which used Debian as the underlying OS. The OpenJDK Debian images have been discontinued for Java 8 and Java 11 so the next best match in the Docker Tomcat images are now the Ubuntu Jammy (22.04 LTS) and Focal (20.04 LTS) images using the OpenJDK baed Temurin Java distributions.
• The Docker Tomcat images removed support for Alpine and so the Lucee -alpine variant can no longer be supported. If the Tomcat base images add support for Alpine in the future then we will look to support the -alpine variant again.

Previous stable release (5.3)

Tomcat 9.0 with OpenJDK 11

• 5.3.9.133-tomcat9.0-jdk11-openjdk, 5.3.9.133, 5.3, latest (Dockerfile)
  • 5.3.9.133-nginx-tomcat9.0-jdk11-openjdk, 5.3.9.133-nginx, 5.3-nginx (Dockerfile.nginx)

Tomcat 9.0 with OpenJDK 8

• 5.3.9.133-tomcat9.0-jdk8-openjdk (Dockerfile)
  • 5.3.9.133-nginx-tomcat9.0-jdk8-openjdk (Dockerfile.nginx)

Bleeding edge Snapshot / RC / Beta (6.0)

• 5.4.1.4-SNAPSHOT-tomcat9.0-jre11-temurin-jammy, 5.4.1.4-SNAPSHOT
  • 5.4.1.4-SNAPSHOT-nginx-tomcat9.0-jre11-temurin-jammy, 5.4.1.4-SNAPSHOT-nginx
• 6.0.0.503-RC-tomcat9.0-jre11-temurin-jammy, 6.0.0.503-RC
  • 6.0.0.503-RC-nginx-tomcat9.0-jre11-temurin-jammy, 6.0.0.503-RC-nginx
• 6.0.0.451-BETA-tomcat9.0-jre11-temurin-jammy, 6.0.0.451-BETA
  • 6.0.0.451-BETA-nginx-tomcat9.0-jre11-temurin-jammy, 6.0.0.451-BETA-nginx

The SNAPSHOTS Docker image builds are automatically generated after a successful Lucee build. The 5.4.1.4-SNAPSHOT version number above is an example of the latest SNAPSHOT version number; check the Docker Hub tags and/or the Lucee Downloads page to see the latest SNAPSHOT version numbers.

The RC and Beta builds are manually triggered when they are announced.

For more information about Lucee versions and extensions see the Lucee Downloads page.

Example Project Dockerfile

For the latest stable release with Tomcat only:

FROM lucee/lucee:5.4

COPY config/lucee/ /opt/lucee/web/
COPY www /var/www

For the latest stable release with NGINX and Tomcat:

FROM lucee/lucee:5.4-nginx

COPY config/nginx/ /etc/nginx/
COPY config/lucee/ /opt/lucee/web/
COPY www /var/www

Features

Java optimisation tweaks

• JVM is set to use /dev/urandom as an entropy source for secure random numbers to avoid blocking Tomcat on startup.

• Tomcat is configured to skip the default scanning of Jar files on startup, significantly improving startup time.

Optimised for single-site application

The default configuration serves a single application for any hostname on the listening port. Multiple applications can be supported by editing the server.xml in the Tomcat config.

Using this image

Accessing the service

Lucee server's Tomcat installation listens on port 8888.

This base image exposes port 8080 to linked containers but its not used. You must publish or expose port 8888 if you wish to access Tomcat from your installation.

Accessing the Lucee Admin

The Lucee Admin URL is /lucee/admin/ from the exposed port. No admin passwords are set.

THIS IS NOT A SECURE CONFIGURATION FOR PRODUCTION ENVIRONMENTS! It is strongly recommended that you secure the container by:

• Changing the server password
• Using IP or URL filtering to restrict access to the Lucee Admin
• Following recommended security practices such as the Lucee Lockdown Guide

The NGINX tagged Docker images are configured to deny access to the Lucee Admin by default in the default.conf.

Folder locations

Web root for default site: /var/www

Configuration folders:

• Tomcat config: /usr/local/tomcat/conf
• Lucee config for default site: /opt/lucee/web
• Lucee server context: /opt/lucee/server/lucee-server/context

Log folders:

• Tomcat logs: /usr/local/tomcat/logs
• Lucee logs for default site: /opt/lucee/web/logs

Environment variables

The default image contains scripts that use the following environment variables if they are set in the container.

LUCEE_JAVA_OPTS: Additional JVM parameters for Tomcat. Used by /usr/local/tomcat/bin/setenv.sh. Default: "-Xms64m -Xmx512m".

How to locally develop Lucee Docker builds

Developing and testing builds locally requires a Docker environment with buildx support and Python 3 installed. Run pip3 install -r requirements.txt to install the required dependencies.

To build and test specific verions set environment variables for the Tomcat and Lucee verions that are to be used, e.g.

export TOMCAT_VERSION=9.0
export TOMCAT_JAVA_VERSION=jre11-temurin-jammy
export TOMCAT_BASE_IMAGE=
export LUCEE_MINOR=5.4
export LUCEE_SERVER=,-nginx
export LUCEE_VARIANTS=

export LUCEE_VERSION=5.4.4.38

Then use the default builder with buildx and run the build-images script using a single target platform only (matching your native platform), e.g.

docker buildx use default
./build-images.py --no-push --buildx-load --buildx-platform linux/amd64

Specify the newly built image tag in a Docker Compose file to run and test the container image with docker-compose up;

lucee:
  image: lucee/lucee:5.4.4.38
  ports: 
    - "8854:8888"
    - "8054:80"

Advanced build changes

If adding new Tomcat base (OS) images, Tomcat versions, Java versions, or Lucee versions or variants, the matrix.yaml needs to be edited so that several features like the tag building/lookups will work. After modifying the matrix.yaml run the script ./generate-matrix.py to generate the new Travis configuration (note: Travis CI is deprecated as builds have transitioned to GitHub Actions, however this part of the build hasn't been fully removed yet).

Legacy Lucee Base Images

The older Lucee Base Images will remain available for the projects that are using them, though the build process for those images is considered "legacy" as they have been superseded by the new build matrix builds.

The base images can be accessed in the existing Docker Hub repositories and the source is now in the legacy branch;

https://github.com/lucee/lucee-dockerfiles/tree/legacy

Lucee 5.2 (Legacy builds)

• nginx + Tomcat 8.0-JRE8    
• Tomcat 8.0-JRE8    

Lucee 5.1 (Legacy builds)

• nginx + Tomcat 8.0-JRE8    
• Tomcat 8.0-JRE8    

Lucee 5.0 (Legacy builds)

• nginx + Tomcat 8.0-JRE8    
• Tomcat 8.0-JRE8    

Lucee 4.5 (Legacy builds)

• nginx + Tomcat 8.0-JRE8    
• Tomcat 8.0-JRE8    

Contributing to this Project

The Lucee Dockerfiles project is maintained by the community. Chief protagonist is @justincarter (Justin Carter of Daemon). Bug reports and pull requests are most welcome.

Special thanks to @rye (Kristofer Rye) and @hawkrives (Hawken Rives) for their work on the Travis build matrix.

License

The Docker files and config files are available under the MIT License. The Lucee engine, Tomcat, NGINX and any other softwares are available under their respective licenses.