grails.banner.art.color

The colour to show the banner art in, where the terminal colours output at all. A number selects one of the 256 colours a terminal offers; a name selects one of the eight it has always had, such as red or bright_blue; none leaves the art uncoloured. A value that is neither falls back to the default.

214

grails.banner.art.display

Whether to display the Grails banner art.

true

grails.banner.art.file

The file path on the classpath to the Grails banner art to display.

grails-banner.txt

grails.banner.mark.color

The colour to show the mark in, separate from the art so it is not read as part of it. Takes the same values as grails.banner.art.color: a number for one of the 256 colours a terminal offers, a name for one of the eight it has always had, or none.

226

grails.banner.mark.display

Whether to say under the banner art how the application was started: NATIVE for an image, AOT CACHE for a JVM given a cache to read, AOT for one running generated bean definitions. An ordinary start says nothing.

true

grails.banner.mark.text

Says this instead of what was detected. Shown spaced and in upper case, and an empty value shows nothing.

grails.banner.versions.display

Whether to display version information in the Grails banner.

true

grails.banner.versions.exclude

A list of versions to exclude from the banner.

grails.banner.versions.include

A list of optional versions to include in the banner.

grails.banner.versions.order

A sorted list of versions to put first in the banner versions.

grails.bootstrap.skip

Whether to skip execution of BootStrap.groovy classes on startup.

false

grails.codegen.defaultPackage

The default package used when generating artefacts with grails create-* commands.

Set by project template

grails.enable.native2ascii

Whether to perform native2ascii conversion of i18n properties files.

true

grails.plugin.excludes

List of plugin names to exclude from the plugin manager.

[]

grails.plugin.includes

List of plugin names to include in the plugin manager (all others excluded).

[]

grails.profile

The active Grails application profile (e.g., web, rest-api, plugin).

Set by project template

grails.serverURL

