Configuration property fixed at build time - ️ Configuration property overridable at runtime

Configuration property Type Default

Agroal

quarkus.datasource.driver

The datasource driver class name

string

quarkus.datasource.transactions

Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities. When enabling XA you will need a driver implementing javax.sql.XADataSource.

enabled, xa, disabled

enabled

quarkus.datasource.health.enabled

Whether or not an healtcheck is published in case the smallrye-health extension is present (default to true).

boolean

true

quarkus.datasource.url

The datasource URL

string

quarkus.datasource.username

The datasource username

string

quarkus.datasource.password

The datasource password

string

quarkus.datasource.initial-size

The initial size of the pool

int

quarkus.datasource.min-size

The datasource pool minimum size

int

5

quarkus.datasource.max-size

The datasource pool maximum size

int

20

quarkus.datasource.background-validation-interval

The interval at which we validate idle connections in the background. Set to 0 to disable background validation.

Duration

2M

quarkus.datasource.acquisition-timeout

The timeout before cancelling the acquisition of a new connection

Duration

5

quarkus.datasource.leak-detection-interval

The interval at which we check for connection leaks.

Duration

quarkus.datasource.idle-removal-interval

The interval at which we try to remove idle connections.

Duration

5M

quarkus.datasource.max-lifetime

The max lifetime of a connection.

Duration

quarkus.datasource.transaction-isolation-level

The transaction isolation level.

undefined, none, read-uncommitted, read-committed, repeatable-read, serializable

quarkus.datasource.enable-metrics

Enable datasource metrics collection.

boolean

false

quarkus.datasource.detect-statement-leaks

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.

boolean

true

quarkus.datasource.new-connection-sql

Query executed when first using a connection.

string

quarkus.datasource."named-data-sources".driver

The datasource driver class name

string

quarkus.datasource."named-data-sources".transactions

Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities. When enabling XA you will need a driver implementing javax.sql.XADataSource.

enabled, xa, disabled

enabled

quarkus.datasource."named-data-sources".url

The datasource URL

string

quarkus.datasource."named-data-sources".username

The datasource username

string

quarkus.datasource."named-data-sources".password

The datasource password

string

quarkus.datasource."named-data-sources".initial-size

The initial size of the pool

int

quarkus.datasource."named-data-sources".min-size

The datasource pool minimum size

int

5

quarkus.datasource."named-data-sources".max-size

The datasource pool maximum size

int

20

quarkus.datasource."named-data-sources".background-validation-interval

The interval at which we validate idle connections in the background. Set to 0 to disable background validation.

Duration

2M

quarkus.datasource."named-data-sources".acquisition-timeout

The timeout before cancelling the acquisition of a new connection

Duration

5

quarkus.datasource."named-data-sources".leak-detection-interval

The interval at which we check for connection leaks.

Duration

quarkus.datasource."named-data-sources".idle-removal-interval

The interval at which we try to remove idle connections.

Duration

5M

quarkus.datasource."named-data-sources".max-lifetime

The max lifetime of a connection.

Duration

quarkus.datasource."named-data-sources".transaction-isolation-level

The transaction isolation level.

undefined, none, read-uncommitted, read-committed, repeatable-read, serializable

quarkus.datasource."named-data-sources".enable-metrics

Enable datasource metrics collection.

boolean

false

quarkus.datasource."named-data-sources".detect-statement-leaks

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.

boolean

true

quarkus.datasource."named-data-sources".new-connection-sql

Query executed when first using a connection.

string

Amazon Lambda Resteasy

quarkus.amazon-lambda-resteasy.debug

Indicates if we are in debug mode.

boolean

false

Amazon Lambda

quarkus.lambda.handler

The handler name. Handler names are specified on handler classes using the @javax.inject.Named annotation. If this name is unspecified and there is exactly one unnamed implementation of com.amazonaws.services.lambda.runtime.RequestHandler then this unnamed handler will be used. If there is only a single named handler and the name is unspecified then the named handler will be used.

string

Arc

quarkus.arc.remove-unused-beans

  • If set to all (or true) the container will attempt to remove all unused beans.

  • If set to none (or false) no beans will ever be removed even if they are unused (according to the criteria set out below)

  • If set to fwk, then all unused beans will be removed, except the unused beans whose classes are declared in the application code

    An unused bean:
    - is not a built-in bean or interceptor,
    - is not eligible for injection to any injection point,
    - is not excluded by any extension,
    - does not have a name,
    - does not declare an observer,
    - does not declare any producer which is eligible for injection to any injection point,
    - is not directly eligible for injection into any `javax.enterprise.inject.Instance` injection point

string

all

quarkus.arc.auto-inject-fields

If set to true @Inject is automatically added to all non-static fields that are annotated with one of the annotations defined by AutoInjectAnnotationBuildItem.

boolean

true

Artemis Core

quarkus.artemis.url

Artemis connection url

string

quarkus.artemis.username

Username for authentication, only used with JMS

string

quarkus.artemis.password

Password for authentication, only used with JMS

string

Core Application

quarkus.application.name

The name of the application. If not set, defaults to the name of the project.

string

quarkus.application.version

The version of the application. If not set, defaults to the version of the project

string

Core Index Dependency

quarkus.index-dependency."index-dependency".group-id

The maven groupId of the artifact to index

string

quarkus.index-dependency."index-dependency".artifact-id

The maven artifactId of the artifact to index

string

quarkus.index-dependency."index-dependency".classifier

The maven classifier of the artifact to index

string

Core Jni

quarkus.jni.library-paths

Paths of library to load.

string

quarkus.jni.enable

Enable JNI support.

boolean

false

Core Log

quarkus.log.level

The default log level

Level

quarkus.log.min-level

The default minimum log level

Level

INFO

quarkus.log.console.enable

If console logging should be enabled

boolean

true

quarkus.log.console.format

The log format

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n

quarkus.log.console.level

The console log level

Level

ALL

quarkus.log.console.color

If the console logging should be in color. If undefined quarkus takes best guess based on operating system and environment.

boolean

quarkus.log.console.darken

Specify how much the colors should be darkened

int

0

quarkus.log.console.async

Indicates whether to log asynchronously

boolean

false

quarkus.log.console.async.queue-length

The queue length to use before flushing writing

int

512

quarkus.log.console.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

block, discard

block

quarkus.log.file.enable

If file logging should be enabled

boolean

false

quarkus.log.file.format

The log format

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n

quarkus.log.file.level

The level of logs to be written into the file.

Level

ALL

quarkus.log.file.path

The name of the file in which logs will be written.

File

quarkus.log

quarkus.log.file.async

Indicates whether to log asynchronously

boolean

false

quarkus.log.file.async.queue-length

The queue length to use before flushing writing

int

512

quarkus.log.file.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

block, discard

block

quarkus.log.file.rotation.max-file-size

The maximum file size of the log file after which a rotation is executed.

MemorySize

quarkus.log.file.rotation.max-backup-index

The maximum number of backups to keep.

int

1

quarkus.log.file.rotation.file-suffix

File handler rotation file suffix. Example fileSuffix: .yyyy-MM-dd

string

quarkus.log.file.rotation.rotate-on-boot

Indicates whether to rotate log files on server initialization.

boolean

true

quarkus.log.syslog.enable

If syslog logging should be enabled

boolean

false

quarkus.log.syslog.endpoint

The IP address and port of the syslog server

host:port

localhost:514

quarkus.log.syslog.app-name

The app name used when formatting the message in RFC5424 format

string

quarkus.log.syslog.hostname

The name of the host the messages are being sent from

string

quarkus.log.syslog.facility

Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164

kernel, user-level, mail-system, system-daemons, security, syslogd, line-printer, network-news, uucp, clock-daemon, security2, ftp-daemon, ntp, log-audit, log-alert, clock-daemon2, local-use-0, local-use-1, local-use-2, local-use-3, local-use-4, local-use-5, local-use-6, local-use-7

USER_LEVEL

quarkus.log.syslog.syslog-type

Set the SyslogType syslog type this handler should use to format the message sent

rfc5424, rfc3164

RFC5424

quarkus.log.syslog.protocol

Sets the protocol used to connect to the syslog server

tcp, udp, ssl-tcp

TCP

quarkus.log.syslog.use-counting-framing

Set to true if the message being sent should be prefixed with the size of the message

boolean

false

quarkus.log.syslog.truncate

Set to true if the message should be truncated

boolean

true

quarkus.log.syslog.block-on-reconnect

Enables or disables blocking when attempting to reconnect a org.jboss.logmanager.handlers.SyslogHandler.Protocol#TCP TCP or org.jboss.logmanager.handlers.SyslogHandler.Protocol#SSL_TCP SSL TCP protocol

boolean

false

quarkus.log.syslog.format

The log message format

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n

quarkus.log.syslog.level

