All configuration options
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Agroal - Database connection pool |
Type |
Default |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
If we create a JDBC datasource for this datasource. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The datasource driver class name Environment variable: Show more |
string |
|||||||||||||||||||||
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities. When enabling XA you will need a driver implementing Environment variable: Show more |
|
|
||||||||||||||||||||
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active. Environment variable: Show more |
boolean |
|||||||||||||||||||||
Enable OpenTelemetry JDBC instrumentation. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The datasource URL Environment variable: Show more |
string |
|||||||||||||||||||||
The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot. Environment variable: Show more |
int |
|||||||||||||||||||||
The datasource pool minimum size Environment variable: Show more |
int |
|
||||||||||||||||||||
The datasource pool maximum size Environment variable: Show more |
int |
|
||||||||||||||||||||
The interval at which we validate idle connections in the background. Set to Environment variable: Show more |
|
|||||||||||||||||||||
Perform foreground validation on connections that have been idle for longer than the specified interval. Environment variable: Show more |
||||||||||||||||||||||
The timeout before cancelling the acquisition of a new connection Environment variable: Show more |
|
|||||||||||||||||||||
The interval at which we check for connection leaks. Environment variable: Show more |
|
|||||||||||||||||||||
The interval at which we try to remove idle connections. Environment variable: Show more |
|
|||||||||||||||||||||
The max lifetime of a connection. Environment variable: Show more |
|
|||||||||||||||||||||
The transaction isolation level. Environment variable: Show more |
|
|||||||||||||||||||||
Collect and display extra troubleshooting info on leaked connections. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Allows connections to be flushed upon return to the pool. It’s not enabled by default. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there’s high confidence that no leaks are happening. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Query executed when first using a connection. Environment variable: Show more |
string |
|||||||||||||||||||||
Query executed to validate a connection. Environment variable: Show more |
string |
|||||||||||||||||||||
Forces connection validation prior to acquisition (foreground validation) regardless of the idle status. Because of the overhead of performing validation on every call, it’s recommended to rely on default idle validation instead, and to leave this to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases. Environment variable: Show more |
|
|||||||||||||||||||||
Other unspecified properties to be passed to the JDBC driver when creating new connections. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Enable OpenTelemetry JDBC instrumentation. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Amazon Lambda - Common Deployment |
Type |
Default |
||||||||||||||||||||
Setting to true will start event server even if quarkus.devservices.enabled=false Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Port to access mock event server in dev mode Environment variable: Show more |
int |
|
||||||||||||||||||||
Port to access mock event server in dev mode Environment variable: Show more |
int |
|
||||||||||||||||||||
The exception classes expected to be thrown by the handler. Any exception thrown by the handler that is an instance of a class in this list will not be logged, but will otherwise be handled normally by the lambda runtime. This is useful for avoiding unnecessary stack traces while preserving the ability to log unexpected exceptions. Environment variable: Show more |
list of Class |
|||||||||||||||||||||
The handler name. Handler names are specified on handler classes using the Environment variable: Show more |
string |
|||||||||||||||||||||
Amazon Lambda AWS Gateway REST API |
Type |
Default |
||||||||||||||||||||
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Cognito claim that contains roles you want to map. Defaults to "cognito:groups" Environment variable: Show more |
string |
|
||||||||||||||||||||
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "[^\[\] \t]+" Environment variable: Show more |
string |
|
||||||||||||||||||||
Amazon Lambda HTTP |
Type |
Default |
||||||||||||||||||||
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Cognito claim that contains roles you want to map. Defaults to "cognito:groups" Environment variable: Show more |
string |
|
||||||||||||||||||||
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "[^\[\] \t]+" Environment variable: Show more |
string |
|
||||||||||||||||||||
ArC |
Type |
Default |
||||||||||||||||||||
An unused bean:
Environment variable: Show more |
string |
|
||||||||||||||||||||
If set to true Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true, the bytecode of unproxyable beans will be transformed. This ensures that a proxy/subclass can be created properly. If the value is set to false, then an exception is thrown at build time indicating that a subclass/proxy could not be created. Quarkus performs the following transformations when this setting is enabled:
Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true, the bytecode of private fields that are injection points will be transformed to package private. This ensures that field injection can be performed completely reflection-free. If the value is set to false, then a reflection fallback is used to perform the injection. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true (the default), the build fails if a private method that is neither an observer nor a producer, is annotated with an interceptor binding. An example of this is the use of Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The list of selected alternatives for an application. An element value can be:
Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of Environment variable: Show more |
list of string |
|||||||||||||||||||||
If set to true then Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The list of types that should be excluded from discovery. An element value can be:
If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type. Environment variable: Show more |
list of string |
|||||||||||||||||||||
List of types that should be considered unremovable regardless of whether they are directly used or not. This is a configuration option equivalent to using An element value can be:
If any element value matches a discovered bean, then such a bean is considered unremovable. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The maven groupId of the artifact. Environment variable: Show more |
string |
required |
||||||||||||||||||||
The maven artifactId of the artifact (optional). Environment variable: Show more |
string |
|||||||||||||||||||||
The maven classifier of the artifact (optional). Environment variable: Show more |
string |
|||||||||||||||||||||
If set to true then the container attempts to detect "unused removed beans" false positives during programmatic lookup at runtime. You can disable this feature to conserve some memory when running your application in production. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true then the container attempts to detect wrong usages of annotations and eventually fails the build to prevent unexpected behavior of a Quarkus application. A typical example is Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to The strict mode is mainly introduced to allow passing the CDI Lite TCK. Applications are recommended to use the default, non-strict mode, which makes CDI more convenient to use. The "strictness" of the strict mode (the set of additional validations and the set of disabled improvements on top of the CDI specification) may change over time. Note that Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true then the container monitors business method invocations and fired events during the development mode.
Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true then the dependency graphs are generated and available in the Dev UI. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true then disable Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The list of packages that will not be checked for split package issues. A package string representation can be:
Environment variable: Show more |
list of string |
|||||||||||||||||||||
If set to true and the SmallRye Context Propagation extension is present then the CDI contexts will be propagated by means of the MicroProfile Context Propagation API. Specifically, a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Azure Functions |
Type |
Default |
||||||||||||||||||||
App name for azure function project. This is required setting. Defaults to the base artifact name Environment variable: Show more |
string |
|||||||||||||||||||||
Azure Resource Group for your Azure Functions Environment variable: Show more |
string |
|
||||||||||||||||||||
Specifies the region where your Azure Functions will be hosted; default value is westus. Valid values Environment variable: Show more |
string |
|
||||||||||||||||||||
Specifies whether to disable application insights for your function app Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Specifies the instrumentation key of application insights which will bind to your function app Environment variable: Show more |
string |
|||||||||||||||||||||
Valid values are linux, windows, and docker Environment variable: Show more |
string |
|
||||||||||||||||||||
Valid values are 8, 11, and 17 Environment variable: Show more |
string |
|
||||||||||||||||||||
URL of docker image if deploying via docker Environment variable: Show more |
string |
|||||||||||||||||||||
If using docker, url of registry Environment variable: Show more |
string |
|||||||||||||||||||||
Description of each type can be found here Valid values are
Defaults to "azure_cli" for authentication Environment variable: Show more |
string |
|
||||||||||||||||||||
Filesystem path to properties file if using file type Environment variable: Show more |
string |
|||||||||||||||||||||
Client or App Id required if using managed_identity type Environment variable: Show more |
string |
|||||||||||||||||||||
Tenant Id required if using oauth2 or device_code type Environment variable: Show more |
string |
|||||||||||||||||||||
Specifies the name of the existing App Service Plan when you do not want to create a new one. Environment variable: Show more |
string |
|
||||||||||||||||||||
The app service plan resource group. Environment variable: Show more |
string |
|||||||||||||||||||||
Azure subscription id. Required only if there are more than one subscription in your account Environment variable: Show more |
string |
|||||||||||||||||||||
The pricing tier. Environment variable: Show more |
string |
|||||||||||||||||||||
Port to run azure function in local runtime. Will default to quarkus.http.test-port or 8081 Environment variable: Show more |
int |
|||||||||||||||||||||
Config String for local debug Environment variable: Show more |
string |
|
||||||||||||||||||||
Specifies the application settings for your Azure Functions, which are defined in name-value pairs Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Cache |
Type |
Default |
||||||||||||||||||||
string |
|
|||||||||||||||||||||
Whether or not the cache extension is enabled. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Default configuration applied to all Caffeine caches (lowest precedence) |
Type |
Default |
||||||||||||||||||||
Minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. Environment variable: Show more |
int |
|||||||||||||||||||||
Maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. Environment variable: Show more |
long |
|||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value. Environment variable: Show more |
||||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Environment variable: Show more |
||||||||||||||||||||||
Whether or not metrics are recorded if the application depends on the Micrometer extension. Setting this value to Environment variable: Show more |
boolean |
|||||||||||||||||||||
Minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. Environment variable: Show more |
int |
|||||||||||||||||||||
Maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. Environment variable: Show more |
long |
|||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value. Environment variable: Show more |
||||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Environment variable: Show more |
||||||||||||||||||||||
Whether or not metrics are recorded if the application depends on the Micrometer extension. Setting this value to Environment variable: Show more |
boolean |
|||||||||||||||||||||
Container Image |
Type |
Default |
||||||||||||||||||||
The group the container image will be part of Environment variable: Show more |
string |
|||||||||||||||||||||
The name of the container image. If not set defaults to the application name Environment variable: Show more |
string |
|
||||||||||||||||||||
The tag of the container image. If not set defaults to the application version Environment variable: Show more |
string |
|
||||||||||||||||||||
Additional tags of the container image. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Custom labels to add to the generated image. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
The container registry to use Environment variable: Show more |
string |
|||||||||||||||||||||
Represents the entire image string. If set, then Environment variable: Show more |
string |
|||||||||||||||||||||
The username to use to authenticate with the registry where the built image will be pushed Environment variable: Show more |
string |
|||||||||||||||||||||
The password to use to authenticate with the registry where the built image will be pushed Environment variable: Show more |
string |
|||||||||||||||||||||
Whether or not insecure registries are allowed Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether or not a image build will be performed. Environment variable: Show more |
boolean |
|||||||||||||||||||||
Whether or not an image push will be performed. Environment variable: Show more |
boolean |
|||||||||||||||||||||
The name of the container image extension to use (e.g. docker, podman, jib, s2i). The option will be used in case multiple extensions are present. Environment variable: Show more |
string |
|||||||||||||||||||||
Container Image - Buildpack |
Type |
Default |
||||||||||||||||||||
The buildpacks builder image to use when building the project in jvm mode. Environment variable: Show more |
string |
|
||||||||||||||||||||
The buildpacks builder image to use when building the project in native mode. Environment variable: Show more |
string |
|||||||||||||||||||||
Should the builder image be 'trusted' (use creator lifecycle) Environment variable: Show more |
boolean |
|||||||||||||||||||||
Environment key/values to pass to buildpacks. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image. Environment variable: Show more |
string |
|||||||||||||||||||||
Initial pull timeout for builder/run images, in seconds Environment variable: Show more |
int |
|
||||||||||||||||||||
Increase pull timeout for builder/run images after failure, in seconds Environment variable: Show more |
int |
|
||||||||||||||||||||
How many times to retry an image pull after a failure Environment variable: Show more |
int |
|
||||||||||||||||||||
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the platform will look for 'npipe:///./pipe/docker_engine' for windows, and Environment variable: Show more |
string |
|||||||||||||||||||||
use Daemon mode? Defaults to 'true' Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Use specified docker network during build Environment variable: Show more |
string |
|||||||||||||||||||||
Log level to use.. Defaults to 'info' Environment variable: Show more |
string |
|
||||||||||||||||||||
The username to use to authenticate with the registry used to pull the base JVM image Environment variable: Show more |
string |
|||||||||||||||||||||
The password to use to authenticate with the registry used to pull the base JVM image Environment variable: Show more |
string |
|||||||||||||||||||||
Container Image - Docker |
Type |
Default |
||||||||||||||||||||
Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used. Environment variable: Show more |
string |
|
||||||||||||||||||||
Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used. Environment variable: Show more |
string |
|
||||||||||||||||||||
Build args passed to docker via Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Images to consider as cache sources. Values are passed to Environment variable: Show more |
list of string |
|||||||||||||||||||||
The networking mode for the RUN instructions during build Environment variable: Show more |
string |
|||||||||||||||||||||
Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection. Environment variable: Show more |
string |
|||||||||||||||||||||
Additional arbitrary arguments passed to the executable when building the container image. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/#platform Environment variable: Show more |
list of string |
|||||||||||||||||||||
Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/#output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from. Environment variable: Show more |
string |
|||||||||||||||||||||
Set type of progress output ( Environment variable: Show more |
string |
|||||||||||||||||||||
Container Image - Jib |
Type |
Default |
||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, Environment variable: Show more |
string |
|||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/quarkus-micro-image". You can also use "registry.access.redhat.com/ubi8/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager. Environment variable: Show more |
string |
|
||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: Show more |
list of string |
|
||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application Environment variable: Show more |
list of string |
|||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: Show more |
list of string |
|||||||||||||||||||||
If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point
When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive Environment variable: Show more |
list of string |
|||||||||||||||||||||
If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point
When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive Environment variable: Show more |
list of string |
|||||||||||||||||||||
Environment variables to add to the container image Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
The username to use to authenticate with the registry used to pull the base JVM image Environment variable: Show more |
string |
|||||||||||||||||||||
The password to use to authenticate with the registry used to pull the base JVM image Environment variable: Show more |
string |
|||||||||||||||||||||
list of int |
|
|||||||||||||||||||||
The user to use in generated image Environment variable: Show more |
string |
|||||||||||||||||||||
The working directory to use in the generated image. The default value is chosen to work in accordance with the default base image. Environment variable: Show more |
string |
|
||||||||||||||||||||
Controls the optimization which skips downloading base image layers that exist in a target registry. If the user does not set this property, then read as false. If Environment variable: Show more |
boolean |
|
||||||||||||||||||||
List of target platforms. Each platform is defined using the pattern:
for example:
If not specified, OS default is linux and architecture default is Environment variable: Show more |
list of string |
|||||||||||||||||||||
The path of a file in which the digest of the generated image will be written. If the path is relative, the base path is the output directory of the build tool. Environment variable: Show more |
string |
|
||||||||||||||||||||
The path of a file in which the id of the generated image will be written. If the path is relative, the base path is the output directory of the build tool. Environment variable: Show more |
string |
|
||||||||||||||||||||
Whether or not to operate offline. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Name of binary used to execute the docker commands. This is only used by Jib when the container image is being built locally. Environment variable: Show more |
string |
|||||||||||||||||||||
Sets environment variables used by the Docker executable. This is only used by Jib when the container image is being built locally. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Whether to set the creation time to the actual build time. Otherwise, the creation time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). See Jib FAQ for more information Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether to set the modification time (last modified time) of the files put by Jib in the image to the actual build time. Otherwise, the modification time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). If the modification time is constant (flag is set to false so Unix epoch is used) across two consecutive builds, the docker layer sha256 digest will be different only if the actual files added by Jib to the docker layer were changed. More exactly, having 2 consecutive builds will generate different docker layers only if the actual content of the files within the docker layer was changed. If the current timestamp is used the sha256 digest of the docker layer will always be different even if the content of the files didn’t change. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The directory to use for caching base image layers. If not specified, the Jib default directory is used. Environment variable: Show more |
string |
|||||||||||||||||||||
The directory to use for caching application layers. If not specified, the Jib default directory is used. Environment variable: Show more |
string |
|||||||||||||||||||||
Container Image - OpenShift |
Type |
Default |
||||||||||||||||||||
The build config strategy to use. Environment variable: Show more |
|
|
||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, Environment variable: Show more |
string |
|||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. Environment variable: Show more |
string |
|
||||||||||||||||||||
The default Dockerfile to use for jvm builds Environment variable: Show more |
string |
|
||||||||||||||||||||
The default Dockerfile to use for native builds Environment variable: Show more |
string |
|
||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: Show more |
list of string |
|||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: Show more |
list of string |
|||||||||||||||||||||
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used. Environment variable: Show more |
string |
|||||||||||||||||||||
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar. Environment variable: Show more |
string |
|||||||||||||||||||||
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used. Environment variable: Show more |
string |
|||||||||||||||||||||
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary. Environment variable: Show more |
string |
|||||||||||||||||||||
The build timeout. Environment variable: Show more |
|
|||||||||||||||||||||
The log level of OpenShift build log. Environment variable: Show more |
|
|
||||||||||||||||||||
The image push secret to use for pushing to external registries. (see: https://cloud.redhat.com/blog/pushing-application-images-to-an-external-registry) Environment variable: Show more |
string |
|||||||||||||||||||||
The build config strategy to use. Environment variable: Show more |
|
|
||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, Environment variable: Show more |
string |
|||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build Environment variable: Show more |
string |
|
||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: Show more |
list of string |
|||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: Show more |
list of string |
|||||||||||||||||||||
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used. Environment variable: Show more |
string |
|
||||||||||||||||||||
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar. Environment variable: Show more |
string |
|||||||||||||||||||||
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used. Environment variable: Show more |
string |
|
||||||||||||||||||||
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary. Environment variable: Show more |
string |
|||||||||||||||||||||
The build timeout. Environment variable: Show more |
|
|||||||||||||||||||||
Container Image - Podman |
Type |
Default |
||||||||||||||||||||
Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used. Environment variable: Show more |
string |
|
||||||||||||||||||||
Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used. Environment variable: Show more |
string |
|
||||||||||||||||||||
Build args passed to docker via Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Images to consider as cache sources. Values are passed to Environment variable: Show more |
list of string |
|||||||||||||||||||||
The networking mode for the RUN instructions during build Environment variable: Show more |
string |
|||||||||||||||||||||
Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection. Environment variable: Show more |
string |
|||||||||||||||||||||
Additional arbitrary arguments passed to the executable when building the container image. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Which platform(s) to target during the build. See https://docs.podman.io/en/latest/markdown/podman-build.1.html#platform-os-arch-variant Environment variable: Show more |
list of string |
|||||||||||||||||||||
Require HTTPS and verify certificates when contacting registries Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Core |
Type |
Default |
||||||||||||||||||||
Build time analytics |
Type |
Default |
||||||||||||||||||||
If Build time analytics are disabled. Environment variable: Show more |
boolean |
|||||||||||||||||||||
The Segment base URI. Environment variable: Show more |
string |
|||||||||||||||||||||
The Timeout to send the build time analytics to segment. Environment variable: Show more |
int |
|
||||||||||||||||||||
Application |
Type |
Default |
||||||||||||||||||||
The name of the application. If not set, defaults to the name of the project (except for tests where it is not set at all). Environment variable: Show more |
string |
|||||||||||||||||||||
The version of the application. If not set, defaults to the version of the project (except for tests where it is not set at all). Environment variable: Show more |
string |
|||||||||||||||||||||
The header to use for UI Screen (Swagger UI, GraphQL UI etc). Environment variable: Show more |
string |
|
||||||||||||||||||||
Banner |
Type |
Default |
||||||||||||||||||||
The path of the banner (path relative to root of classpath) which could be provided by user Environment variable: Show more |
string |
|
||||||||||||||||||||
Whether the banner will be displayed Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Bootstrap |
Type |
Default |
||||||||||||||||||||
If set to true, the workspace initialization will be based on the effective POMs (i.e. properly interpolated, including support for profiles) instead of the raw ones. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true, workspace discovery will be enabled for all launch modes. Usually, workspace discovery is enabled by default only for dev and test modes. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to true, workspace loader will log warnings for modules that could not be loaded for some reason instead of throwing errors. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
By default, the bootstrap mechanism will create a shared cache of open JARs for Quarkus classloaders to reduce the total number of opened ZIP FileSystems in dev and test modes. Setting system property Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A temporary option introduced to avoid a logging warning when Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether to throw an error, warn or silently ignore misaligned platform BOM imports Environment variable: Show more |
|
|
||||||||||||||||||||
Builder |
Type |
Default |
||||||||||||||||||||
Dump the graph output to a file. This is useful for debugging. Environment variable: Show more |
string |
|||||||||||||||||||||
Whether to log the cause of a conflict. Environment variable: Show more |
boolean |
|||||||||||||||||||||
Class loading |
Type |
Default |
||||||||||||||||||||
Artifacts that are loaded in a parent first manner. This can be used to work around issues where a given class needs to be loaded by the system ClassLoader. Note that if you make a library parent first all its dependencies should generally also be parent first. Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon.
Environment variable: Show more |
list of string |
|||||||||||||||||||||
Artifacts that are loaded in the runtime ClassLoader in dev mode, so they will be dropped and recreated on change. This is an advanced option, it should only be used if you have a problem with libraries holding stale state between reloads. Note that if you use this any library that depends on the listed libraries will also need to be reloadable. This setting has no impact on production builds. Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon.
Environment variable: Show more |
string |
|||||||||||||||||||||
Artifacts that will never be loaded by the class loader, and will not be packed into the final application. This allows you to explicitly remove artifacts from your application even though they may be present on the class path. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Resources that should be removed/hidden from dependencies. This allows for classes and other resources to be removed from dependencies, so they are not accessible to the application. This is a map of artifact id (in the form group:artifact) to a list of resources to be removed. When running in dev and test mode these resources are hidden from the ClassLoader, when running in production mode these files are removed from the jars that contain them. Note that if you want to remove a class you need to specify the class file name. e.g. to remove Note that for technical reasons this is not supported when running with JBang. Environment variable: Show more |
Map<String,Set<String>> |
|||||||||||||||||||||
Command line |
Type |
Default |
||||||||||||||||||||
The arguments passed to the command line. We don’t make it a list as the args are separated by a space, not a comma. Environment variable: Show more |
string |
|||||||||||||||||||||
Configuration |
Type |
Default |
||||||||||||||||||||
Set this to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A comma separated list of profiles that will be active when Quarkus launches. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Accepts a single configuration profile name. If a configuration property cannot be found in the current active profile, the config performs the same lookup in the profile set by this configuration. Environment variable: Show more |
string |
|||||||||||||||||||||
Additional config locations to be loaded with the Config. The configuration support multiple locations separated by a comma and each must represent a valid Environment variable: Show more |
list of URI |
|||||||||||||||||||||
Validates that a Environment variable: Show more |
boolean |
|||||||||||||||||||||
Enable logging of configuration values lookup in DEBUG log level. Environment variable: Show more |
boolean |
|||||||||||||||||||||
A property that allows accessing a generated UUID. It generates that UUID at startup time. So it changes between two starts including in dev mode. Environment variable: Show more |
string |
|||||||||||||||||||||
Configuration tracking and dumping |
Type |
Default |
||||||||||||||||||||
Whether configuration dumping is enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Directory in which the configuration dump should be stored. If not configured the Environment variable: Show more |
path |
|||||||||||||||||||||
File in which the configuration dump should be stored. If not configured, the Environment variable: Show more |
path |
|||||||||||||||||||||
File name prefix. This option will be ignored in case Environment variable: Show more |
string |
|
||||||||||||||||||||
File name suffix. This option will be ignored in case Environment variable: Show more |
string |
|
||||||||||||||||||||
A list of config properties that should be excluded from the report. GLOB patterns could be used instead of property names. Environment variable: Show more |
list of string |
|||||||||||||||||||||
A list of config properties whose values should be hashed in the report. The values will be hashed using SHA-512 algorithm. GLOB patterns could be used instead of property names. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Whether to use a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
What should happen if the application is started with a different build time configuration than it was compiled against. This may be useful to prevent misconfiguration. If this is set to If this is set to Native tests leveraging`@io.quarkus.test.junit.TestProfile` are always run with Environment variable: Show more |
|
|
||||||||||||||||||||
Console |
Type |
Default |
||||||||||||||||||||
If test results and status should be displayed in the console. If this is false results can still be viewed in the dev console. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Disables the ability to enter input on the console. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Disable the testing status/prompt message at the bottom of the console and log these messages to STDOUT instead. Use this option if your terminal does not support ANSI escape sequences. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If color should be enabled or disabled. If this is not present then an attempt will be made to guess if the terminal supports color Environment variable: Show more |
boolean |
|||||||||||||||||||||
Debugging |
Type |
Default |
||||||||||||||||||||
If set to true, writes a list of all reflective classes to META-INF Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to a directory, all generated classes will be written into that directory Environment variable: Show more |
string |
|||||||||||||||||||||
If set to a directory, all transformed classes (e.g. Panache entities) will be written into that directory Environment variable: Show more |
string |
|||||||||||||||||||||
If set to a directory, ZIG files for generated code will be written into that directory. A ZIG file is a textual representation of the generated code that is referenced in the stacktraces. Environment variable: Show more |
string |
|||||||||||||||||||||
If set to true then dump the build metrics to a JSON file in the build directory. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If set to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Deployment |
Type |
Default |
||||||||||||||||||||
string |
||||||||||||||||||||||
Dev Services |
Type |
Default |
||||||||||||||||||||
Global flag that can be used to disable all Dev Services. If this is set to false then Dev Services will not be used. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Global flag that can be used to force the attachmment of Dev Services to shared network. Default is false. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The timeout for starting a container Environment variable: Show more |
||||||||||||||||||||||
Detection mode of invalid usage of execution model annotations. An execution model annotation is Environment variable: Show more |
|
|
||||||||||||||||||||
IDE |
Type |
Default |
||||||||||||||||||||
The Ide to use to open files from the DevUI. Environment variable: Show more |
|
|
||||||||||||||||||||
Indexing |
Type |
Default |
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The maven groupId of the artifact. Environment variable: Show more |
string |
required |
||||||||||||||||||||
The maven artifactId of the artifact (optional). Environment variable: Show more |
string |
|||||||||||||||||||||
The maven classifier of the artifact (optional). Environment variable: Show more |
string |
|||||||||||||||||||||
Initialization |
Type |
Default |
||||||||||||||||||||
true to quit exit right after the initialization. The option is not meant be used directly by users. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
JNI |
Type |
Default |
||||||||||||||||||||
Paths of library to load. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Launch |
Type |
Default |
||||||||||||||||||||
If set to true, Quarkus will perform re-augmentation (assuming the Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Live reload |
Type |
Default |
||||||||||||||||||||
Whether the live-reload feature should be enabled. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether Quarkus should enable its ability to not do a full restart when changes to classes are compatible with JVM instrumentation. If this is set to true, Quarkus will perform class redefinition when possible. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The names of additional resource files to watch for changes, triggering a reload on change. Directories are not supported. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Password used to use to connect to the remote dev-mode application Environment variable: Show more |
string |
|||||||||||||||||||||
URL used to use to connect to the remote dev-mode application Environment variable: Show more |
string |
|||||||||||||||||||||
The amount of time to wait for a remote dev connect or reconnect Environment variable: Show more |
|
|||||||||||||||||||||
The amount of time to wait between attempts when connecting to the server side of remote dev Environment variable: Show more |
|
|||||||||||||||||||||
The maximum number of attempts when connecting to the server side of remote dev Environment variable: Show more |
int |
|
||||||||||||||||||||
Localization |
Type |
Default |
||||||||||||||||||||
The set of supported locales that can be consumed by the extensions. The locales must be specified in the IETF BCP 47 format e.g. en-US or fr-FR. For instance, the Hibernate Validator extension makes use of it. Native-image build uses it to define additional locales that are supposed to be available at runtime. A special string "all" is translated as ROOT Locale and then used in native-image to include all locales. Image size penalty applies. Environment variable: Show more |
list of Locale |
|
||||||||||||||||||||
Default locale that can be consumed by the extensions. The locale must be specified in the IETF BCP 47 format e.g. en-US or fr-FR. For instance, the Hibernate Validator extension makes use of it. Native-image build uses this property to derive Environment variable: Show more |
|
|||||||||||||||||||||
Logging |
Type |
Default |
||||||||||||||||||||
If enabled and a metrics extension is present, logging metrics are published. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The default minimum log level. Environment variable: Show more |
|
|||||||||||||||||||||
This will decorate the stacktrace in dev mode to show the line in the code that cause the exception Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log level of the root category, which is used as the default log level for all categories. <p> JBoss Logging supports Apache-style log levels: <p> * {@link org.jboss.logmanager.Level#FATAL} * {@link org.jboss.logmanager.Level#ERROR} * {@link org.jboss.logmanager.Level#WARN} * {@link org.jboss.logmanager.Level#INFO} * {@link org.jboss.logmanager.Level#DEBUG} * {@link org.jboss.logmanager.Level#TRACE} In addition, it also supports the standard JDK log levels. Environment variable: Show more |
|
|||||||||||||||||||||
The names of additional handlers to link to the root category. These handlers are defined in consoleHandlers, fileHandlers, or syslogHandlers. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The minimum log level for this category. By default, all categories are configured with To get runtime logging below As an example, to get Environment variable: Show more |
InheritableLevel |
|
||||||||||||||||||||
The log level for this category. Note that to get log levels below Environment variable: Show more |
InheritableLevel |
|
||||||||||||||||||||
The names of the handlers to link to this category. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Specify whether this logger should send its output to its parent Logger Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If console logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If console logging should go to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: Show more |
string |
|
||||||||||||||||||||
The console log level. Environment variable: Show more |
|
|||||||||||||||||||||
Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: Show more |
int |
|
||||||||||||||||||||
The name of the filter to link to the console handler. Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If file logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
string |
|
|||||||||||||||||||||
The level of logs to be written into the file. Environment variable: Show more |
|
|||||||||||||||||||||
The name of the file in which logs will be written. Environment variable: Show more |
|
|||||||||||||||||||||
The name of the filter to link to the file handler. Environment variable: Show more |
string |
|||||||||||||||||||||
The character encoding used Environment variable: Show more |
||||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
The maximum log file size, after which a rotation is executed. Note that the file is rotated after the log record is written. Thus, this isn’t a hard maximum on the file size; rather, it’s a hard minimum on the size of the file before it is rotated. Environment variable: Show more |
|
|||||||||||||||||||||
The maximum number of backups to keep. Environment variable: Show more |
int |
|
||||||||||||||||||||
The file handler rotation file suffix. When used, the file will be rotated based on its suffix. The suffix must be in a date-time format that is understood by Example fileSuffix: .yyyy-MM-dd Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates whether to rotate log files on server initialization. You need to either set a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If syslog logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The IP address and port of the Syslog server Environment variable: Show more |
host:port |
|
||||||||||||||||||||
The app name used when formatting the message in RFC5424 format Environment variable: Show more |
string |
|||||||||||||||||||||
The name of the host the messages are being sent from Environment variable: Show more |
string |
|||||||||||||||||||||
Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 Environment variable: Show more |
|
|
||||||||||||||||||||
Set the Environment variable: Show more |
|
|
||||||||||||||||||||
Sets the protocol used to connect to the Syslog server Environment variable: Show more |
|
|
||||||||||||||||||||
If enabled, the message being sent is prefixed with the size of the message Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enables or disables blocking when attempting to reconnect a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log message format Environment variable: Show more |
string |
|
||||||||||||||||||||
The log level specifying what message levels will be logged by the Syslog logger Environment variable: Show more |
|
|||||||||||||||||||||
The name of the filter to link to the file handler. Environment variable: Show more |
string |
|||||||||||||||||||||
The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message. If not set, the default value is Environment variable: Show more |
||||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If socket logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The IP address and port of the server receiving the logs Environment variable: Show more |
host:port |
|
||||||||||||||||||||
Sets the protocol used to connect to the syslog server Environment variable: Show more |
|
|
||||||||||||||||||||
Enables or disables blocking when attempting to reconnect a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log message format Environment variable: Show more |
string |
|
||||||||||||||||||||
The log level specifying, which message levels will be logged by socket logger Environment variable: Show more |
|
|||||||||||||||||||||
The name of the filter to link to the file handler. Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If console logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If console logging should go to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: Show more |
string |
|
||||||||||||||||||||
The console log level. Environment variable: Show more |
|
|||||||||||||||||||||
Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: Show more |
int |
|
||||||||||||||||||||
The name of the filter to link to the console handler. Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If file logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log format Environment variable: Show more |
string |
|
||||||||||||||||||||
The level of logs to be written into the file. Environment variable: Show more |
|
|||||||||||||||||||||
The name of the file in which logs will be written. Environment variable: Show more |
|
|||||||||||||||||||||
The name of the filter to link to the file handler. Environment variable: Show more |
string |
|||||||||||||||||||||
The character encoding used Environment variable: Show more |
||||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
The maximum log file size, after which a rotation is executed. Note that the file is rotated after the log record is written. Thus, this isn’t a hard maximum on the file size; rather, it’s a hard minimum on the size of the file before it is rotated. Environment variable: Show more |
|
|||||||||||||||||||||
The maximum number of backups to keep. Environment variable: Show more |
int |
|
||||||||||||||||||||
The file handler rotation file suffix. When used, the file will be rotated based on its suffix. The suffix must be in a date-time format that is understood by Example fileSuffix: .yyyy-MM-dd Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates whether to rotate log files on server initialization. You need to either set a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If syslog logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The IP address and port of the Syslog server Environment variable: Show more |
host:port |
|
||||||||||||||||||||
The app name used when formatting the message in RFC5424 format Environment variable: Show more |
string |
|||||||||||||||||||||
The name of the host the messages are being sent from Environment variable: Show more |
string |
|||||||||||||||||||||
Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 Environment variable: Show more |
|
|
||||||||||||||||||||
Set the Environment variable: Show more |
|
|
||||||||||||||||||||
Sets the protocol used to connect to the Syslog server Environment variable: Show more |
|
|
||||||||||||||||||||
If enabled, the message being sent is prefixed with the size of the message Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enables or disables blocking when attempting to reconnect a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log message format Environment variable: Show more |
string |
|
||||||||||||||||||||
The log level specifying what message levels will be logged by the Syslog logger Environment variable: Show more |
|
|||||||||||||||||||||
The name of the filter to link to the file handler. Environment variable: Show more |
string |
|||||||||||||||||||||
The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message. If not set, the default value is Environment variable: Show more |
||||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If socket logging should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The IP address and port of the server receiving the logs Environment variable: Show more |
host:port |
|
||||||||||||||||||||
Sets the protocol used to connect to the syslog server Environment variable: Show more |
|
|
||||||||||||||||||||
Enables or disables blocking when attempting to reconnect a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The log message format Environment variable: Show more |
string |
|
||||||||||||||||||||
The log level specifying, which message levels will be logged by socket logger Environment variable: Show more |
|
|||||||||||||||||||||
The name of the filter to link to the file handler. Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates whether to log asynchronously Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The queue length to use before flushing writing Environment variable: Show more |
int |
|
||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: Show more |
|
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The message prefix to match Environment variable: Show more |
list of string |
|
||||||||||||||||||||
The new log level for the filtered message. Defaults to DEBUG. Environment variable: Show more |
|
|||||||||||||||||||||
Naming |
Type |
Default |
||||||||||||||||||||
By default, Quarkus will install a non-functional JNDI initial context, to help mitigate against Log4Shell style attacks. If your application does need to use JNDI you can change this flag. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Native executables |
Type |
Default |
||||||||||||||||||||
Set to enable native-image building using GraalVM. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set to prevent the native-image process from actually building the native image. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Comma-separated, additional arguments to pass to the build process. If an argument includes the Environment variable: Show more |
list of string |
|||||||||||||||||||||
If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Defines the file encoding as in Environment variable: Show more |
string |
|
||||||||||||||||||||
If all character sets should be added to the native executable. Note that some extensions (e.g. the Oracle JDBC driver) also take this setting into account to enable support for all charsets at the extension level. This increases image size. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The location of the Graal distribution Environment variable: Show more |
string |
|
||||||||||||||||||||
The location of the JDK Environment variable: Show more |
|
|||||||||||||||||||||
The maximum Java heap to be used during the native image generation Environment variable: Show more |
string |
|||||||||||||||||||||
If the native image build should wait for a debugger to be attached before running. This is an advanced option and is generally only intended for those familiar with GraalVM internals Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If the debug port should be published when building with docker and debug-build-process is true Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If isolates should be enabled Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If a JVM based 'fallback image' should be created if native image fails. This is not recommended, as this is functionally the same as just running the application in a JVM Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If all META-INF/services entries should be automatically registered Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If the bytecode of all proxies should be dumped for inspection Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If this build should be done using a container runtime. Unless container-runtime is also set, docker will be used by default. If docker is not available or is an alias to podman, podman will be used instead as the default. Environment variable: Show more |
boolean |
|||||||||||||||||||||
Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for performance reasons. However, some systems can only run position-independent executables, so this option enables the generation of such native executables. Environment variable: Show more |
boolean |
|||||||||||||||||||||
Generate instructions for a specific machine type. Defaults to Environment variable: Show more |
string |
|||||||||||||||||||||
If this build is done using a remote docker daemon. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The docker image to use to do the image build. It can be one of Environment variable: Show more |
string |
|
||||||||||||||||||||
The strategy for pulling the builder image during the build. Defaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated. Use 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited. Use 'never' to fail the build if there is no image locally. Environment variable: Show more |
|
|
||||||||||||||||||||
The container runtime (e.g. docker) that is used to do an image based build. If this is set then a container build is always done. Environment variable: Show more |
|
|||||||||||||||||||||
Options to pass to the container runtime Environment variable: Show more |
list of string |
|||||||||||||||||||||
Enable monitoring various monitoring options. The value should be comma separated.
Environment variable: Show more |
list of |
|||||||||||||||||||||
If the reports on call paths and included packages/classes/methods should be generated Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If exceptions should be reported with a full stack trace Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident. Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Don’t build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A comma separated list of globs to match resource paths that should be added to the native image. Use slash ( By default, no resources are included. Example: Given that you have
the files Supported glob features
Note that there are three levels of escaping when passing this option via
All three levels use backslash ( Note that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient. Environment variable: Show more |
list of string |
|||||||||||||||||||||
A comma separated list of globs to match resource paths that should not be added to the native image. Use slash ( Please refer to By default, no resources are excluded. Example: Given that you have
the resource Environment variable: Show more |
list of string |
|||||||||||||||||||||
If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Generate the report files for GraalVM Dashboard. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Include a reasons entries in the generated json configuration files. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The compression level in [1, 10]. 10 means best. Higher compression level requires more time to compress the executable. Environment variable: Show more |
int |
|||||||||||||||||||||
Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in https://github.com/upx/upx/blob/devel/doc/upx.pod. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process. Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Packaging the application |
Type |
Default |
||||||||||||||||||||
If set to false, no JAR will be produced. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The JAR output type to use. Environment variable: Show more |
|
|
||||||||||||||||||||
Whether the created jar will be compressed. This setting is not used when building a native image Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Specify whether the Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Custom manifest attributes to be added to the main section of the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.attributes."Entry-key1"=Value1 quarkus.package.jar.manifest.attributes."Entry-key2"=Value2 Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Custom manifest sections to be added to the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key1"=Value1 quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key2"=Value2 Environment variable: Show more |
Map<String,Map<String,String>> |
|||||||||||||||||||||
Files that should not be copied to the output artifact. Environment variable: Show more |
list of string |
|||||||||||||||||||||
List of all the dependencies that have been defined as optional to include into the final package of the application. Each optional dependency needs to be expressed in the following format:
With the classifier and type being optional (note that the brackets ( If the type is missing, the artifact is assumed to be of type This parameter is optional; if absent, no optional dependencies will be included into the final package of the application. For backward compatibility reasons, this parameter is ignored by default and can be enabled by setting the parameter This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies. Environment variable: Show more |
list of GACT |
|||||||||||||||||||||
Flag indicating whether the optional dependencies should be filtered out or not. This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Indicates whether the generated JAR file should have the runner suffix appended. Only applicable to the Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether to automate the creation of AppCDS. Furthermore, this option only works for Java 11+ and is considered experimental for the time being. Finally, care must be taken to use the same exact JVM version when building and running the application. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
When AppCDS generation is enabled, if this property is set, then the JVM used to generate the AppCDS file will be the JVM present in the container image. The builder image is expected to have the 'java' binary on its PATH. This flag is useful when the JVM to be used at runtime is not the same exact JVM version as the one used to build the jar. Note that this property is consulted only when Environment variable: Show more |
string |
|||||||||||||||||||||
Whether creation of the AppCDS archive should run in a container if available. Normally, if either a suitable container image to use to create the AppCDS archive can be determined automatically or if one is explicitly set using the If this option is set to Ignored if Environment variable: Show more |
boolean |
|
||||||||||||||||||||
This is an advanced option that only takes effect for development mode. If this is specified a directory of this name will be created in the jar distribution. Users can place jar files in this directory, and when re-augmentation is performed these will be processed and added to the class-path. Note that before reaugmentation has been performed these jars will be ignored, and if they are updated the app should be reaugmented again. Environment variable: Show more |
string |
|||||||||||||||||||||
If this option is true then a list of all the coordinates of the artifacts that made up this image will be included in the quarkus-app directory. This list can be used by vulnerability scanners to determine if your application has any vulnerable dependencies. Only supported for the Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enable decompilation of generated and transformed bytecode into a filesystem. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The directory into which to save the decompilation output. A relative path is understood as relative to the build directory. Environment variable: Show more |
string |
|
||||||||||||||||||||
The directory into which to save the decompilation tool if it doesn’t exist locally. Environment variable: Show more |
string |
|
||||||||||||||||||||
The entry point of the application. This can either be a fully qualified name of a standard Java class with a main method, or If your application has main classes annotated with Environment variable: Show more |
string |
|||||||||||||||||||||
The directory into which the output package(s) should be written. Relative paths are resolved from the build systems target directory. Environment variable: Show more |
path |
|||||||||||||||||||||
The name of the final artifact, excluding the suffix and file extension. Environment variable: Show more |
string |
|||||||||||||||||||||
Setting this switch to For example, if using Maven, enabling this feature will result in the classes in Setting this to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The suffix that is applied to the runner artifact’s base file name. Environment variable: Show more |
string |
|
||||||||||||||||||||
Platform |
Type |
Default |
||||||||||||||||||||
groupId of the platform to use Environment variable: Show more |
string |
|
||||||||||||||||||||
artifactId of the platform to use Environment variable: Show more |
string |
|
||||||||||||||||||||
version of the platform to use Environment variable: Show more |
string |
|
||||||||||||||||||||
Shutdown |
Type |
Default |
||||||||||||||||||||
Whether Quarkus should wait between shutdown being requested and actually initiated. This delay gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The timeout to wait for running requests to finish. If this is not set then the application will exit immediately. Setting this timeout will incur a small performance penalty, as it requires active requests to be tracked. Environment variable: Show more |
||||||||||||||||||||||
Delay between shutdown being requested and actually initiated. Also called the pre-shutdown phase. In pre-shutdown, the server continues working as usual, except a readiness probe starts reporting "down" (if the Environment variable: Show more |
||||||||||||||||||||||
SnapStart |
Type |
Default |
||||||||||||||||||||
Enable/Disable SnapStart integration Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default) Environment variable: Show more |
boolean |
|||||||||||||||||||||
Will do a classpath search for all Environment variable: Show more |
boolean |
|
||||||||||||||||||||
if preloading classes, specify whether to do static initialization when preloading these classes. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Start the full application during the snapshotting process. In other words, when enabled, it performs Environment variable: Show more |
boolean |
|
||||||||||||||||||||
When SnapStart is enabled, it generates the application class list, so it can be preloaded. Only used if Environment variable: Show more |
boolean |
|
||||||||||||||||||||
SSL |
Type |
Default |
||||||||||||||||||||
boolean |
||||||||||||||||||||||
Testing |
Type |
Default |
||||||||||||||||||||
If continuous testing is enabled. The default value is 'paused', which will allow you to start testing from the console or the Dev UI, but will not run tests on startup. If this is set to 'enabled' then testing will start as soon as the application has started. If this is 'disabled' then continuous testing is not enabled, and can’t be enabled without restarting the application. Environment variable: Show more |
|
|
||||||||||||||||||||
If output from the running tests should be displayed in the console. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Tags that should be included for continuous testing. This supports JUnit Tag Expressions. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Tags that should be excluded by default with continuous testing. This is ignored if include-tags has been set. Defaults to 'slow'. This supports JUnit Tag Expressions. Environment variable: Show more |
list of string |
|
||||||||||||||||||||
Tests that should be included for continuous testing. This is a regular expression and is matched against the test class name (not the file name). Environment variable: Show more |
string |
|||||||||||||||||||||
Tests that should be excluded with continuous testing. This is a regular expression and is matched against the test class name (not the file name). This is ignored if include-pattern has been set. Environment variable: Show more |
string |
|
||||||||||||||||||||
Test engine ids that should be included for continuous testing. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Test engine ids that should be excluded by default with continuous testing. This is ignored if include-engines has been set. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Changes tests to use the 'flat' ClassPath used in Quarkus 1.x versions. This means all Quarkus and test classes are loaded in the same ClassLoader, however it means you cannot use continuous testing. Note that if you find this necessary for your application then you may also have problems running in development mode, which cannot use a flat class path. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The profile to use when testing the native image Environment variable: Show more |
string |
|
||||||||||||||||||||
The profile to use when testing using Environment variable: Show more |
string |
|
||||||||||||||||||||
A comma separated list of profiles (dev, test, prod or custom profiles) to use when testing using @QuarkusTest Environment variable: Show more |
list of string |
|
||||||||||||||||||||
The tags this profile is associated with. When the Environment variable: Show more |
list of string |
|||||||||||||||||||||
Controls the container network to be used when @QuarkusIntegration needs to launch the application in a container. This setting only applies if Quarkus does not need to use a shared network - which is the case if DevServices are used when running the test. Environment variable: Show more |
string |
|||||||||||||||||||||
Set additional ports to be exposed when @QuarkusIntegration needs to launch the application in a container. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
A set of labels to add to the launched container Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
A set of volume mounts to add to the launched container Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Additional launch parameters to be used when Quarkus launches the produced artifact for Environment variable: Show more |
list of string |
|||||||||||||||||||||
Additional environment variables to be set in the process that Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Used in Environment variable: Show more |
|
|||||||||||||||||||||
Configures the hang detection in @QuarkusTest. If no activity happens (i.e. no test callbacks are called) over this period then QuarkusTest will dump all threads stack traces, to help diagnose a potential hang. Note that the initial timeout (before Quarkus has started) will only apply if provided by a system property, as it is not possible to read all config sources until Quarkus has booted. Environment variable: Show more |
|
|||||||||||||||||||||
The type of test to run, this can be either: quarkus-test: Only runs Environment variable: Show more |
|
|
||||||||||||||||||||
If this is true then only the tests from the main application module will be run (i.e. the module that is currently running mvn quarkus:dev). If this is false then tests from all dependency modules will be run as well. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Modules that should be included for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. Environment variable: Show more |
string |
|||||||||||||||||||||
Modules that should be excluded for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. This is ignored if include-module-pattern has been set. Environment variable: Show more |
string |
|||||||||||||||||||||
If the test callbacks should be invoked for the integration tests (tests annotated with Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Core thread pool |
Type |
Default |
||||||||||||||||||||
The core thread pool size. This number of threads will always be kept alive. Environment variable: Show more |
int |
|
||||||||||||||||||||
Prefill core thread pool. The core thread pool will be initialised with the core number of threads at startup Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The maximum number of threads. If this is not specified then it will be automatically sized to the greatest of 8 * the number of available processors and 200. For example if there are 4 processors the max threads will be 200. If there are 48 processors it will be 384. Environment variable: Show more |
int |
|||||||||||||||||||||
The queue size. For most applications this should be unbounded Environment variable: Show more |
int |
|||||||||||||||||||||
The executor growth resistance. A resistance factor applied after the core pool is full; values applied here will cause that fraction of submissions to create new threads when no idle thread is available. A value of Environment variable: Show more |
float |
|
||||||||||||||||||||
The shutdown timeout. If all pending work has not been completed by this time then additional threads will be spawned to attempt to finish any pending tasks, and the shutdown process will continue Environment variable: Show more |
|
|||||||||||||||||||||
The amount of time to wait for thread pool shutdown before tasks should be interrupted. If this value is greater than or equal to the value for Environment variable: Show more |
|
|||||||||||||||||||||
The frequency at which the status of the thread pool should be checked during shutdown. Information about waiting tasks and threads will be checked and possibly logged at this interval. Setting this key to an empty value disables the shutdown check interval. Environment variable: Show more |
|
|||||||||||||||||||||
The amount of time a thread will stay alive with no work. Environment variable: Show more |
|
|||||||||||||||||||||
CycloneDX |
Type |
Default |
||||||||||||||||||||
Whether to skip SBOM generation Environment variable: Show more |
boolean |
|
||||||||||||||||||||
SBOM file format. Supported formats are {code json} and {code xml}. The default format is JSON. If both are desired then Environment variable: Show more |
string |
|
||||||||||||||||||||
CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library. Environment variable: Show more |
string |
|||||||||||||||||||||
Whether to include the license text into generated SBOMs. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Datasources |
Type |
Default |
||||||||||||||||||||
Whether or not a health check is published in case the smallrye-health extension is present. This is a global setting and is not specific to a datasource. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether or not datasource metrics are published in case a metrics extension is present. This is a global setting and is not specific to a datasource.
Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The kind of database we will connect to (e.g. h2, postgresql…). Environment variable: Show more |
string |
|||||||||||||||||||||
The version of the database we will connect to (e.g. '10.0').
As a rule, the version set here should be as high as possible, but must be lower than or equal to the version of any database your application will connect to. A high version will allow better performance and using more features (e.g. Hibernate ORM may generate more efficient SQL, avoid workarounds and take advantage of more database features), but if it is higher than the version of the database you want to connect to, it may lead to runtime exceptions (e.g. Hibernate ORM may generate invalid SQL that your database will reject). Some extensions (like the Hibernate ORM extension) will try to check this version against the actual database version on startup, leading to a startup failure when the actual version is lower or simply a warning in case the database cannot be reached. The default for this property is specific to each extension; the Hibernate ORM extension will default to the oldest version it supports. Environment variable: Show more |
string |
|||||||||||||||||||||
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled. By default, the health check includes all configured data sources (if it is enabled). Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether this datasource should be active at runtime. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The datasource username Environment variable: Show more |
string |
|||||||||||||||||||||
The datasource password Environment variable: Show more |
string |
|||||||||||||||||||||
The credentials provider name Environment variable: Show more |
string |
|||||||||||||||||||||
The credentials provider bean name. This is a bean name (as in For Vault, the credentials provider bean name is Environment variable: Show more |
string |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Whether this Dev Service should start with the application in dev mode or tests. Dev Services are enabled by default unless connection configuration (e.g. the JDBC URL or reactive client URL) is set explicitly. Environment variable: Show more |
boolean |
|||||||||||||||||||||
The container image name for container-based Dev Service providers. This has no effect if the provider is not a container-based database, such as H2 or Derby. Environment variable: Show more |
string |
|||||||||||||||||||||
Environment variables that are passed to the container. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Generic properties that are passed for additional container configuration. Properties defined here are database-specific and are interpreted specifically in each database dev service implementation. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Generic properties that are added to the database connection URL. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: Show more |
int |
|||||||||||||||||||||
The container start command to use for container-based Dev Service providers. This has no effect if the provider is not a container-based database, such as H2 or Derby. Environment variable: Show more |
string |
|||||||||||||||||||||
The database name to use if this Dev Service supports overriding it. Environment variable: Show more |
string |
|||||||||||||||||||||
The username to use if this Dev Service supports overriding it. Environment variable: Show more |
string |
|||||||||||||||||||||
The password to use if this Dev Service supports overriding it. Environment variable: Show more |
string |
|||||||||||||||||||||
The path to a SQL script to be loaded from the classpath and applied to the Dev Service database. This has no effect if the provider is not a container-based database, such as H2 or Derby. Environment variable: Show more |
string |
|||||||||||||||||||||
The volumes to be mapped to the container. The map key corresponds to the host location; the map value is the container location. If the host location starts with "classpath:", the mapping loads the resource from the classpath with read-only permission. When using a file system location, the volume will be generated with read-write permission, potentially leading to data loss or modification in your file system. This has no effect if the provider is not a container-based database, such as H2 or Derby. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Whether to keep Dev Service containers running after a dev mode session or test suite execution to reuse them in the next dev mode session or test suite execution. Within a dev mode session or test suite execution, Quarkus will always reuse Dev Services as long as their configuration (username, password, environment, port bindings, …) did not change. This feature is specifically about keeping containers running when Quarkus is not running to reuse them across runs.
This configuration property is set to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether the logs should be consumed by the JBoss logger. This has no effect if the provider is not a container-based database, such as H2 or Derby. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
DevServices - Keycloak |
Type |
Default |
||||||||||||||||||||
Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like Environment variable: Show more |
string |
|
||||||||||||||||||||
Indicates if a Keycloak-X image is used. By default, the image is identified by Environment variable: Show more |
boolean |
|||||||||||||||||||||
Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The value of the Environment variable: Show more |
string |
|
||||||||||||||||||||
A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties. To learn more about Keycloak realm files, consult the Importing and Exporting Keycloak Realms documentation. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
The Environment variable: Show more |
string |
|||||||||||||||||||||
Show Keycloak log messages with a "Keycloak:" prefix. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Keycloak start command. Use this property to experiment with Keycloak start options, see Environment variable: Show more |
string |
|||||||||||||||||||||
The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the Environment variable: Show more |
string |
|||||||||||||||||||||
Specifies whether to create the Keycloak realm when no realm file is found at the Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Specifies whether to create the default client id Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Specifies whether to start the container even if the default OIDC tenant is disabled. Setting this property to true may be necessary in a multi-tenant OIDC setup, especially when OIDC tenants are created dynamically. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A map of Keycloak usernames to passwords. If empty, default users Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
A map of roles for Keycloak users. If empty, default roles are assigned: Environment variable: Show more |
Map<String,List<String>> |
|||||||||||||||||||||
The specific port for the dev service to listen on. If not specified, a random port is selected. Environment variable: Show more |
int |
|||||||||||||||||||||
Environment variables to be passed to the container. Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
Memory limit for Keycloak container If not specified, 750MiB is the default memory limit. Environment variable: Show more |
|
|||||||||||||||||||||
The WebClient timeout. Use this property to configure how long an HTTP client used by OIDC dev service admin client will wait for a response from OpenId Connect Provider when acquiring admin token and creating realm. Environment variable: Show more |
|
|||||||||||||||||||||
Eclipse Vert.x - HTTP |
Type |
Default |
||||||||||||||||||||
The number of history log entries to remember. Environment variable: Show more |
int |
|
||||||||||||||||||||
Show the JsonRPC Log. Useful for extension developers Environment variable: Show more |
boolean |
|
||||||||||||||||||||
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex) By default localhost and 127.0.0.1 will always be allowed Environment variable: Show more |
list of string |
|||||||||||||||||||||
Enable CORS filter. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The HTTP root path. All web content will be served relative to this root path. Environment variable: Show more |
string |
|
||||||||||||||||||||
If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required. Environment variable: Show more |
boolean |
|||||||||||||||||||||
If form authentication is enabled. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The post location. Environment variable: Show more |
string |
|
||||||||||||||||||||
If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Require that all registered HTTP authentication mechanisms must complete the authentication. Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases,
This property is false by default which means that the authentication process is complete as soon as the first This property will be ignored if the path specific authentication is enabled. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Configures the engine to require/request client authentication. When set to Environment variable: Show more |
|
|
||||||||||||||||||||
If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,
and openapi are deployed under this path by default.
<p>
* Relative path (Default, Environment variable: Show more |
string |
|
||||||||||||||||||||
The REST Assured client timeout for testing. Environment variable: Show more |
|
|||||||||||||||||||||
If enabled then the response body is compressed if the Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations Environment variable: Show more |
boolean |
|
||||||||||||||||||||
When enabled, vert.x will decompress the request’s body if it’s compressed. Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project. Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client’s capabilities and marks it in a response header, e.g.: content-encoding: gzip Environment variable: Show more |
list of string |
|
||||||||||||||||||||
List of media types for which the compression should be enabled automatically, unless declared explicitly via Environment variable: Show more |
list of string |
|
||||||||||||||||||||
The compression level used when compression support is enabled. Environment variable: Show more |
int |
|||||||||||||||||||||
boolean |
|
|||||||||||||||||||||
int |
|
|||||||||||||||||||||
The HTTP port used to run tests Environment variable: Show more |
int |
|
||||||||||||||||||||
The HTTP host In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. As an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible. Environment variable: Show more |
string |
required |
||||||||||||||||||||
Used when Environment variable: Show more |
string |
|||||||||||||||||||||
Enable listening to host:port Environment variable: Show more |
boolean |
|
||||||||||||||||||||
int |
|
|||||||||||||||||||||
The HTTPS port used to run tests Environment variable: Show more |
int |
|
||||||||||||||||||||
Used when Environment variable: Show more |
boolean |
|||||||||||||||||||||
If insecure (i.e. http rather than https) requests are allowed. If this is Default is Environment variable: Show more |
|
|||||||||||||||||||||
If this is true (the default) then HTTP/2 will be enabled. Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enables or Disable the HTTP/2 Push feature. This setting can be used to disable server push. The server will not send a Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The Please note that using MicroProfile Environment variable: Show more |
string |
|||||||||||||||||||||
The credentials provider bean name. This is a bean name (as in For Vault, the credentials provider bean name is Environment variable: Show more |
string |
|||||||||||||||||||||
The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled. Environment variable: Show more |
list of path |
|||||||||||||||||||||
The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled. The order of the key files must match the order of the certificates. Environment variable: Show more |
list of path |
|||||||||||||||||||||
An optional keystore that holds the certificate information instead of specifying separate files. Environment variable: Show more |
path |
|||||||||||||||||||||
An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name. Environment variable: Show more |
string |
|||||||||||||||||||||
An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. Environment variable: Show more |
string |
|||||||||||||||||||||
A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from Environment variable: Show more |
string |
|
||||||||||||||||||||
A parameter to specify a Environment variable: Show more |
string |
|||||||||||||||||||||
An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined. Environment variable: Show more |
string |
|||||||||||||||||||||
An optional parameter to define the password for the key, in case it is different from Environment variable: Show more |
string |
|||||||||||||||||||||
A parameter to specify a Environment variable: Show more |
string |
|||||||||||||||||||||
An optional trust store that holds the certificate information of the trusted certificates. Environment variable: Show more |
path |
|||||||||||||||||||||
An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format. Environment variable: Show more |
list of path |
|||||||||||||||||||||
An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name. Environment variable: Show more |
string |
|||||||||||||||||||||
An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type. Environment variable: Show more |
string |
|||||||||||||||||||||
A parameter to specify the password of the trust store file. If not given, it might be retrieved from Environment variable: Show more |
string |
|||||||||||||||||||||
A parameter to specify a Environment variable: Show more |
string |
|||||||||||||||||||||
An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store. Environment variable: Show more |
string |
|||||||||||||||||||||
When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified. Also, the update can also occur when the TLS certificate is configured using paths (and not in-memory). The reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.
Environment variable: Show more |
||||||||||||||||||||||
The cipher suites to use. If none is given, a reasonable default is selected. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Sets the ordered list of enabled SSL/TLS protocols. If not set, it defaults to Note that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol. Environment variable: Show more |
list of string |
|
||||||||||||||||||||
Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The name of the TLS configuration to use. If not set and the default TLS configuration is configured ( If no TLS configuration is set, and Environment variable: Show more |
string |
|||||||||||||||||||||
When set to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops. In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads. Environment variable: Show more |
int |
|||||||||||||||||||||
Http connection idle timeout Environment variable: Show more |
|
|||||||||||||||||||||
Http connection read timeout for blocking IO. This is the maximum amount of time a thread will wait for data, before an IOException will be thrown and the connection closed. Environment variable: Show more |
|
|||||||||||||||||||||
Whether the files sent using If Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The directory where the files sent using Either an absolute path or a path relative to the current directory of the application process. Environment variable: Show more |
string |
|
||||||||||||||||||||
Whether the form attributes should be added to the request parameters. If Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether the uploaded files should be removed after serving the request. If Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether the body buffer should pre-allocated based on the If Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A comma-separated list of Environment variable: Show more |
list of string |
|||||||||||||||||||||
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here. If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons Environment variable: Show more |
string |
|||||||||||||||||||||
Enable socket reuse port (linux/macOs native transport only) Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enable tcp quick ack (linux native transport only) Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enable tcp cork (linux native transport only) Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Enable tcp fast open (linux native transport only) Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected Environment variable: Show more |
int |
|
||||||||||||||||||||
Set the SETTINGS_INITIAL_WINDOW_SIZE HTTP/2 setting. Indicates the sender’s initial window size (in octets) for stream-level flow control. The initial value is Environment variable: Show more |
int |
|||||||||||||||||||||
Path to a unix domain socket Environment variable: Show more |
string |
|
||||||||||||||||||||
Enable listening to host:port Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If this is true then the request start time will be recorded to enable logging of total request time. This has a small performance penalty, so is disabled by default. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Provides a hint (optional) for the default content type of responses generated for the errors not handled by the application. If the client requested a supported content-type in request headers (e.g. "Accept: application/json", "Accept: text/html"), Quarkus will use that content type. Otherwise, it will default to the content type configured here. Environment variable: Show more |
|
|||||||||||||||||||||
If the cookie pattern is case-sensitive Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The value to set in the samesite attribute Environment variable: Show more |
|
required |
||||||||||||||||||||
Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled. Environment variable: Show more |
boolean |
|||||||||||||||||||||
The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies. Environment variable: Show more |
string |
required |
||||||||||||||||||||
The methods that this permission set applies to. If this is not set then they apply to all methods. Note that if a request matches any path from any permission set, but does not match the constraint due to the method not being listed then the request will be denied. Method specific permissions take precedence over matches that do not have any methods set. This means that for example if Quarkus is configured to allow GET and POST requests to /admin to and no other permissions are configured PUT requests to /admin will be denied. Environment variable: Show more |
list of string |
|||||||||||||||||||||
The paths that this permission check applies to. If the path ends in /* then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied. Environment variable: Show more |
list of string |
|||||||||||||||||||||
Path specific authentication mechanism which must be used to authenticate a user. It needs to match Environment variable: Show more |
string |
|||||||||||||||||||||
Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources. Environment variable: Show more |
|
|
||||||||||||||||||||
The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user. Environment variable: Show more |
list of string |
|
||||||||||||||||||||
Add roles granted to the Environment variable: Show more |
Map<String,List<String>> |
|||||||||||||||||||||
Permissions granted to the Environment variable: Show more |
Map<String,List<String>> |
|||||||||||||||||||||
Permissions granted by this policy will be created with a Environment variable: Show more |
string |
|
||||||||||||||||||||
Map the For example, if Environment variable: Show more |
Map<String,List<String>> |
|||||||||||||||||||||
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:
Environment variable: Show more |
string |
|
||||||||||||||||||||
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either Properties file is expected to have the Environment variable: Show more |
path |
|||||||||||||||||||||
The authentication realm Environment variable: Show more |
string |
|||||||||||||||||||||
The login page. Redirect to login page can be disabled by setting Environment variable: Show more |
string |
|
||||||||||||||||||||
The username field name. Environment variable: Show more |
string |
|
||||||||||||||||||||
The password field name. Environment variable: Show more |
string |
|
||||||||||||||||||||
The error page. Redirect to error page can be disabled by setting Environment variable: Show more |
string |
|
||||||||||||||||||||
The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting Environment variable: Show more |
string |
|
||||||||||||||||||||
Option to control the name of the cookie used to redirect the user back to the location they want to access. Environment variable: Show more |
string |
|
||||||||||||||||||||
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced. Environment variable: Show more |
|
|||||||||||||||||||||
How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as "renewal-timeout". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user’s last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request. Environment variable: Show more |
|
|||||||||||||||||||||
The cookie that is used to store the persistent session Environment variable: Show more |
string |
|
||||||||||||||||||||
The cookie path for the session and location cookies. Environment variable: Show more |
string |
|
||||||||||||||||||||
Set the HttpOnly attribute to prevent access to the cookie via JavaScript. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
SameSite attribute for the session and location cookies. Environment variable: Show more |
|
|
||||||||||||||||||||
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. Environment variable: Show more |
||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Origins allowed for CORS Comma separated list of valid URLs, e.g.: http://www.quarkus.io,http://localhost:3000 In case an entry of the list is surrounded by forward slashes, it is interpreted as a regular expression. Environment variable: Show more |
list of string |
|||||||||||||||||||||
HTTP methods allowed for CORS Comma separated list of valid methods. ex: GET,PUT,POST The filter allows any method if this is not set. default: returns any requested method as valid Environment variable: Show more |
list of string |
|||||||||||||||||||||
HTTP headers allowed for CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition The filter allows any header if this is not set. default: returns any requested header as valid Environment variable: Show more |
list of string |
|||||||||||||||||||||
HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty Environment variable: Show more |
list of string |
|||||||||||||||||||||
The Environment variable: Show more |
||||||||||||||||||||||
The Environment variable: Show more |
boolean |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Set the index page when serving static resources. Environment variable: Show more |
string |
|
||||||||||||||||||||
Set whether hidden files should be served. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set whether range requests (resumable downloads; media streaming) should be enabled. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set whether cache handling is enabled. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set the cache entry timeout. The default is Environment variable: Show more |
|
|||||||||||||||||||||
Set value for max age in caching headers. The default is Environment variable: Show more |
|
|||||||||||||||||||||
Set the max cache size. Environment variable: Show more |
int |
|
||||||||||||||||||||
Content encoding for text related files Environment variable: Show more |
|
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The maximum length of all headers. Environment variable: Show more |
|
|||||||||||||||||||||
The maximum size of a request body. Environment variable: Show more |
|
|||||||||||||||||||||
The max HTTP chunk size Environment variable: Show more |
|
|||||||||||||||||||||
The maximum length of the initial line (e.g. Environment variable: Show more |
int |
|
||||||||||||||||||||
The maximum length of a form attribute. Environment variable: Show more |
|
|||||||||||||||||||||
Set the maximum number of fields of a form. Set to Environment variable: Show more |
int |
|
||||||||||||||||||||
Set the maximum number of bytes a server can buffer when decoding a form. Set to Environment variable: Show more |
|
|||||||||||||||||||||
The maximum number of HTTP request parameters permitted for incoming requests. If a client sends more than this number of parameters in a request, the connection is closed. Environment variable: Show more |
int |
|
||||||||||||||||||||
The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout. Environment variable: Show more |
int |
|||||||||||||||||||||
Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting. Allows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is Environment variable: Show more |
long |
|||||||||||||||||||||
Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting. Indicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism. Environment variable: Show more |
long |
|||||||||||||||||||||
Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is Environment variable: Show more |
int |
|||||||||||||||||||||
Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is Environment variable: Show more |
long |
|||||||||||||||||||||
Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks. The default value is Environment variable: Show more |
int |
|||||||||||||||||||||
Set the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks.. The default value is Environment variable: Show more |
||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
If access logging is enabled. By default this will log via the standard logging facility Environment variable: Show more |
boolean |
|
||||||||||||||||||||
A regular expression that can be used to exclude some paths from logging. Environment variable: Show more |
string |
|||||||||||||||||||||
The access log pattern. If this is the string
Otherwise, consult the Quarkus documentation for the full list of variables that can be used. Environment variable: Show more |
string |
|
||||||||||||||||||||
If logging should be done to a separate file. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'. Environment variable: Show more |
string |
|
||||||||||||||||||||
The log directory to use when logging access to a file If this is not set then the current working directory is used. Environment variable: Show more |
string |
|||||||||||||||||||||
The log file suffix Environment variable: Show more |
string |
|
||||||||||||||||||||
The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty). Environment variable: Show more |
string |
|
||||||||||||||||||||
If the log should be rotated daily Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If rerouted requests should be consolidated into one log entry Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Enables the traffic shaping. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Set bandwidth limit in bytes per second for inbound connections. If not set, no limits are applied. Environment variable: Show more |
||||||||||||||||||||||
Set bandwidth limit in bytes per second for outbound connections. If not set, no limits are applied. Environment variable: Show more |
||||||||||||||||||||||
Set the maximum delay to wait in case of traffic excess. Default is 15s. Must be less than the HTTP timeout. Environment variable: Show more |
||||||||||||||||||||||
Set the delay between two computations of performances for channels. If set to 0, no stats are computed. Despite 0 is accepted (no accounting), it is recommended to set a positive value for the check interval, even if it is high since the precision of the traffic shaping depends on the period where the traffic is computed. In this case, a suggested value is something close to 5 or 10 minutes. If not default, it defaults to 1s. Environment variable: Show more |
||||||||||||||||||||||
Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write are suspended. The default value is 400 MB. Environment variable: Show more |
||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The path this header should be applied Environment variable: Show more |
string |
|
||||||||||||||||||||
The value for this header configuration Environment variable: Show more |
string |
required |
||||||||||||||||||||
The HTTP methods for this header configuration Environment variable: Show more |
list of string |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
A regular expression for the paths matching this configuration Environment variable: Show more |
string |
required |
||||||||||||||||||||
Additional HTTP Headers always sent in the response Environment variable: Show more |
Map<String,String> |
|||||||||||||||||||||
The HTTP methods for this path configuration Environment variable: Show more |
list of string |
|||||||||||||||||||||
Order in which this path config is applied. Higher priority takes precedence Environment variable: Show more |
int |
|||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
Set whether the server should use the HA Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If this is true and proxy address forwarding is enabled then the standard Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If either this or Environment variable: Show more |
boolean |
|||||||||||||||||||||
Enable override the received request’s host through a forwarded host header. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Configure the forwarded host header to be used if override enabled. Environment variable: Show more |
string |
|
||||||||||||||||||||
Enable prefix the received request’s path with a forwarded prefix header. Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Configure the forwarded prefix header to be used if prefixing enabled. Environment variable: Show more |
string |
|
||||||||||||||||||||
Adds the header The forwarded parser detects forgery attempts and if the incoming request contains this header, it will be removed from the request. The Environment variable: Show more |
boolean |
|
||||||||||||||||||||
Configure the list of trusted proxy addresses. Received Examples of a socket address in the form of
Examples of a CIDR notation:
Please bear in mind that IPv4 CIDR won’t match request sent from the IPv6 address and the other way around. Environment variable: Show more |
list of TrustedProxyCheckPart |
|
||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||
The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. Default 65536 (from HttpServerOptions of Vert.X HttpServerOptions) Environment variable: Show more |
int |
|||||||||||||||||||||
The maximum WebSocket message size. Default 262144 (from HttpServerOptions of Vert.X HttpServerOptions) Environment variable: Show more |
int |
|||||||||||||||||||||
Enables / Disables the usage of a separate interface/port to expose the management endpoints. If sets to Environment variable: Show more |
boolean |
|
||||||||||||||||||||
If basic auth should be enabled. Environment variable: Show more |
boolean |
|||||||||||||||||||||