The server URL used to generate absolute links (e.g., https://my.app.com) and used by redirects.

derived from request

grails.spring.bean.packages

List of packages to scan for Spring beans.

[]

grails.spring.disable.aspectj.autoweaving

Whether to disable AspectJ auto-weaving.

false

grails.spring.placeholder.prefix

The prefix for property placeholder resolution.

${

grails.spring.transactionManagement.proxies

Whether to enable Spring proxy-based transaction management since @Transactional uses an AST transform and proxies are typically redundant.

false

grails.controllers.defaultScope

The default scope for controllers (singleton, prototype, session).

singleton

grails.exceptionresolver.logRequestParameters

Whether to log request parameters in exception stack traces. Defaults to true in development and false otherwise.

grails.exceptionresolver.params.exclude

List of parameter names to mask (replace with *) in exception stack traces, typically used for password and creditCard. Parameter names are matched case-insensitively.

[]

grails.filter.encoding

The character encoding for the Grails character encoding filter.

UTF-8

grails.filter.forceEncoding

Whether to force the encoding filter to set the encoding on the response.

true

grails.logging.stackTraceFiltererClass

Fully qualified class name of a custom StackTraceFilterer implementation.

org.grails.exceptions.reporting.DefaultStackTraceFilterer

grails.web.linkGenerator.useCache

Whether to cache links generated by the link generator.

true

grails.web.removeDefaultViewResolverBean

Whether to remove Spring Boot’s defaultViewResolver bean so Grails' own view resolution is used.

true

grails.web.removeWelcomePageMapping

Whether to remove Spring Boot’s welcome-page handler mapping so Grails' URL mappings own the root path ('/') rather than serving a static index.html for it.

true

grails.web.servlet.path

The path the Grails dispatcher servlet is mapped to.

/**

grails.web.url.converter

The URL token converter strategy, use hyphenated for hyphen-separated URLs.

camelCase

grails.cors.allowCredentials

Whether credentials (cookies, authorization headers) are supported.

false

grails.cors.allowedHeaders

List of allowed request headers.

["*"]

grails.cors.allowedMethods

List of allowed HTTP methods.

["*"]

grails.cors.allowedOrigins

List of allowed origins (e.g., http://localhost:5000), only applies when grails.cors.enabled is true.

["*"]

grails.cors.enabled

Whether CORS support is enabled.

false

grails.cors.exposedHeaders

List of response headers to expose to the client.

[]

grails.cors.filter

Whether CORS is handled via a servlet filter (true) or an interceptor (false).

true

grails.cors.mappings

Map of URL patterns to per-path CORS configuration where defining any mapping disables the global /** mapping.

{}

grails.cors.maxAge

How long (in seconds) the preflight response can be cached.

1800

grails.gsp.disable.caching.resources

Whether to disable GSP resource caching.

false

grails.gsp.enable.reload

Whether to enable GSP reloading in production.

false

grails.gsp.view.dir

Custom directory for GSP view resolution.

grails-app/views

grails.views.default.codec

Fallback default for grails.views.gsp.codecs.expression, scriptlet, taglib and staticparts when those are not set. Options: none, html, base64.

html

grails.views.enable.jsessionid

Whether to include the jsessionid in rendered links.

false

grails.views.filteringCodecForContentType

Map of content types to encoding codecs.

{}

grails.views.gsp.codecs.expression

The codec applied to GSP ${} expressions.

html

grails.views.gsp.codecs.scriptlet

The codec applied to GSP <% %> scriptlet output.

html

grails.views.gsp.codecs.staticparts

The codec applied to static HTML parts of GSP pages.

none

grails.views.gsp.codecs.taglib

The codec applied to tag library output.

none

grails.views.gsp.compileStatic

Whether every GSP is compiled statically, without each page declaring a compileStatic directive.

false

grails.views.gsp.compileStaticConfig.strict

Whether a statically compiled page is held to the names it declares, rather than only pages that declare a model.

false

grails.views.gsp.compileStaticConfig.taglibs

Tag library namespaces a statically compiled page may call, beyond those the framework supplies. A comma separated string or a list.

grails.views.gsp.encoding

The file encoding for GSP source files.

UTF-8

grails.views.gsp.htmlcodec

Selects the HTML escaping style of the HTML codec. By default the XML-safe encoder is used. Set to html4 (ignoring case) to use the legacy HTML4 encoder, which converts non-ASCII characters to named entities.

xml

grails.views.gsp.layout.preprocess

Whether GSP layout preprocessing is enabled. Disabling allows Grails to parse rendered HTML but slows rendering.

true

grails.converters.encoding

The character encoding for converter output (JSON or XML) and for the response content types stamped by the default renderers used by respond().

UTF-8

grails.mime.disable.accept.header.userAgents

List of user agent substrings (matched case-insensitively) for which Accept header processing is disabled.

["Gecko", "WebKit", "Presto", "Trident"]

grails.mime.disable.accept.header.userAgentsXhr

When true, XHR requests also respect the grails.mime.disable.accept.header.userAgents setting, while by default XHR requests ignore user agent filtering.

false

grails.mime.file.extensions

Whether to use the file extension to determine the MIME type in content negotiation.

true

grails.mime.types

Map of MIME type names to content type strings used for content negotiation.

see web profile application.yml

grails.mime.use.accept.header

Whether to use the Accept header for content negotiation.

true

grails.databinding.autoGrowCollectionLimit

The maximum size to which indexed collections can auto-grow during data binding.

256

grails.databinding.convertEmptyStringsToNull

Whether empty String values are converted to null during data binding.

true

grails.databinding.dateFormats

List of date format strings used to parse date values during data binding.

["yyyy-MM-dd HH:mm:ss.S", "yyyy-MM-dd’T’HH:mm:ss’Z'", "yyyy-MM-dd HH:mm:ss.S z", "yyyy-MM-dd’T’HH:mm:ssX"]

grails.databinding.dateParsingLenient

Whether date parsing is lenient (accepting invalid dates like Feb 30).

false

grails.databinding.denyByDefault

Whether mass data binding is denied for properties without an explicit bindable: true constraint or other allowlist entry.

false

grails.databinding.trimStrings

Whether to trim whitespace from String values during data binding.

true

grails.i18n.cache.seconds

How long (in seconds) resolved message bundles are cached. Honoured only when reload is enabled, as before.

grails.i18n.default.locale

The locale of the base message bundle, always offered by a language selector and used by the 'fixed' locale resolver. Falls back to the JVM default when unset.

grails.i18n.include-plugin-bundles

Whether message bundles contributed by plugins participate, both in message resolution and in the locales offered by a language selector. Bundle caching, encoding and locale fallback are configured through spring.messages.* instead.

true

grails.i18n.localeResolver

The locale resolution strategy. 'session' and 'cookie' are mutable (the ?lang= switch works); 'acceptHeader' and 'fixed' are read-only (the ?lang= switch is ignored).

session

grails.resources.cachePeriod

The cache period (in seconds) for static resource HTTP responses.

0

grails.resources.enabled

Whether serving static files from src/main/resources/public is enabled.

true

grails.resources.pattern

The URL path pattern for serving static resources.

/static/**

grails.urlmapping.cache.maxsize

The maximum size of the URL mapping cache.

1000

grails.scaffolding.templates.domainSuffix

The suffix appended to domain class names when generating scaffolding templates.

grails.reload.excludes

List of fully qualified class names to exclude from development reloading.

[]

grails.reload.includes

List of fully qualified class names to include in development reloading, when set only these classes are reloaded.

[]

grails.events.spring

Whether to bridge GORM/Grails events to the Spring ApplicationEventPublisher, allowing EventListener methods to receive domain events.

true

grails.converters.json.domain.include.class

Whether to include the class property when marshalling domain objects to JSON.

false

grails.converters.xml.domain.include.class

Whether to include the class attribute when marshalling domain objects to XML.

false

grails.json.legacy.builder

Whether to use the legacy JSON builder.

false

grails.gorm.autoFlush

Whether to automatically flush the Hibernate session between queries.

false

grails.gorm.autowire

Whether to autowire Spring beans into domain class instances.

true

grails.gorm.custom.types

Map of custom GORM types.

{}

grails.gorm.default.constraints

A closure applied as the default constraints for all domain classes.

{}

grails.gorm.default.mapping

A closure applied as the default mapping block for all domain classes.

{}

grails.gorm.default.nullable

Whether an unconstrained persistent property is nullable by default (Grails 8). Set to false to restore the legacy required-by-default behaviour.

true

grails.gorm.defaultIdType

Effective identity type for precompiled plugin domains that declare Serializable id. Accepted values are long and native.

long

grails.gorm.events.autoTimestampInsertOverwrite

Whether auto-timestamp (dateCreated) overwrites a user-provided value on insert.

true

grails.gorm.failOnError

When true, save() throws ValidationException on validation failure instead of returning null and can also be a list of package names to apply selectively.

false

grails.gorm.flushMode

The default Hibernate flush mode (AUTO, COMMIT, MANUAL).

AUTO

grails.gorm.markDirty

Whether to mark a domain instance as dirty on an explicit save() call.

true

grails.gorm.multiTenancy.mode

The multi-tenancy mode: DISCRIMINATOR, DATABASE, SCHEMA, or NONE.

NONE

grails.gorm.multiTenancy.tenantResolverClass

Fully qualified class name of the TenantResolver implementation.

required when mode is not NONE

grails.gorm.reactor.events

Whether to translate GORM events into Reactor events, which is disabled by default for performance.

false

dataSource.dbCreate

The schema generation strategy: create-drop, create, update, validate, or none, use none in production with a migration tool. The default applies in every environment; generated applications set it per environment in application.yml.

none

dataSource.dialect

The Hibernate dialect class name or class.

auto-detected from driver

dataSource.driverClassName

The JDBC driver class name. When not set, the connection pool derives the driver from the JDBC URL.

dataSource.formatSql

Whether to format logged SQL for readability.

false

dataSource.jmxExport

Whether to register JMX MBeans for Tomcat JDBC pool DataSources that set jmxEnabled in their properties.

false

dataSource.logSql

Whether to log SQL statements to stdout.

false

dataSource.password

The database password. When not set, connections are opened without a password. H2 applications usually set an empty password.

dataSource.persistenceInterceptor

For additional datasources, whether to wire up the persistence interceptor (the default datasource is always wired).

false

dataSource.pooled

Whether to use a connection pool.

true

dataSource.readOnly

Whether the DataSource is read-only (calls setReadOnly(true) on connections).

false

dataSource.transactional

For additional datasources, whether to include in the chained transaction manager.

true

dataSource.type

The connection pool implementation class when multiple are on the classpath.

com.zaxxer.hikari.HikariDataSource

dataSource.url

The JDBC connection URL.

jdbc:h2:mem:grailsDB;LOCK_TIMEOUT=10000

dataSource.username

The database username. When not set, connections are opened without a username. H2 applications usually set sa.

hibernate.cache.queries

Whether to cache Hibernate queries.

false

hibernate.cache.use_query_cache

Whether to enable Hibernate’s query cache.

false

hibernate.cache.use_second_level_cache

Whether to enable Hibernate’s second-level cache.

false

grails.plugin.databasemigration.changelogFileName

The name of the main changelog file. For named datasources uses changelog-<name>.groovy.

changelog.groovy

grails.plugin.databasemigration.changelogLocation

The directory containing changelog files.

grails-app/migrations

grails.plugin.databasemigration.contexts

Comma-delimited list of Liquibase contexts to use for all operations.

grails.plugin.databasemigration.databaseChangeLogLockTableName

The name of the Liquibase lock table used to prevent concurrent migrations.

DATABASECHANGELOGLOCK

grails.plugin.databasemigration.databaseChangeLogTableName

The name of the Liquibase changelog tracking table.

DATABASECHANGELOG

grails.plugin.databasemigration.dropOnStart

Whether to drop all database tables before auto-running migrations at startup.

false

grails.plugin.databasemigration.excludeObjects

Comma-delimited list of database objects to ignore in diff and generate operations.

grails.plugin.databasemigration.includeObjects

Comma-delimited list of database objects to include in diff and generate operations (all others excluded).

grails.plugin.databasemigration.skipUpdateOnStartMainClasses

List of main class names for which startup migrations are skipped, preventing migrations when running CLI commands.

["grails.ui.command.GrailsApplicationContextCommandRunner"]

grails.plugin.databasemigration.updateAllOnStart

Whether to run changesets at startup for all configured datasources.

false

grails.plugin.databasemigration.updateOnStart

Whether to run changesets from the specified file at application startup.

false

grails.plugin.databasemigration.updateOnStartContexts

Liquibase contexts to activate when running migrations at startup. Empty means all contexts.

[]

grails.plugin.databasemigration.updateOnStartDefaultSchema

The default database schema to use when running migrations at startup.

grails.plugin.databasemigration.updateOnStartFileName

The changelog file name to run at startup. For named datasources uses changelog-<name>.groovy.

changelog.groovy

grails.plugin.databasemigration.updateOnStartLabels

Liquibase labels to filter changesets when running migrations at startup. Empty means all labels.

[]

grails.cache.cacheManager

The cache manager implementation class name. Use GrailsConcurrentLinkedMapCacheManager for bounded caches with maxCapacity support.

GrailsConcurrentMapCacheManager

grails.cache.caches

Map of cache-specific configurations keyed by cache name, each supporting a maxCapacity setting (used by GrailsConcurrentLinkedMapCacheManager).

{}

grails.cache.clearAtStartup

Whether to clear all caches when the application starts.

false

grails.cache.ehcache.ehcacheXmlLocation

Location of the Ehcache XML configuration file on the classpath.

classpath:ehcache.xml

grails.cache.ehcache.lockTimeout

The timeout in milliseconds for acquiring a lock on a cache element.

200

grails.cache.enabled

Whether the cache plugin is enabled.

true

grails.mongodb.buildIndexes

Whether GORM creates the indexes declared in domain class mapping blocks by itself when the datastore starts. When false, the indexes already on the server are left untouched until MongoDatastore.buildIndex() is called.

true

grails.mongodb.buildIndexesAsync

Whether index builds, the one on startup and any started with MongoDatastore.buildIndex(), run on a background thread instead of blocking the thread that starts them.

false

grails.mongodb.codecs

List of custom MongoDB Codec classes to register for BSON serialization.

[]

grails.mongodb.databaseName

The MongoDB database name.

grails.mongodb.decimalType

Whether to use Decimal128 for BigDecimal values instead of Double.

true

grails.mongodb.default.mapping

A closure applied as the default GORM mapping block for all MongoDB domain classes.

{}

grails.mongodb.host

The MongoDB server hostname. Ignored when url or connectionString is set.

127.0.0.1

grails.mongodb.password

The password for MongoDB authentication.

grails.mongodb.port

The MongoDB server port. Ignored when url or connectionString is set.

27017

grails.mongodb.stateless

Whether to use stateless mode with no session-level caching of entities.

false

grails.mongodb.url

The MongoDB connection URL. Supports the full MongoDB connection string format.

mongodb://127.0.0.1:27017/test

grails.mongodb.username

The username for MongoDB authentication.

hibernate.grails.proxy.lazy_to_string

Whether toString() on an uninitialized entity proxy returns entityName:id without initializing it. When false (the default, matching Grails 7 and earlier), toString() initializes the proxy and delegates to the domain class’s own implementation.

false

grails.views.json.allowResourceExpansion

Whether to allow HAL resource expansion in JSON views.

true

grails.views.json.baseTemplateClass

The base template class for JSON Views.

grails.plugin.json.view.JsonViewWritableScript

grails.views.json.cache

Whether to cache compiled JSON View templates. Defaults to false in development and true otherwise.

grails.views.json.compileStatic

Whether JSON views are statically compiled.

true

grails.views.json.enableReloading

Whether JSON Views are reloaded when they change. Defaults to true in development and false otherwise.

grails.views.json.encoding

The character encoding for JSON views.

UTF-8

grails.views.json.extension

The file extension for JSON View templates.

gson

grails.views.json.generator.dateFormat

The SimpleDateFormat pattern for java.util.Date and Calendar values and map keys in JSON views.

yyyy-MM-dd’T’HH:mm:ss.SSSXXX

grails.views.json.generator.escapeUnicode

Whether to escape Unicode characters in JSON output.

false

grails.views.json.generator.locale

The locale for the grails.views.json.generator.dateFormat pattern.

en/US

grails.views.json.generator.timeZone

The time zone that the grails.views.json.generator.dateFormat pattern writes java.util.Date and Calendar values in.

GMT

grails.views.json.mimeTypes

MIME types handled by JSON views.

["application/json", "application/hal+json"]

grails.views.json.packageImports

Packages imported into JSON View templates.

["groovy.transform"]

grails.views.json.packageName

The package name used for compiled JSON Views. Defaults to the application name.

grails.views.json.prettyPrint

Whether to pretty-print JSON output with indentation.

false

grails.views.json.staticImports

Static classes imported into JSON View templates.

["org.springframework.http.HttpStatus", "org.springframework.http.HttpMethod", "grails.web.http.HttpHeaders"]

grails.views.json.templatePath

The filesystem path containing JSON View templates. Defaults to the environment reload location or application views directory.

grails.views.json.useAbsoluteLinks

Whether links generated by JSON Views use absolute URLs.

false

grails.views.markup.allowResourceExpansion

Whether to allow resource expansion in Markup Views.

true

grails.views.markup.autoEscape

Whether to escape XML special characters in Markup Views.

true

grails.views.markup.autoIndent

Whether to indent generated markup automatically.

true

grails.views.markup.autoIndentString

The string used for each automatic indentation level.

` `

grails.views.markup.autoNewLine

Whether to insert new lines in generated markup automatically.

true

grails.views.markup.baseTemplateClass

The base template class for Markup Views.

grails.plugin.markup.view.MarkupViewTemplate

grails.views.markup.cache

Whether to cache compiled Markup View templates. Defaults to false in development and true otherwise.

grails.views.markup.cacheTemplates

Whether the markup template engine caches compiled templates. Defaults to false in development and true otherwise.

grails.views.markup.compileStatic

Whether Markup Views are statically compiled.

true

grails.views.markup.declarationEncoding

The character encoding declared in generated XML declarations.

grails.views.markup.enableReloading

Whether Markup Views are reloaded when they change. Defaults to true in development and false otherwise.

grails.views.markup.encoding

The character encoding for Markup Views.

UTF-8

grails.views.markup.expandEmptyElements

Whether empty markup elements use expanded opening and closing tags.

false

grails.views.markup.extension

The file extension for Markup View templates.

gml

grails.views.markup.locale

The locale used by the markup template engine.

grails.views.markup.mimeTypes

MIME types handled by Markup Views.

["application/xml", "application/hal+xml"]

grails.views.markup.newLineString

The string used for generated line breaks.

grails.views.markup.packageImports

Packages imported into Markup View templates.

["groovy.transform"]

grails.views.markup.packageName

The package name used for compiled Markup Views. Defaults to the application name.

grails.views.markup.prettyPrint

Whether to pretty-print generated markup.

false

grails.views.markup.staticImports

Static classes imported into Markup View templates.

["org.springframework.http.HttpStatus", "org.springframework.http.HttpMethod", "grails.web.http.HttpHeaders"]

grails.views.markup.templatePath

The filesystem path containing Markup View templates. Defaults to the environment reload location or application views directory.

grails.views.markup.useAbsoluteLinks

Whether links generated by Markup Views use absolute URLs.

false

grails.views.markup.useDoubleQuotes

Whether generated markup uses double quotes for attribute values.

false

grails.mongodb.options.applicationName

Application name sent to MongoDB for server logs and profiling.

grails.mongodb.options.readConcern

The MongoDB read concern level (e.g., local, majority, linearizable).

grails.mongodb.options.readPreference

The MongoDB read preference (e.g., primary, secondary, nearest).

grails.mongodb.options.retryReads

Whether to retry read operations on transient network errors.

grails.mongodb.options.retryWrites

Whether to retry write operations on transient network errors.

grails.mongodb.options.writeConcern

The MongoDB write concern (e.g., majority, w1, journaled).

grails.mongodb.options.connectionPoolSettings.maxConnectionIdleTime

Maximum idle time in milliseconds before a pooled connection is closed (0 for unlimited).

0

grails.mongodb.options.connectionPoolSettings.maxConnectionLifeTime

Maximum lifetime in milliseconds of a pooled connection (0 for unlimited).

0

grails.mongodb.options.connectionPoolSettings.maxSize

Maximum number of connections in the connection pool.

100

grails.mongodb.options.connectionPoolSettings.maxWaitTime

Maximum time in milliseconds to wait for a connection from the pool.

120000

grails.mongodb.options.connectionPoolSettings.minSize

Minimum number of connections in the connection pool.

0

grails.mongodb.options.sslSettings.enabled

Whether to enable TLS/SSL for connections to MongoDB.

false

grails.mongodb.options.sslSettings.invalidHostNameAllowed

Whether to allow connections to MongoDB servers with invalid hostnames in TLS certificates.

false

grails.openapi.annotated-only

Whether only actions that declare @Operation, or whose controller declares @Tag, are described.

false

grails.openapi.base-document

A resource location, such as classpath:openapi-base.yml, of a YAML or JSON document the description starts from.

grails.openapi.consumes-to-match

The media types an operation of the default document must consume, exactly.

grails.openapi.display-name

The title of the default document, in place of info.app.name.

grails.openapi.enabled

Whether the OpenAPI description is generated at all.

true

grails.openapi.groups

Groups, each a document of its own, by name, each taking display-name and the same path, package, media type and header settings as the default document.

grails.openapi.headers-to-match

The header conditions an operation of the default document must declare, such as Accept-Version=1.0.

grails.openapi.include-form-actions

Whether the create and edit actions of a RestfulController, which answer HTML forms, are described.

false

grails.openapi.output-directory

Where the generate-open-api command writes the documents.

build/openapi

grails.openapi.output-format

Whether the generate-open-api command writes yaml or json.

yaml

grails.openapi.packages-to-exclude

The packages, with their sub-packages, of the controllers the default document leaves out.

grails.openapi.packages-to-scan

The packages, with their sub-packages, of the controllers the default document describes.

grails.openapi.paths-to-exclude

Ant patterns of the paths the default document leaves out.

grails.openapi.paths-to-match

Ant patterns of the paths the default document describes.

grails.openapi.produces-to-match

The media types an operation of the default document must produce, exactly.