The log level specifying, which message levels will be logged by syslog logger

Level

ALL

quarkus.log.syslog.async

Indicates whether to log asynchronously

boolean

false

quarkus.log.syslog.async.queue-length

The queue length to use before flushing writing

int

512

quarkus.log.syslog.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

block, discard

block

quarkus.log.category."categories".min-level

The minimum level that this category can be set to

string

inherit

quarkus.log.category."categories".level

The log level level for this category

string

inherit

quarkus.log.filter."filters".if-starts-with

The message starts to match

string

inherit

Core Ssl

quarkus.ssl.native

Enable native SSL support.

boolean

Core Thread Pool

quarkus.thread-pool.core-threads

The core thread pool size. This number of threads will always be kept alive.

int

1

quarkus.thread-pool.max-threads

The maximum number of threads. If this is not specified then it will be automatically sized to 8 * the number of available processors

int

quarkus.thread-pool.queue-size

The queue size. For most applications this should be unbounded

int

quarkus.thread-pool.growth-resistance

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 0.0f implies that threads beyond the core size should be created as aggressively as threads within it; a value of 1.0f implies that threads beyond the core size should never be created.

float

0

quarkus.thread-pool.shutdown-timeout

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

Duration

1M

quarkus.thread-pool.shutdown-interrupt

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 shutdown-timeout, then tasks will not be interrupted before the shutdown timeout occurs.

Duration

10

quarkus.thread-pool.shutdown-check-interval

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.

Duration

5

quarkus.thread-pool.keep-alive-time

The amount of time a thread will stay alive with no work.

Duration

30

Dynamodb

quarkus.dynamodb.enable-endpoint-discovery

Enable DynamoDB service endpoint discovery.

boolean

false

quarkus.dynamodb.endpoint-override

The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for DynamoDB service and region.

URI

quarkus.dynamodb.api-call-timeout

The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present.

Duration

quarkus.dynamodb.api-call-attempt-timeout

The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present.

Duration

quarkus.dynamodb.interceptors

List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements software.amazon.awssdk.core.interceptor.ExecutionInterceptor interface.

class name

quarkus.dynamodb.aws.region

An Amazon Web Services region that hosts DynamoDB.

It overrides region provider chain with static value of region with which the DynamoDB client should communicate.

If not set, region is retrieved via the default providers chain in the following order:

  • aws.region system property

  • region property from the profile file

  • Instance profile file

See software.amazon.awssdk.regions.Region for available regions.

Region

quarkus.dynamodb.aws.credentials.type

Configure the credentials provider that should be used to authenticate with AWS.

Available values:

  • default - the provider will attempt to identify the credentials automatically using the following checks:

    • Java System Properties - aws.accessKeyId and aws.secretKey

    • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

    • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI

    • Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.

    • Instance profile credentials delivered through the Amazon EC2 metadata service

  • static - the provider that uses the access key and secret access key specified in the tatic-provider section of the config.

  • system-property - it loads credentials from the aws.accessKeyId, aws.secretAccessKey and aws.sessionToken system properties.

  • env-variable - it loads credentials from the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables.

  • profile - credentials are based on AWS configuration profiles. This loads credentials from a profile file, allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI.

  • container - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are Amazon Elastic Container Service (ECS) and AWS Greengrass

  • instance-profile - It loads credentials from the Amazon EC2 Instance Metadata Service.

  • process - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile credentials file. See Sourcing Credentials From External Processes for more information.

  • anonymous - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API’s policy has been configured to specifically allow anonymous access.

default, static, system-property, env-variable, profile, container, instance-profile, process, anonymous

default

quarkus.dynamodb.aws.credentials.default-provider.async-credential-update-enabled

Whether this provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block, but additional resources are used to maintain the provider.

boolean

false

quarkus.dynamodb.aws.credentials.default-provider.reuse-last-provider-enabled

Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain.

boolean

true

quarkus.dynamodb.aws.credentials.static-provider.access-key-id

AWS Access key id

string

quarkus.dynamodb.aws.credentials.static-provider.secret-access-key

AWS Secret access key

string

quarkus.dynamodb.aws.credentials.profile-provider.profile-name

The name of the profile that should be used by this credentials provider. If not specified, the value in AWS_PROFILE environment variable or aws.profile system property is used and defaults to default name.

string

quarkus.dynamodb.aws.credentials.process-provider.async-credential-update-enabled

Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider.

boolean

false

quarkus.dynamodb.aws.credentials.process-provider.credential-refresh-threshold

The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed before they are reported to expire.

Duration

15S

quarkus.dynamodb.aws.credentials.process-provider.process-output-limit

The maximum size of the output that can be returned by the external process before an exception is raised.

MemorySize

1024

quarkus.dynamodb.aws.credentials.process-provider.command

The command that should be executed to retrieve credentials.

string

quarkus.dynamodb.sync-client.connection-timeout

The maximum amount of time to establish a connection before timing out.

Duration

2S

quarkus.dynamodb.sync-client.connection-acquisition-timeout

The amount of time to wait when acquiring a connection from the pool before giving up and timing out.

Duration

10S

quarkus.dynamodb.sync-client.connection-max-idle-time

The maximum amount of time that a connection should be allowed to remain open while idle.

Duration

60S

quarkus.dynamodb.sync-client.connection-time-to-live

The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency.

Duration

quarkus.dynamodb.sync-client.socket-timeout

The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out.

Duration

30S

quarkus.dynamodb.sync-client.max-connections

The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool.

int

50

quarkus.dynamodb.sync-client.expect-continue-enabled

Whether the client should send an HTTP expect-continue handshake before each request.

boolean

true

quarkus.dynamodb.sync-client.use-idle-connection-reaper

Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than quarkus.dynamodb.sync-client.connection-max-idle-time will be closed. This will not close connections currently in use.

boolean

true

quarkus.dynamodb.sync-client.proxy.enabled

Enable HTTP proxy

boolean

false

quarkus.dynamodb.sync-client.proxy.endpoint

The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.

URI

quarkus.dynamodb.sync-client.proxy.username

The username to use when connecting through a proxy.

string

quarkus.dynamodb.sync-client.proxy.password

The password to use when connecting through a proxy.

string

quarkus.dynamodb.sync-client.proxy.ntlm-domain

For NTLM proxies - the Windows domain name to use when authenticating with the proxy.

string

quarkus.dynamodb.sync-client.proxy.ntlm-workstation

For NTLM proxies - the Windows workstation name to use when authenticating with the proxy.

string

quarkus.dynamodb.sync-client.proxy.preemptive-basic-authentication-enabled

Whether to attempt to authenticate preemptively against the proxy server using basic authentication.

boolean

quarkus.dynamodb.sync-client.proxy.non-proxy-hosts

The hosts that the client is allowed to access without going through the proxy.

string

quarkus.dynamodb.sync-client.tls-managers-provider.type

TLS managers provider type.

Available providers:

  • none - Use this provider if you don’t want the client to present any certificates to the remote TLS host.

  • system-property - Provider checks the standard javax.net.ssl.keyStore, javax.net.ssl.keyStorePassword, and javax.net.ssl.keyStoreType properties defined by the JSSE.

  • file-store - Provider that loads a the key store from a file.

none, system-property, file-store

system-property

quarkus.dynamodb.sync-client.tls-managers-provider.file-store.path

Path to the key store.

path

quarkus.dynamodb.sync-client.tls-managers-provider.file-store.type

Key store type. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard keystore types.

string

quarkus.dynamodb.sync-client.tls-managers-provider.file-store.password

Key store password

string

quarkus.dynamodb.async-client.max-concurrency

The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection.

int

50

quarkus.dynamodb.async-client.max-pending-connection-acquires

The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed.

int

10000

quarkus.dynamodb.async-client.read-timeout

The amount of time to wait for a read on a socket before an exception is thrown. Specify 0 to disable.

Duration

30S

quarkus.dynamodb.async-client.write-timeout

The amount of time to wait for a write on a socket before an exception is thrown. Specify 0 to disable.

Duration

30S

quarkus.dynamodb.async-client.connection-timeout

The amount of time to wait when initially establishing a connection before giving up and timing out.

Duration

10S

quarkus.dynamodb.async-client.connection-acquisition-timeout

The amount of time to wait when acquiring a connection from the pool before giving up and timing out.

Duration

2S

quarkus.dynamodb.async-client.connection-time-to-live

The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency.

Duration

quarkus.dynamodb.async-client.connection-max-idle-time

The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if quarkus.dynamodb.async-client.use-idle-connection-reaper is false.

Duration

60S

quarkus.dynamodb.async-client.use-idle-connection-reaper

Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than quarkus.dynamodb.async-client.connection-max-idle-time will be closed. This will not close connections currently in use.

boolean

true

quarkus.dynamodb.async-client.protocol

The HTTP protocol to use.

