Skip to content

LDEV-5272 document LUCEE_EXTENSIONS_FAIL_ON_ERROR #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michaeloffner merged 2 commits into from
Oct 31, 2026
Merged

LDEV-5272 document LUCEE_EXTENSIONS_FAIL_ON_ERROR #1643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
454518e
LDEV-5272 document LUCEE_EXTENSIONS_FAIL_ON_ERROR
GianTschingt Oct 31, 2026
a55b36a
LDEV-5272 document the warmup failure for invalid LUCEE_EXTENSIONS
GianTschingt Oct 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/recipes/environment-variables-system-properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,15 @@ Defines a comma-separated list of Lucee extensions to install when starting up.

The current list of installed extensions is available via the Lucee admin.

#### LUCEE_EXTENSIONS_FAIL_ON_ERROR

*SysProp:* `-Dlucee.extensions.fail.on.error`
*EnvVar:* `LUCEE_EXTENSIONS_FAIL_ON_ERROR`

A boolean value (default `false`) that makes an invalid `LUCEE_EXTENSIONS` fatal on startup. When `true`, the startup is aborted if an extension defined in `LUCEE_EXTENSIONS` cannot be installed or an entry of the list cannot be parsed. When `false`, the error is written to the deploy log and to stderr and the startup continues.

In warmup mode (`LUCEE_ENABLE_WARMUP`) such a failure always makes the process exit with a non-zero exit code, independent of this setting.

#### LUCEE_EXTENSIONS_CONFIG_ONLY

*SysProp:* `-Dlucee.extensions.config.only`
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/warmup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@ If any configuration is invalid, the `RUN` step fails and the Docker build abort

Warmup also installs the extensions defined in `.CFConfig.json` and stores them in the image, so the container doesn't download them at startup. See [[downloading-extensions]].

### Invalid `LUCEE_EXTENSIONS` *(Lucee 9)*

If an extension defined in `LUCEE_EXTENSIONS` (`lucee.extensions`) cannot be installed, or an entry of that list cannot be parsed, warmup fails: the error is written to stderr and the deploy log, `onBuild` is not called and Lucee exits with a non-zero exit code, so the Docker build aborts instead of producing an image with missing extensions.

Outside of warmup, the same failure is only logged by default. Set `LUCEE_EXTENSIONS_FAIL_ON_ERROR=true` (`lucee.extensions.fail.on.error`) to abort a normal startup as well. See [[environment-variables-system-properties]].

## Upgrading to Lucee 7

Because Lucee 7 now validates all configuration sections during warmup, upgrading may cause your warmup to fail on settings that previously passed silently in Lucee 6.2. This is intended — it surfaces misconfigurations that were always there but hidden by lazy loading. Fix the reported settings and rebuild.
Expand Down
Loading