Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

If set to true, the application will attempt to look up the configuration from Consul

Environment variable: QUARKUS_CONSUL_CONFIG_ENABLED

boolean

false

Consul agent host

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_HOST_PORT

InetSocketAddress

localhost:8500

Whether or not to use HTTPS when communicating with the agent

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_USE_HTTPS

boolean

false

Consul token to be provided when authentication is enabled

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_TOKEN

string

TrustStore to be used containing the SSL certificate used by Consul agent Can be either a classpath resource or a file system path

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_TRUST_STORE

path

Password of TrustStore to be used containing the SSL certificate used by Consul agent

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_TRUST_STORE_PASSWORD

string

KeyStore to be used containing the SSL certificate for authentication with Consul agent Can be either a classpath resource or a file system path

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_KEY_STORE

path

Password of KeyStore to be used containing the SSL certificate for authentication with Consul agent

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_KEY_STORE_PASSWORD

string

Password to recover key from KeyStore for SSL client authentication with Consul agent If no value is provided, the key-store-password will be used

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_KEY_PASSWORD

string

When using HTTPS and no keyStore has been specified, whether or not to trust all certificates

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_TRUST_CERTS

boolean

false

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

Specify 0 to wait indefinitely.

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_CONNECTION_TIMEOUT

Duration

10s

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

Specify 0 to wait indefinitely.

Environment variable: QUARKUS_CONSUL_CONFIG_AGENT_READ_TIMEOUT

Duration

60s

Common prefix that all keys share when looking up the keys from Consul. The prefix is not included in the keys of the user configuration

Environment variable: QUARKUS_CONSUL_CONFIG_PREFIX

string

Keys whose value is a raw string. When this is used, the keys that end up in the user configuration are the keys specified her with '/' replaced by '.'

Environment variable: QUARKUS_CONSUL_CONFIG_RAW_VALUE_KEYS

list of string

Keys whose value represents a properties file. When this is used, the keys that end up in the user configuration are the keys of the properties file, not these keys

Environment variable: QUARKUS_CONSUL_CONFIG_PROPERTIES_VALUE_KEYS

list of string

If set to true, the application will not start if any of the configured config sources cannot be located

Environment variable: QUARKUS_CONSUL_CONFIG_FAIL_ON_MISSING_KEY

boolean

true

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.