http1-1, http2

http1-1

quarkus.dynamodb.async-client.max-http2-streams

The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. 0 means unlimited.

int

0

quarkus.dynamodb.async-client.ssl-provider

The SSL Provider to be used in the Netty client. Default is OPENSSL if available, JDK otherwise.

jdk, openssl, openssl-refcnt

quarkus.dynamodb.async-client.proxy.enabled

Enable HTTP proxy.

boolean

false

quarkus.dynamodb.async-client.proxy.endpoint

The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.

URI

quarkus.dynamodb.async-client.proxy.non-proxy-hosts

The hosts that the client is allowed to access without going through the proxy.

string

quarkus.dynamodb.async-client.tls-managers-provider.type

TLS managers provider type.

Available providers:

  • none - Use this provider if you don’t want the client to present any certificates to the remote TLS host.

  • system-property - Provider checks the standard javax.net.ssl.keyStore, javax.net.ssl.keyStorePassword, and javax.net.ssl.keyStoreType properties defined by the JSSE.

  • file-store - Provider that loads a the key store from a file.

none, system-property, file-store

system-property

quarkus.dynamodb.async-client.tls-managers-provider.file-store.path

Path to the key store.

path

quarkus.dynamodb.async-client.tls-managers-provider.file-store.type

Key store type. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard keystore types.

string

quarkus.dynamodb.async-client.tls-managers-provider.file-store.password

Key store password

string

quarkus.dynamodb.async-client.event-loop.override

Enable the custom configuration of the Netty event loop group.

boolean

false

quarkus.dynamodb.async-client.event-loop.number-of-threads

Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the io.netty.eventLoopThreads system property is set.

int

quarkus.dynamodb.async-client.event-loop.thread-name-prefix

The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to aws-java-sdk-NettyEventLoop

string

Elytron Security Jdbc

quarkus.security.jdbc.auth-mechanism

The authentication mechanism

string

BASIC

quarkus.security.jdbc.realm-name

The authentication mechanism

string

Quarkus

quarkus.security.jdbc.enabled

If the properties store is enabled.

boolean

false

quarkus.security.jdbc.principal-query.sql

The sql query to find the password

string

quarkus.security.jdbc.principal-query.datasource

The data source to use

string

quarkus.security.jdbc.principal-query.clear-password-mapper.enabled

If the clear-password-mapper is enabled.

boolean

false

quarkus.security.jdbc.principal-query.clear-password-mapper.password-index

The index (1 based numbering) of the column containing the clear password

int

1

quarkus.security.jdbc.principal-query.bcrypt-password-mapper.enabled

If the bcrypt-password-mapper is enabled.

boolean

false

quarkus.security.jdbc.principal-query.bcrypt-password-mapper.password-index

The index (1 based numbering) of the column containing the password hash

int

0

quarkus.security.jdbc.principal-query.bcrypt-password-mapper.hash-encoding

A string referencing the password hash encoding ("BASE64" or "HEX")

base64, hex

BASE64

quarkus.security.jdbc.principal-query.bcrypt-password-mapper.salt-index

The index (1 based numbering) of the column containing the Bcrypt salt

int

0

quarkus.security.jdbc.principal-query.bcrypt-password-mapper.salt-encoding

A string referencing the salt encoding ("BASE64" or "HEX")

base64, hex

BASE64

quarkus.security.jdbc.principal-query.bcrypt-password-mapper.iteration-count-index

The index (1 based numbering) of the column containing the Bcrypt iteration count

int

0

quarkus.security.jdbc.principal-query.attribute-mappings."attribute-mappings".index

The index (1 based numbering) of column to map

int

0

quarkus.security.jdbc.principal-query.attribute-mappings."attribute-mappings".to

The target attribute name

string

quarkus.security.jdbc.principal-query."named-principal-queries".sql

The sql query to find the password

string

quarkus.security.jdbc.principal-query."named-principal-queries".datasource

The data source to use

string

quarkus.security.jdbc.principal-query."named-principal-queries".attribute-mappings."attribute-mappings".index

The index (1 based numbering) of column to map

int

0

quarkus.security.jdbc.principal-query."named-principal-queries".attribute-mappings."attribute-mappings".to

The target attribute name

string

quarkus.security.jdbc.principal-query."named-principal-queries".clear-password-mapper.enabled

If the clear-password-mapper is enabled.

boolean

false

quarkus.security.jdbc.principal-query."named-principal-queries".clear-password-mapper.password-index

The index (1 based numbering) of the column containing the clear password

int

1

quarkus.security.jdbc.principal-query."named-principal-queries".bcrypt-password-mapper.enabled

If the bcrypt-password-mapper is enabled.

boolean

false

quarkus.security.jdbc.principal-query."named-principal-queries".bcrypt-password-mapper.password-index

The index (1 based numbering) of the column containing the password hash

int

0

quarkus.security.jdbc.principal-query."named-principal-queries".bcrypt-password-mapper.hash-encoding

A string referencing the password hash encoding ("BASE64" or "HEX")

base64, hex

BASE64

quarkus.security.jdbc.principal-query."named-principal-queries".bcrypt-password-mapper.salt-index

The index (1 based numbering) of the column containing the Bcrypt salt

int

0

quarkus.security.jdbc.principal-query."named-principal-queries".bcrypt-password-mapper.salt-encoding

A string referencing the salt encoding ("BASE64" or "HEX")

base64, hex

BASE64

quarkus.security.jdbc.principal-query."named-principal-queries".bcrypt-password-mapper.iteration-count-index

The index (1 based numbering) of the column containing the Bcrypt iteration count

int

0

Elytron Security Oauth2

quarkus.oauth2.enabled

If the OAuth2 extension is enabled.

boolean

true

quarkus.oauth2.client-id

The identifier of the client on the OAuth2 Authorization Server

string

quarkus.oauth2.client-secret

The secret of the client

string

quarkus.oauth2.introspection-url

The URL of token introspection endpoint

string

quarkus.oauth2.ca-cert-file

The path to a custom cert file This is not supported in native mode

string

quarkus.oauth2.role-claim

The claim that provides the roles

string

scope

Elytron Security

quarkus.security.users.file.realm-name

The realm name. This is used when generating a hashed password

string

Quarkus

quarkus.security.users.file.enabled

If the properties store is enabled.

boolean

false

quarkus.security.users.file.plain-text

If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )

boolean

false

quarkus.security.users.file.users

The location of the users property resource

string

users.properties

quarkus.security.users.file.roles

The location of the roles property file

string

roles.properties

quarkus.security.users.embedded.realm-name

The authentication mechanism

string

Quarkus

quarkus.security.users.embedded.plain-text

If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )

boolean

false

quarkus.security.users.embedded.enabled

If the embedded store is enabled.

boolean

false

quarkus.security.users.embedded.users."users"

The realm users user1=password\nuser2=password2…​ mapping

String

quarkus.security.users.embedded.roles."roles"

The realm roles user1=role1,role2,…​\nuser2=role1,role2,…​ mapping

String

Extest

quarkus.bt.bt-string-opt

A config string

string

quarkus.bt.bt-string-opt-with-default

A config string with default value

string

btStringOptWithDefaultValue

quarkus.bt.bt-sbv

A config object with ctor(String)

StringBasedValue

quarkus.bt.bt-sbv-with-default

A config object with ctor(String) and default value

StringBasedValue

btSBVWithDefaultValue

quarkus.bt.all-values.long-primitive

a long primitive

long

0l

quarkus.bt.all-values.double-primitive

a double primitive

double

0d

quarkus.bt.all-values.long-value

a long value

long

quarkus.bt.all-values.opt-long-value

an optional long value

long

quarkus.bt.all-values.opt-double-value

an optional double value

double

quarkus.bt.all-values.optional-long-value

an optional long value

long

quarkus.bt.all-values.oov

A config object with a static of(String) method

ObjectOfValue

quarkus.bt.all-values.oov-with-default

A config object with a static of(String) method and default value

ObjectOfValue

defaultPart1+defaultPart2

quarkus.bt.all-values.ovo

A config object with a static valueOf(String) method

ObjectValueOf

quarkus.bt.all-values.ovo-with-default

A config object with a static of(String) method and default value

ObjectValueOf

defaultPart1+defaultPart2

quarkus.bt.all-values.string-list

A List of string values

string

quarkus.bt.all-values.long-list

A List of long values

long

quarkus.bt.all-values.expanded-default

A configuration item that has a default value that is an expression

string

${java.vm.version}

quarkus.btrt.bt-string-opt

A config string

string

quarkus.btrt.bt-string-opt-with-default

A config string with default value

string

btStringOptWithDefaultValue

quarkus.btrt.bt-sbv

A config object with ctor(String)

StringBasedValue

quarkus.btrt.bt-sbv-with-default

A config object with ctor(String) and default value

