For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration Directives

Configuration directives index — every section of the ColdBox class at a glance.

All application configuration lives in the ColdBox class (config/ColdBox.bx, or config/ColdBox.cfc for CFML apps) inside its configure() method. Each top-level struct is a directive:

Directive
Purpose
Page

coldbox

Core framework behavior — app name, event name, handlers, caching, error handling

conventions

Override default folder/file conventions

environments

Per-environment config overrides

flash

Flash scope storage

interceptors / interceptorSettings

Registered interceptors and their config

layouts / layoutSettings

Layout registrations and behavior

settings

Custom application settings

executors

Named async executor pools for your app

sse

Server-Sent Events behavior (BoxLang only)

modules

Module loading and behavior

moduleSettings

Per-module settings

cachebox

Caching — see the CacheBox book for the full DSL

logbox

Logging — see the LogBox book for the full DSL

wirebox

Dependency injection — see the WireBox book for the full DSL

Environment Variables & Java Properties

Any directive can be overridden externally without touching code: System Settings.

A Note on the Companion Frameworks

CacheBox, LogBox, and WireBox are standalone frameworks with their own books. ColdBox docs cover how the ColdBox class wires them in; their internal DSLs (cache providers, appenders, binder mappings) are documented in their own books — see Companion Frameworks.

Last updated

Was this helpful?