StringBasedValue

btSBVWithDefaultValue

quarkus.btrt.my-enum

Enum object

optional, enum-one, enum-two

quarkus.btrt.my-enums

Enum list of objects

optional, enum-one, enum-two

quarkus.root.dsa-key-location

string

quarkus.root.validate-build-config

boolean

false

quarkus.rt.rt-string-opt

A run time object

string

quarkus.rt.rt-string-opt-with-default

A run time object with default value

string

rtStringOptWithDefaultValue

quarkus.rt.all-values.long-primitive

a long primitive

long

0l

quarkus.rt.all-values.double-primitive

a double primitive

double

0d

quarkus.rt.all-values.long-value

a long value

long

quarkus.rt.all-values.opt-long-value

an optional long value

long

quarkus.rt.all-values.opt-double-value

an optional double value

double

quarkus.rt.all-values.optional-long-value

an optional long value

long

quarkus.rt.all-values.oov

A config object with a static of(String) method

ObjectOfValue

quarkus.rt.all-values.oov-with-default

A config object with a static of(String) method and default value

ObjectOfValue

defaultPart1+defaultPart2

quarkus.rt.all-values.ovo

A config object with a static valueOf(String) method

ObjectValueOf

quarkus.rt.all-values.ovo-with-default

A config object with a static of(String) method and default value

ObjectValueOf

defaultPart1+defaultPart2

quarkus.rt.all-values.string-list

A List of string values

string

quarkus.rt.all-values.long-list

A List of long values

long

quarkus.rt.all-values.expanded-default

A configuration item that has a default value that is an expression

string

${java.vm.version}

quarkus.rt.my-enum

Enum object

optional, enum-one, enum-two

quarkus.rt.my-enums

Enum list of objects

optional, enum-one, enum-two

quarkus.rt.my-optional-enums

Enum optional value

optional, enum-one, enum-two

quarkus.rt.no-hyphenate-first-enum

No hyphenation

optional, enum-one, enum-two

quarkus.rt.no-hyphenate-second-enum

No hyphenation

optional, enum-one, enum-two

quarkus.rt.primitive-boolean

Primitive boolean conversion with ConvertWith

boolean

NO

quarkus.rt.object-boolean

Boolean conversion with ConvertWith

boolean

NO

quarkus.rt.primitive-integer

Primitive int conversion with ConvertWith

int

zero

quarkus.rt.object-integer

Integer conversion with ConvertWith

int

zero

quarkus.rt.one-to-nine

List of Integer conversion with ConvertWith

int

one

quarkus.btrt.map-of-numbers."map-of-numbers"

Map of Integer conversion with ConvertWith

int

quarkus.bt.all-values.string-map."string-property"

A map of properties

String

quarkus.bt.all-values.string-list-map."list-of-strings"

A map of property lists

java.util.List<java.lang.String>

quarkus.rt.string-map."string-map"

A map of properties

String

quarkus.rt.string-list-map."string-list-map"

A map of property lists

java.util.List<java.lang.String>

quarkus.rt.all-values.string-map."string-property"

A map of properties

String

quarkus.rt.all-values.string-list-map."list-of-strings"

A map of property lists

java.util.List<java.lang.String>

quarkus.rt.map-of-numbers."map-of-numbers"

Map of Integer conversion with ConvertWith

int

A map of config group objects

quarkus.bt.all-values.nested-config-map."nested-config-map".nested-value

A nested string value

string

quarkus.bt.all-values.nested-config-map."nested-config-map".oov

A nested ObjectOfValue value

ObjectOfValue

A nested config group with all supported value types

quarkus.btrt.all-values.long-primitive

a long primitive

long

0l

quarkus.btrt.all-values.double-primitive

a double primitive

double

0d

quarkus.btrt.all-values.long-value

a long value

long

quarkus.btrt.all-values.opt-long-value

an optional long value

long

quarkus.btrt.all-values.opt-double-value

an optional double value

double

quarkus.btrt.all-values.optional-long-value

an optional long value

long

quarkus.btrt.all-values.oov

A config object with a static of(String) method

ObjectOfValue

quarkus.btrt.all-values.oov-with-default

A config object with a static of(String) method and default value

ObjectOfValue

defaultPart1+defaultPart2

quarkus.btrt.all-values.ovo

A config object with a static valueOf(String) method

ObjectValueOf

quarkus.btrt.all-values.ovo-with-default

A config object with a static of(String) method and default value

ObjectValueOf

defaultPart1+defaultPart2

quarkus.btrt.all-values.string-list

A List of string values

string

quarkus.btrt.all-values.long-list

A List of long values

long

quarkus.btrt.all-values.expanded-default

A configuration item that has a default value that is an expression

string

${java.vm.version}

quarkus.btrt.all-values.string-map."string-property"

A map of properties

String

quarkus.btrt.all-values.string-list-map."list-of-strings"

A map of property lists

java.util.List<java.lang.String>

A map of config group objects

quarkus.btrt.all-values.nested-config-map."nested-config-map".nested-value

A nested string value

string

quarkus.btrt.all-values.nested-config-map."nested-config-map".oov

A nested ObjectOfValue value

ObjectOfValue

A map of config group objects

quarkus.rt.all-values.nested-config-map."nested-config-map".nested-value

A nested string value

string

quarkus.rt.all-values.nested-config-map."nested-config-map".oov

A nested ObjectOfValue value

ObjectOfValue

Flyway

quarkus.flyway.locations

Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations. Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories.

string

quarkus.flyway.connect-retries

The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries.

int

quarkus.flyway.schemas

Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table.

string

quarkus.flyway.table

The name of Flyway’s schema history table. By default (single-schema mode) the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list.

string

quarkus.flyway.sql-migration-prefix

The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql

string

quarkus.flyway.repeatable-sql-migration-prefix

The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql

string

quarkus.flyway.migrate-at-start

true to execute Flyway automatically when the application starts, false otherwise.

boolean

false

quarkus.flyway.baseline-on-migrate

Enable the creation of the history table if it does not exist already.

boolean

false

quarkus.flyway.baseline-version

The initial baseline version.

string

quarkus.flyway.baseline-description

The description to tag an existing schema with when executing baseline.

string

Hibernate Orm

quarkus.hibernate-orm.dialect

Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the Hibernate ORM JavaDoc.

Not all the dialects are supported in GraalVM native executables: we currently provide driver extensions for PostgreSQL, MariaDB, Microsoft SQL Server and H2.

string

quarkus.hibernate-orm.dialect.storage-engine

The storage engine to use when the dialect supports multiple storage engines.

E.g. MyISAM or InnoDB for MySQL.

string

quarkus.hibernate-orm.sql-load-script

Name of the file containing the SQL statements to execute when Hibernate ORM starts. Its default value differs depending on the Quarkus launch mode:

  • In dev and test modes, it defaults to import.sql. Simply add an import.sql file in the root of your resources directory and it will be picked up without having to set this property. Pass no-file to force Hibernate ORM to ignore the SQL import file.

  • In production mode, it defaults to no-file. It means Hibernate ORM won’t try to execute any SQL import file by default. Pass an explicit value to force Hibernate ORM to execute the SQL import file.

If you need different SQL statements between dev mode, test (@QuarkusTest) and in production, use Quarkus configuration profiles facility.

application.properties
%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql
%test.quarkus.hibernate-orm.sql-load-script = import-test.sql
%prod.quarkus.hibernate-orm.sql-load-script = no-file

Quarkus supports .sql file with SQL statements or comments spread over multiple lines. Each SQL statement must be terminated by a semicolon.

string

import.sql (DEV,TEST)

quarkus.hibernate-orm.batch-fetch-size

The size of the batches used when loading entities and collections.

-1 means batch loading is disabled. This is the default.

int

-1

quarkus.hibernate-orm.statistics

Whether statistics collection is enabled.

boolean

false

Query related configuration

quarkus.hibernate-orm.query.query-plan-cache-max-size

The maximum size of the query plan cache.

string

quarkus.hibernate-orm.query.default-null-ordering

Default precedence of null values in ORDER BY clauses.

Valid values are: none, first, last.

string

Database related configuration

quarkus.hibernate-orm.database.generation

Select whether the database schema is generated or not. drop-and-create is awesome in development mode. Accepted values: none, create, drop-and-create, drop, update.

string

none

quarkus.hibernate-orm.database.generation.halt-on-error

Whether we should stop on the first error when applying the schema.

boolean

false

quarkus.hibernate-orm.database.default-catalog

The default catalog to use for the database objects.

string

quarkus.hibernate-orm.database.default-schema

The default schema to use for the database objects.

string

quarkus.hibernate-orm.database.charset

The charset of the database.

string

JDBC related configuration

quarkus.hibernate-orm.jdbc.timezone

The time zone pushed to the JDBC driver.

string

quarkus.hibernate-orm.jdbc.statement-fetch-size

How many rows are fetched at a time by the JDBC driver.

int

quarkus.hibernate-orm.jdbc.statement-batch-size

The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.

int

Logging configuration

quarkus.hibernate-orm.log.sql

Show SQL logs and format them nicely. Setting it to true is obviously not recommended in production.

boolean

false

quarkus.hibernate-orm.log.jdbc-warnings

Whether JDBC warnings should be collected and logged.

boolean

depends on dialect

Caching configuration

quarkus.hibernate-orm.cache."cache".expiration.max-idle

The maximum time before an object of the cache is considered expired.

Duration

quarkus.hibernate-orm.cache."cache".memory.object-count

The maximum number of objects kept in memory in the cache.

long

Hibernate Search Elasticsearch

quarkus.hibernate-search.elasticsearch.version

The version of Elasticsearch used in the cluster. As the schema is generated without a connection to the server, this item is mandatory. It doesn’t have to be the exact version (it can be 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch). There’s no rule of thumb here as it depends on the schema incompatibilities introduced by Elasticsearch versions. In any case, if there is a problem, you will have an error when Hibernate Search tries to connect to the cluster.

ElasticsearchVersion

quarkus.hibernate-search.elasticsearch.analysis.configurer

The class or the name of the bean used to configure full text analysis (e.g. analyzers, normalizers).

class name

quarkus.hibernate-search.default-backend

If not using the default backend configuration, the name of the default backend that is part of the additional-backends.

string

quarkus.hibernate-search.elasticsearch.hosts

The list of hosts of the Elasticsearch servers.

string

quarkus.hibernate-search.elasticsearch.username

The username used for authentication.

string

quarkus.hibernate-search.elasticsearch.password

The password used for authentication.

string

quarkus.hibernate-search.elasticsearch.connection-timeout

The connection timeout.

Duration

quarkus.hibernate-search.elasticsearch.max-connections

The maximum number of connections to all the Elasticsearch servers.

int

quarkus.hibernate-search.elasticsearch.max-connections-per-route

The maximum number of connections per Elasticsearch server.

int

quarkus.hibernate-search.elasticsearch.discovery.enabled

Defines if automatic discovery is enabled.

boolean

quarkus.hibernate-search.elasticsearch.discovery.refresh-interval

Refresh interval of the node list.

Duration

quarkus.hibernate-search.elasticsearch.discovery.default-scheme

The scheme that should be used for the new nodes discovered.

string

quarkus.hibernate-search.elasticsearch.index-defaults.lifecycle.strategy

The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop.

none, validate, update, create, drop-and-create, drop-and-create-and-drop

quarkus.hibernate-search.elasticsearch.index-defaults.lifecycle.required-status

The minimal cluster status required. Must be one of: green, yellow, red.

green, yellow, red

quarkus.hibernate-search.elasticsearch.index-defaults.lifecycle.required-status-wait-timeout

How long we should wait for the status before failing the bootstrap.

Duration

quarkus.hibernate-search.elasticsearch.query.loading.cache-lookup.strategy

The strategy to use when loading entities during the execution of a search query. Can be either one of "skip", "persistence-context" or "persistence-context-then-second-level-cache". Defaults to "skip".

skip, persistence-context, persistence-context-then-second-level-cache

quarkus.hibernate-search.elasticsearch.query.loading.fetch-size

The fetch size to use when loading entities during the execution of a search query.

int

100

quarkus.hibernate-search.elasticsearch.automatic-indexing.synchronization.strategy

The synchronization strategy to use when indexing automatically. Defines the status for which you wait before considering the operation completed by Hibernate Search. Can be either one of "queued", "committed" or "searchable". Using "searchable" is recommended in unit tests. Defaults to "committed".

queued, committed, searchable

quarkus.hibernate-search.elasticsearch.automatic-indexing.enable-dirty-check

Whether to check if dirty properties are relevant to indexing before actually reindexing an entity. When enabled, re-indexing of an entity is skipped if the only changes are on properties that are not used when indexing.

boolean

quarkus.hibernate-search.elasticsearch.backends."additional-backends".version

The version of Elasticsearch used in the cluster. As the schema is generated without a connection to the server, this item is mandatory. It doesn’t have to be the exact version (it can be 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch). There’s no rule of thumb here as it depends on the schema incompatibilities introduced by Elasticsearch versions. In any case, if there is a problem, you will have an error when Hibernate Search tries to connect to the cluster.

ElasticsearchVersion

quarkus.hibernate-search.elasticsearch.backends."additional-backends".analysis.configurer

The class or the name of the bean used to configure full text analysis (e.g. analyzers, normalizers).

class name

quarkus.hibernate-search.elasticsearch.indexes."indexes".lifecycle.strategy

The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop.

none, validate, update, create, drop-and-create, drop-and-create-and-drop

quarkus.hibernate-search.elasticsearch.indexes."indexes".lifecycle.required-status

The minimal cluster status required. Must be one of: green, yellow, red.

green, yellow, red

quarkus.hibernate-search.elasticsearch.indexes."indexes".lifecycle.required-status-wait-timeout

How long we should wait for the status before failing the bootstrap.

Duration

quarkus.hibernate-search.elasticsearch.backends."additional-backends".hosts

The list of hosts of the Elasticsearch servers.

string

quarkus.hibernate-search.elasticsearch.backends."additional-backends".username

The username used for authentication.

string

quarkus.hibernate-search.elasticsearch.backends."additional-backends".password

The password used for authentication.

string

quarkus.hibernate-search.elasticsearch.backends."additional-backends".connection-timeout

The connection timeout.

Duration

quarkus.hibernate-search.elasticsearch.backends."additional-backends".max-connections

The maximum number of connections to all the Elasticsearch servers.

int

quarkus.hibernate-search.elasticsearch.backends."additional-backends".max-connections-per-route

The maximum number of connections per Elasticsearch server.

int

quarkus.hibernate-search.elasticsearch.backends."additional-backends".discovery.enabled

Defines if automatic discovery is enabled.

boolean

quarkus.hibernate-search.elasticsearch.backends."additional-backends".discovery.refresh-interval

Refresh interval of the node list.

Duration

quarkus.hibernate-search.elasticsearch.backends."additional-backends".discovery.default-scheme

The scheme that should be used for the new nodes discovered.

string

quarkus.hibernate-search.elasticsearch.backends."additional-backends".index-defaults.lifecycle.strategy

The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop.

none, validate, update, create, drop-and-create, drop-and-create-and-drop

quarkus.hibernate-search.elasticsearch.backends."additional-backends".index-defaults.lifecycle.required-status

The minimal cluster status required. Must be one of: green, yellow, red.

green, yellow, red

quarkus.hibernate-search.elasticsearch.backends."additional-backends".index-defaults.lifecycle.required-status-wait-timeout

How long we should wait for the status before failing the bootstrap.

Duration

quarkus.hibernate-search.elasticsearch.backends."additional-backends".indexes."indexes".lifecycle.strategy

The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop.

none, validate, update, create, drop-and-create, drop-and-create-and-drop

quarkus.hibernate-search.elasticsearch.backends."additional-backends".indexes."indexes".lifecycle.required-status

The minimal cluster status required. Must be one of: green, yellow, red.

green, yellow, red

quarkus.hibernate-search.elasticsearch.backends."additional-backends".indexes."indexes".lifecycle.required-status-wait-timeout

How long we should wait for the status before failing the bootstrap.

Duration

Infinispan Client

quarkus.infinispan-client.near-cache-max-entries

Sets the bounded entry count for near cache. If this value is 0 or less near cache is disabled.

int

0

quarkus.infinispan-client.server-list

Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222).

string

Infinispan Embedded

quarkus.infinispan-embedded.xml-config

The configured Infinispan embeddex xml file which is used by the managed EmbeddedCacheManager and its Caches

string

Jaeger

quarkus.jaeger.enabled

Defines if the Jaeger extension is enabled.

boolean

true

quarkus.jaeger.endpoint

The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces

URI

quarkus.jaeger.auth-token

Authentication Token to send as "Bearer" to the endpoint

string

quarkus.jaeger.user

Username to send as part of "Basic" authentication to the endpoint

string

quarkus.jaeger.password

Password to send as part of "Basic" authentication to the endpoint

string

quarkus.jaeger.agent-host-port

The hostname and port for communicating with agent via UDP

host:port

quarkus.jaeger.reporter-log-spans

Whether the reporter should also log the spans

boolean

quarkus.jaeger.reporter-max-queue-size

The reporter’s maximum queue size

int

quarkus.jaeger.reporter-flush-interval

The reporter’s flush interval

Duration

quarkus.jaeger.sampler-type

The sampler type (const, probabilistic, ratelimiting or remote)

string

quarkus.jaeger.sampler-param

The sampler parameter (number)

BigDecimal

quarkus.jaeger.sampler-manager-host-port

The host name and port when using the remote controlled sampler

host:port

quarkus.jaeger.service-name

The service name

string

quarkus.jaeger.tags

A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format ${envVarName:default}, where the :default is optional, and identifies a value to be used if the environment variable cannot be found

string

quarkus.jaeger.propagation

Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3

string

quarkus.jaeger.sender-factory

The sender factory class name

string

Kafka Streams

quarkus.kafka-streams.application-id

A unique identifier for this Kafka Streams application.

string

quarkus.kafka-streams.bootstrap-servers

A comma-separated list of host:port pairs identifying the Kafka bootstrap server(s)

host:port

localhost:9012

quarkus.kafka-streams.application-server

A unique identifier of this application instance, typically in the form host:port.

string

quarkus.kafka-streams.topics

A comma-separated list of topic names processed by this stream processing application. The pipeline will only be started once all these topics are present in the Kafka cluster.

string

Kubernetes Client

quarkus.kubernetes-client.trust-certs

Whether or not the client should trust a self signed certificate if so presented by the API server

boolean

false

quarkus.kubernetes-client.master-url

URL of the Kubernetes API server

string

quarkus.kubernetes-client.namespace

Default namespace to use

string

quarkus.kubernetes-client.ca-cert-file

CA certificate file

string

quarkus.kubernetes-client.ca-cert-data

CA certificate data

string

quarkus.kubernetes-client.client-cert-file

Client certificate file

string

quarkus.kubernetes-client.client-cert-data

Client certificate data

string

quarkus.kubernetes-client.client-key-file

Client key file

string

quarkus.kubernetes-client.client-key-data

Client key data

string

quarkus.kubernetes-client.client-key-algo

Client key algorithm

string

quarkus.kubernetes-client.client-key-passphrase

Client key passphrase

string

quarkus.kubernetes-client.username

Kubernetes auth username

string

quarkus.kubernetes-client.password

Kubernetes auth password

string

quarkus.kubernetes-client.watch-reconnect-interval

Watch reconnect interval

Duration

PT1S

quarkus.kubernetes-client.watch-reconnect-limit

Maximum reconnect attempts in case of watch failure By default there is no limit to the number of reconnect attempts

int

-1

quarkus.kubernetes-client.connection-timeout

Maximum amount of time to wait for a connection with the API server to be established

Duration

PT10S

quarkus.kubernetes-client.request-timeout

Maximum amount of time to wait for a request to the API server to be completed

Duration

PT10S

quarkus.kubernetes-client.rolling-timeout

Maximum amount of time in milliseconds to wait for a rollout to be completed

Duration

PT15M

quarkus.kubernetes-client.http-proxy

HTTP proxy used to access the Kubernetes API server

string

quarkus.kubernetes-client.https-proxy

HTTPS proxy used to access the Kubernetes API server

string

quarkus.kubernetes-client.proxy-username

Proxy username

string

quarkus.kubernetes-client.proxy-password

Proxy password

string

quarkus.kubernetes-client.no-proxy

IP addresses or hosts to exclude from proxying

string

Kubernetes

quarkus.kubernetes.group

The group of the application. This value will be use as: - docker image repo - labeling resources

string

quarkus.kubernetes.docker.registry

The docker registry to which the images will be pushed

string

docker.io

Mailer

quarkus.mailer.from

Configure the default from attribute. It’s the sender email address.

string

quarkus.mailer.mock

Enables the mock mode, not sending emails. The content of the emails is printed on the console. Disabled by default on PROD, enabled by default on DEV and TEST modes.

boolean

quarkus.mailer.bounce-address

Configures the default bounce email address.

string

quarkus.mailer.host

The SMTP host name.

string

localhost

quarkus.mailer.port

The SMTP port.

int

quarkus.mailer.username

The username.

string

quarkus.mailer.password

The password.

string

quarkus.mailer.ssl

Enables or disables the SSL on connect. false by default.

boolean

false

quarkus.mailer.trust-all

Set whether to trust all certificates on ssl connect the option is also applied to STARTTLS operation. false by default.

boolean

false

quarkus.mailer.max-pool-size

Configures the maximum allowed number of open connections to the mail server If not set the default is 10.

int

quarkus.mailer.own-host-name

The hostname to be used for HELO/EHLO and the Message-ID

string

quarkus.mailer.keep-alive

Set if connection pool is enabled, true by default. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.

boolean

true

quarkus.mailer.disable-esmtp

Disable ESMTP. false by default. The RFC-1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use the regular SMTP command.

boolean

false

quarkus.mailer.start-tls

Set the TLS security mode for the connection. Either DISABLED, OPTIONAL or REQUIRED.

string

quarkus.mailer.login

Set the login mode for the connection. Either DISABLED, OPTIONAL or REQUIRED

string

quarkus.mailer.auth-methods

Set the allowed auth methods. If defined, only these methods will be used, if the server supports them.

string

quarkus.mailer.key-store

Set the key store.

string

quarkus.mailer.key-store-password

Set the key store password.

string

Mongodb

quarkus.mongodb.connection-string

Configures the connection string. The format is: mongodb://[username:password@]host1[:port1][,host2[:port2],…​[,hostN[:portN]]][/[database.collection][?options]] mongodb:// is a required prefix to identify that this is a string in the standard connection format. username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well. host1 is the only required part of the connection string. It identifies a server address to connect to. :portX is optional and defaults to :27017 if not provided. /database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the admin database will be used by default. ?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". An alternative format, using the mongodb+srv protocol, is: mongodb+srv://[username:password@]host[/[database][?options]] - mongodb+srv:// is a required prefix for this format. - username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well - host is the only required part of the URI. It identifies a single host name for which SRV records are looked up from a Domain Name Server after prefixing the host name with "_mongodb._tcp". The host/port for each SRV record becomes the seed list used to connect, as if each one were provided as host/port pair in a URI using the normal mongodb protocol. - /database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default. - ?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". Additionally with the mongodb+srv protocol, TXT records are looked up from a Domain Name Server for the given host, and the text value of each one is prepended to any options on the URI itself. Because the last specified value for any option wins, that means that options provided on the URI will override any that are provided via TXT records.

string

quarkus.mongodb.hosts

Configures the Mongo server addressed (one if single mode). The addressed are passed as host:port.

string

quarkus.mongodb.database

Configure the database name.

string

quarkus.mongodb.application-name

Configures the application name.

string

quarkus.mongodb.max-pool-size

Configures the maximum number of connections in the connection pool.

int

quarkus.mongodb.min-pool-size

Configures the minimum number of connections in the connection pool.

int

quarkus.mongodb.max-connection-idle-time

Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed.

Duration

quarkus.mongodb.max-connection-life-time

Maximum life time of a pooled connection. A connection that exceeds this limit will be closed.

Duration

quarkus.mongodb.wait-queue-timeout

The maximum wait time that a thread may wait for a connection to become available.

Duration

quarkus.mongodb.maintenance-frequency

Configures the time period between runs of the maintenance job.

Duration

quarkus.mongodb.maintenance-initial-delay

Configures period of time to wait before running the first maintenance job on the connection pool.

Duration

quarkus.mongodb.wait-queue-multiple

This multiplier, multiplied with the maxPoolSize setting, gives the maximum number of threads that may be waiting for a connection to become available from the pool. All further threads will get an exception right away.

int

quarkus.mongodb.connect-timeout

How long a connection can take to be opened before timing out.

Duration

quarkus.mongodb.socket-timeout

How long a send or receive on a socket can take before timing out.

Duration

quarkus.mongodb.tls-insecure

If connecting with TLS, this option enables insecure TLS connections.

boolean

false

quarkus.mongodb.tls

Whether to connect using TLS.

boolean

false

quarkus.mongodb.replica-set-name

Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set.

string

quarkus.mongodb.server-selection-timeout

How long the driver will wait for server selection to succeed before throwing an exception.

Duration

quarkus.mongodb.local-threshold

When choosing among multiple MongoDB servers to send a request, the driver will only send that request to a server whose ping time is less than or equal to the server with the fastest ping time plus the local threshold.

Duration

quarkus.mongodb.heartbeat-frequency

The frequency that the driver will attempt to determine the current state of each server in the cluster.

Duration

quarkus.mongodb.write-concern.safe

Configures the safety. If set to true: the driver ensures that all writes are acknowledged by the MongoDB server, or else throws an exception. (see also w and wtimeoutMS). If set fo - false: the driver does not ensure that all writes are acknowledged by the MongoDB server.

boolean

true

quarkus.mongodb.write-concern.journal

Configures the journal writing aspect. If set to true: the driver waits for the server to group commit to the journal file on disk. If set to false: the driver does not wait for the server to group commit to the journal file on disk.

boolean

true

quarkus.mongodb.write-concern.w

When set, the driver adds w: wValue to all write commands. It requires safe to be true. The value is typically a number, but can also be the majority string.

string

quarkus.mongodb.write-concern.retry-writes

If set to true, the driver will retry supported write operations if they fail due to a network error.

boolean

false

quarkus.mongodb.write-concern.w-timeout

When set, the driver adds wtimeout : ms to all write commands. It requires safe to be true.

Duration

quarkus.mongodb.read-preference

Configures the read preferences. Supported values are: primary|primaryPreferred|secondary|secondaryPreferred|nearest

string

quarkus.mongodb.credentials.username

Configures the username.

string

quarkus.mongodb.credentials.password

Configures the password.

string

quarkus.mongodb.credentials.auth-mechanism

Configures the authentication mechanism to use if a credential was supplied. The default is unspecified, in which case the client will pick the most secure mechanism available based on the sever version. For the GSSAPI and MONGODB-X509 mechanisms, no password is accepted, only the username. Supported values: MONGO-CR|GSSAPI|PLAIN|MONGODB-X509

string

quarkus.mongodb.credentials.auth-source

Configures the source of the authentication credentials. This is typically the database that the credentials have been created. The value defaults to the database specified in the path portion of the connection string or in the 'database' configuration property.. If the database is specified in neither place, the default value is admin. This option is only respected when using the MONGO-CR mechanism (the default).

string

quarkus.mongodb.max-wait-queue-size

Configures the maximum number of concurrent operations allowed to wait for a server to become available. All further operations will get an exception immediately.

int

quarkus.mongodb.credentials.auth-mechanism-properties."auth-mechanism-properties"

Allows passing authentication mechanism properties.

String

Narayana Jta

quarkus.transaction-manager.node-name

The node name used by the transaction manager

string

quarkus

quarkus.transaction-manager.xa-node-name

The XA node name used by the transaction manager

string

quarkus.transaction-manager.default-transaction-timeout

The default transaction timeout

Duration

60

Neo4j

quarkus.neo4j.uri

The uri this driver should connect to. The driver supports bolt, bolt+routing or neo4j as schemes.

string

bolt://localhost:7687

quarkus.neo4j.authentication.username

The login of the user connecting to the database.

string

neo4j

quarkus.neo4j.authentication.password

The password of the user connecting to the database.

string

neo4j

quarkus.neo4j.authentication.disabled

Set this to true to disable authentication.

boolean

false

quarkus.neo4j.pool.metrics-enabled

Flag, if metrics are enabled.

boolean

false

quarkus.neo4j.pool.log-leaked-sessions

Flag, if leaked sessions logging is enabled.

boolean

false

quarkus.neo4j.pool.max-connection-pool-size

The maximum amount of connections in the connection pool towards a single database.

int

100

quarkus.neo4j.pool.idle-time-before-connection-test

Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again. The value 0 means connections will always be tested for validity and negative values mean connections will never be tested.

Duration

-0.001S

quarkus.neo4j.pool.max-connection-lifetime

Pooled connections older than this threshold will be closed and removed from the pool.

Duration

1H

quarkus.neo4j.pool.connection-acquisition-timeout

Acquisition of new connections will be attempted for at most configured timeout.

Duration

1M

Oidc

quarkus.oidc.auth-server-url

The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'. All the other OIDC server page and service URLs are derived from this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: 'https://host:port/auth/realms/{realm}' where '{realm}' has to be replaced by the name of the Keycloak realm.

string

quarkus.oidc.introspection-path

Relative path of the RFC7662 introspection service.

string

quarkus.oidc.jwks-path

Relative path of the OIDC service returning a JWK set.

string

quarkus.oidc.public-key

Public key for the local JWT token verification.

string

quarkus.oidc.client-id

The client-id of the application. Each application has a client-id that is used to identify the application

string

quarkus.oidc.credentials.secret

The client secret

string

Reactive Mysql Client

quarkus.datasource.url

The datasource URL.

string

quarkus.datasource.username

The datasource username.

string

quarkus.datasource.password

The datasource password.

string

quarkus.datasource.max-size

The datasource pool maximum size.

int

quarkus.reactive-mysql-client.cache-prepared-statements

Whether prepared statements should be cached on the client side.

boolean

quarkus.reactive-mysql-client.charset

Charset for connections.

string

quarkus.reactive-mysql-client.collation

Collation for connections.

string

Reactive Pg Client

quarkus.reactive-pg-client.cache-prepared-statements

Whether prepared statements should be cached on the client side.

boolean

quarkus.reactive-pg-client.pipelining-limit

The maximum number of inflight database commands that can be pipelined.

int

quarkus.datasource.url

The datasource URL.

string

quarkus.datasource.username

The datasource username.

string

quarkus.datasource.password

The datasource password.

string

quarkus.datasource.max-size

The datasource pool maximum size.

int

Resteasy Server

quarkus.resteasy.singleton-resources

If this is true then JAX-RS will use only a single instance of a resource class to service all requests. If this is false then it will create a new instance of the resource per request. If the resource class has an explicit CDI scope annotation then the value of this annotation will always be used to control the lifecycle of the resource class. IMPLEMENTATION NOTE: javax.ws.rs.Path turns into a CDI stereotype with singleton scope. As a result, if a user annotates a JAX-RS resource with a stereotype which has a different default scope the deployment fails with IllegalStateException.

boolean

true

quarkus.resteasy.path

Set this to override the default path for JAX-RS resources if there are no annotated application classes.

string

/

Resteasy

quarkus.resteasy.gzip.enabled

If gzip is enabled

boolean

false

quarkus.resteasy.gzip.max-input

Maximum deflated file bytes size If the limit is exceeded, Resteasy will return Response with status 413("Request Entity Too Large")

MemorySize

10M

Security

quarkus.security.security-providers

List of security providers to enable for reflection

string

Smallrye Health

quarkus.smallrye-health.root-path

Root path for health-checking servlets.

string

/health

quarkus.smallrye-health.liveness-path

The relative path of the liveness health-checking servlet.

string

/live

quarkus.smallrye-health.readiness-path

The relative path of the readiness health-checking servlet.

string

/ready

quarkus.health.extensions.enabled

Whether or not extensions published health check should be enabled.

boolean

true

Smallrye Jwt

quarkus.smallrye-jwt.enabled

The MP-JWT configuration object

boolean

true

quarkus.smallrye-jwt.rsa-sig-provider

The name of the java.security.Provider that supports SHA256withRSA signatures

string

SunRsaSign

Smallrye Metrics

quarkus.smallrye-metrics.path

The path to the metrics handler.

string

/metrics

Smallrye Openapi

quarkus.smallrye-openapi.path

The path at which to register the OpenAPI Servlet.

string

/openapi

Swaggerui

quarkus.swagger-ui.path

The path of the swagger-ui servlet. The value / is not allowed as it blocks the application from serving anything else.

string

/swagger-ui

quarkus.swagger-ui.always-include

If this should be included every time. By default this is only included when the application is running in dev mode.

boolean

false

Tika

quarkus.tika.tika-config-path

The resource path within the application artifact to the tika-config.xml file.

string

quarkus.tika.parsers

Comma separated list of the parsers which must be supported. Most of the document formats recognized by Apache Tika are supported by default but it affects the application memory and native executable sizes. One can list only the required parsers in tika-config.xml to minimize a number of parsers loaded into the memory, but using this property is recommended to achieve both optimizations. Either the abbreviated or full parser class names can be used. At the moment only PDF parser can be listed using a reserved 'pdf' abbreviation. Custom class name abbreviations have to be used for all other parsers. For example: // Only PDF parser is required: tika-parsers = pdf // Only PDF and Java class parsers are required: tika-parsers = pdf,classparser classparser = org.apache.tika.parser.asm.ClassParser This property will have no effect if the `tikaConfigPath' property has been set.

string

quarkus.tika.append-embedded-content

Controls how the content of the embedded documents is parsed. By default it is appended to the master document content. Setting this property to false makes the content of each of the embedded documents available separately.

boolean

true

Undertow Websockets

quarkus.hot-reload.password

string

quarkus.hot-reload.url

string

Undertow

quarkus.servlet.context-path

The context path to serve all Servlet context from. This will also affect any resources that run as a Servlet, e.g. JAX-RS. Note that this is relative to the HTTP root path set in quarkus.http.root-path, so if the context path is /bar and the http root is /foo then the actual Servlet path will be /foo/bar.

string

quarkus.servlet.buffer-size

The buffer size to use for Servlet. If this is not specified the default will depend on the amount of available memory. If there is less than 64mb it will default to 512b heap buffer, less that 128mb 1k direct buffer and otherwise 16k direct buffers.

MemorySize

quarkus.servlet.direct-buffers

If Servlet should use direct buffers, this gives maximum performance but can be problematic in memory constrained environments

boolean

Vertx Core

quarkus.vertx.caching

Enables or disables the Vert.x cache.

boolean

true

quarkus.vertx.classpath-resolving

Enables or disabled the Vert.x classpath resource resolver.

boolean

true

quarkus.vertx.event-loops-pool-size

The number of event loops. 2 x the number of core by default.

int

quarkus.vertx.max-event-loop-execute-time

The maximum amount of time the event loop can be blocked. Default is 2s.

Duration

quarkus.vertx.warning-exception-time

The amount of time before a warning is displayed if the event loop is blocked.

Duration

2

quarkus.vertx.worker-pool-size

The size of the worker thread pool.

int

20

quarkus.vertx.max-worker-execute-time

The maximum amount of time the worker thread can be blocked. Default is 10s.

Duration

quarkus.vertx.internal-blocking-pool-size

The size of the internal thread pool (used for the file system).

int

20

quarkus.vertx.use-async-dns

Enables the async DNS resolver.

boolean

false

quarkus.vertx.eventbus.key-certificate-pem.keys

Comma-separated list of the path to the key files (Pem format).

string

quarkus.vertx.eventbus.key-certificate-pem.certs

Comma-separated list of the path to the certificate files (Pem format).

string

quarkus.vertx.eventbus.key-certificate-jks.path

Path of the key file (JKS format).

string

quarkus.vertx.eventbus.key-certificate-jks.password

Password of the key file.

string

quarkus.vertx.eventbus.key-certificate-pfx.path

Path to the key file (PFX format)

string

quarkus.vertx.eventbus.key-certificate-pfx.password

Password of the key.

string

quarkus.vertx.eventbus.trust-certificate-pem.certs

Comma-separated list of the trust certificate files (Pem format).

string

quarkus.vertx.eventbus.trust-certificate-jks.path

Path of the key file (JKS format).

string

quarkus.vertx.eventbus.trust-certificate-jks.password

Password of the key file.

string

quarkus.vertx.eventbus.trust-certificate-pfx.path

Path to the key file (PFX format)

string

quarkus.vertx.eventbus.trust-certificate-pfx.password

Password of the key.

string

quarkus.vertx.eventbus.accept-backlog

The accept backlog.

int

quarkus.vertx.eventbus.client-auth

The client authentication.

string

NONE

quarkus.vertx.eventbus.connect-timeout

The connect timeout.

Duration

60

quarkus.vertx.eventbus.idle-timeout

The idle timeout in milliseconds.

Duration

quarkus.vertx.eventbus.receive-buffer-size

The receive buffer size.

int

quarkus.vertx.eventbus.reconnect-attempts

The number of reconnection attempts.

int

0

quarkus.vertx.eventbus.reconnect-interval

The reconnection interval in milliseconds.

Duration

1

quarkus.vertx.eventbus.reuse-address

Whether or not to reuse the address.

boolean

true

quarkus.vertx.eventbus.reuse-port

Whether or not to reuse the port.

boolean

false

quarkus.vertx.eventbus.send-buffer-size

The send buffer size.

int

quarkus.vertx.eventbus.soLinger

The so linger.

int

quarkus.vertx.eventbus.ssl

Enables or Disabled SSL.

boolean

false

quarkus.vertx.eventbus.tcp-keep-alive

Whether or not to keep the TCP connection opened (keep-alive).

boolean

false

quarkus.vertx.eventbus.tcp-no-delay

Configure the TCP no delay.

boolean

true

quarkus.vertx.eventbus.traffic-class

Configure the traffic class.

int

quarkus.vertx.eventbus.trust-all

Enables or disables the trust all parameter.

boolean

false

quarkus.vertx.cluster.host

The host name.

string

localhost

quarkus.vertx.cluster.port

The port.

int

quarkus.vertx.cluster.public-host

The public host name.

string

quarkus.vertx.cluster.public-port

The public port.

int

quarkus.vertx.cluster.clustered

Enables or disables the clustering.

boolean

false

quarkus.vertx.cluster.ping-interval

The ping interval.

Duration

20

quarkus.vertx.cluster.ping-reply-interval

The ping reply interval.

Duration

20

Vertx Http

quarkus.http.root-path

The HTTP root path. All web content will be served relative to this root path.

string

/

quarkus.http.auth.basic

If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. If no authentication mechanisms are configured basic auth is the default, unless an io.quarkus.security.identity.IdentityProvider is present that supports io.quarkus.security.identity.request.TokenAuthenticationRequest in which case form auth will be the default.

boolean

false

quarkus.http.auth.form

If form auth should be enabled.

boolean

false

quarkus.http.auth.realm

The authentication realm

string

Quarkus

quarkus.http.cors

Enable the CORS filter.

boolean

false

quarkus.http.port

The HTTP port

int

8080

quarkus.http.test-port

The HTTP port used to run tests

int

8081

quarkus.http.host

The HTTP host

string

0.0.0.0

quarkus.http.ssl-port

The HTTPS port

int

8443

quarkus.http.test-ssl-port

The HTTPS port used to run tests

int

8444

quarkus.http.cors.origins

Origins allowed for CORS Comma separated list of valid URLs. ex: http://www.quarkus.io,http://localhost:3000 The filter allows any origin if this is not set. default: returns any requested origin as valid

string

quarkus.http.cors.methods

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

options, get, head, post, put, delete, trace, connect, patch, other

quarkus.http.cors.headers

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

string

quarkus.http.cors.exposed-headers

HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty

string

quarkus.http.cors.access-control-max-age

The Access-Control-Max-Age response header value indicating how long the results of a pre-flight request can be cached.

Duration

quarkus.http.ssl.certificate.file

The file path to a server certificate or certificate chain in PEM format.

path

quarkus.http.ssl.certificate.key-file

The file path to the corresponding certificate private key file in PEM format.

path

quarkus.http.ssl.certificate.key-store-file

An optional key store which holds the certificate information instead of specifying separate files.

path

quarkus.http.ssl.certificate.key-store-file-type

An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name.

string

quarkus.http.ssl.certificate.key-store-password

A parameter to specify the password of the key store file. If not given, the default ("password") is used.

string

password

quarkus.http.ssl.cipher-suites

The cipher suites to use. If none is given, a reasonable default is selected.

string

quarkus.http.ssl.protocols

The list of protocols to explicitly enable.

string

TLSv1.3,TLSv1.2

quarkus.http.io-threads

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.

int

quarkus.http.virtual

If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes.

boolean

false

quarkus.http.limits.max-header-size

The the maximum length of all headers.

MemorySize

20K

quarkus.http.limits.max-body-size

The maximum size of a request body. Default: no limit.

MemorySize

quarkus.http.body.handle-file-uploads

Whether the files sent using multipart/form-data will be stored locally. If true, they will be stored in quarkus.http.body-handler.uploads-directory and will be made available via io.vertx.ext.web.RoutingContext.fileUploads(). Otherwise, the the files sent using multipart/form-data will not be stored locally, and io.vertx.ext.web.RoutingContext.fileUploads() will always return an empty collection. Note that even with this option being set to false, the multipart/form-data requests will be accepted.

boolean

true

quarkus.http.body.uploads-directory

The directory where the files sent using multipart/form-data should be stored. Either an absolute path or a path relative to the current directory of the application process.

string

file-uploads

quarkus.http.body.merge-form-attributes

Whether the form attributes should be added to the request parameters. If true, the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters

boolean

true

quarkus.http.body.delete-uploaded-files-on-end

Whether the uploaded files should be removed after serving the request. If true the uploaded files stored in quarkus.http.body-handler.uploads-directory will be removed after handling the request. Otherwise the files will be left there forever.

boolean

false

quarkus.http.body.preallocate-body-buffer

Whether the body buffer should pre-allocated based on the Content-Length header value. If true the body buffer is pre-allocated according to the size read from the Content-Length header. Otherwise the body buffer is pre-allocated to 1KB, and is resized dynamically

boolean

false

quarkus.http.auth.permission."permissions".policy

The HTTP policy that this permission set is linked to. There are 3 built in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.

string

quarkus.http.auth.permission."permissions".methods

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.

string

quarkus.http.auth.permission."permissions".paths

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 over matches without methods set, otherwise the most restrictive permissions are applied.

string

quarkus.http.auth.policy."role-policy".roles-allowed

The roles that are allowed to access resources protected by this policy

string

About the Duration format

The format for durations uses the standard java.time.Duration format. You can learn more about it in the Duration#parse() javadoc.

You can also provide duration values starting with a number. In this case, if the value consists only of a number, the converter treats the value as seconds. Otherwise, PT is implicitly appended to the value to obtain a standard java.time.Duration format.

About the MemorySize format

A size configuration option recognises string in this format (shown as a regular expression): [0-9]+[KkMmGgTtPpEeZzYy]?. If no suffix is given, assume bytes.