diff --git a/_data/versioned/latest/index/quarkus.yaml b/_data/versioned/latest/index/quarkus.yaml index 0f188f3644b..1b5eed51d1e 100644 --- a/_data/versioned/latest/index/quarkus.yaml +++ b/_data/versioned/latest/index/quarkus.yaml @@ -128,6 +128,17 @@ types: - io.quarkus:quarkus-infinispan-client type: reference url: /guides/infinispan-client-reference + - title: Load Shedding reference guide + filename: load-shedding-reference.adoc + summary: Load shedding is the practice of detecting service overload and rejecting requests. + categories: web + topics: + - web + - load-shedding + extensions: + - io.quarkus:quarkus-load-shedding + type: reference + url: /guides/load-shedding-reference - title: Logging configuration filename: logging.adoc summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs." @@ -302,6 +313,20 @@ types: - io.quarkus:quarkus-smallrye-stork type: reference url: /guides/stork-reference + - title: TLS registry reference + filename: tls-registry-reference.adoc + summary: TLS registry configuration and usage + topics: + - TLS + - http + - SSL + - HTTPS + - security + - network + extensions: + - io.quarkus:quarkus-tls-registry + type: reference + url: /guides/tls-registry-reference - title: Using transactions in Quarkus filename: transaction.adoc summary: "The quarkus-narayana-jta extension provides a Transaction Manager that coordinates and expose transactions to your applications as described in the link: Jakarta Transactions specification, formerly known as Java Transaction API (JTA)." @@ -726,7 +751,7 @@ types: id: security-getting-started-tutorial type: tutorial url: /guides/security-getting-started-tutorial - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next filename: websockets-next-tutorial.adoc summary: This guide explains how your Quarkus application can utilize web sockets to create interactive web applications. categories: web @@ -1117,7 +1142,7 @@ types: url: /guides/grpc-service-consumption - title: Container Images filename: container-image.adoc - summary: "Learn how to build and push container images with Jib, OpenShift or Docker as part of the Quarkus build." + summary: "Learn how to build and push container images with Jib, OpenShift, Docker, or Podman as part of the Quarkus build." categories: cloud topics: - devops @@ -1126,6 +1151,7 @@ types: - io.quarkus:quarkus-container-image-openshift - io.quarkus:quarkus-container-image-jib - io.quarkus:quarkus-container-image-docker + - io.quarkus:quarkus-container-image-podman - io.quarkus:quarkus-container-image-buildpack type: guide url: /guides/container-image @@ -1350,6 +1376,11 @@ types: - io.quarkus:quarkus-kubernetes-client type: guide url: /guides/kubernetes-dev-services + - title: Dev Services for MongoDB + filename: mongodb-dev-services.adoc + summary: Quarkus supports a feature called Dev Services that allows you to create various datasources without any config. + type: guide + url: /guides/mongodb-dev-services - title: Dev Services for Pulsar filename: pulsar-dev-services.adoc summary: With Quarkus Messaging Pulsar extension (quarkus-messaging-pulsar) Dev Services for Pulsar automatically starts a Pulsar broker in dev mode and when running tests. @@ -2492,6 +2523,17 @@ types: - io.quarkus:quarkus-hibernate-reactive type: guide url: /guides/hibernate-reactive + - title: Using JDK Flight Recorder + filename: jfr.adoc + summary: This guide explains how JDK Flight Recorder can be extended to provide insight into your Quarkus application. + categories: observability + topics: + - observability + - jfr + extensions: + - io.quarkus:quarkus-jfr + type: guide + url: /guides/jfr - title: Using JMS filename: jms.adoc summary: "This guide demonstrates how your Quarkus application can use JMS messaging with AMQP 1.0 using Apache Qpid JMS, or using Apache ActiveMQ Artemis JMS." diff --git a/_data/versioned/latest/index/relations.yaml b/_data/versioned/latest/index/relations.yaml index e192050589a..75b41e39e6a 100644 --- a/_data/versioned/latest/index/relations.yaml +++ b/_data/versioned/latest/index/relations.yaml @@ -1732,6 +1732,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -2340,6 +2344,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using JWT RBAC url: /guides/security-jwt type: guide @@ -7174,10 +7182,18 @@ url: /guides/security-getting-started-tutorial type: tutorial matches: 1 - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using WebSockets url: /guides/websockets type: guide @@ -7797,6 +7813,48 @@ url: /guides/stork-kubernetes type: guide matches: 1 +/guides/jfr: + sameTopics: + - title: "Centralized log management (Graylog, Logstash, Fluentd)" + url: /guides/centralized-log-management + type: guide + matches: 1 + - title: Collect metrics using Micrometer + url: /guides/telemetry-micrometer-tutorial + type: tutorial + matches: 1 + - title: Logging configuration + url: /guides/logging + type: reference + matches: 1 + - title: Management interface reference + url: /guides/management-interface-reference + type: reference + matches: 1 + - title: Micrometer Metrics + url: /guides/telemetry-micrometer + type: reference + matches: 1 + - title: Migrate from OpenTracing to OpenTelemetry tracing + url: /guides/telemetry-opentracing-to-otel-tutorial + type: tutorial + matches: 1 + - title: Observability Dev Services + url: /guides/observability-devservices + type: guide + matches: 1 + - title: SmallRye Health + url: /guides/smallrye-health + type: guide + matches: 1 + - title: SmallRye Metrics + url: /guides/smallrye-metrics + type: guide + matches: 1 + - title: Using OpenTelemetry + url: /guides/opentelemetry + type: guide + matches: 1 /guides/jms: sameTopics: - title: Apache Kafka Reference Guide @@ -9262,6 +9320,36 @@ url: /guides/transaction type: reference matches: 1 +/guides/load-shedding-reference: + sameTopics: + - title: Getting started with WebSockets Next + url: /guides/websockets-next-tutorial + type: tutorial + matches: 1 + - title: HTTP Reference + url: /guides/http-reference + type: reference + matches: 1 + - title: Quarkus for the Web + url: /guides/web + type: guide + matches: 1 + - title: Using Reactive Routes + url: /guides/reactive-routes + type: guide + matches: 1 + - title: Using WebSockets + url: /guides/websockets + type: guide + matches: 1 + - title: Web dependency locator + url: /guides/web-dependency-locator + type: guide + matches: 1 + - title: WebSockets Next extension reference guide + url: /guides/websockets-next-reference + type: reference + matches: 1 /guides/logging: sameTopics: - title: "Centralized log management (Graylog, Logstash, Fluentd)" @@ -9296,6 +9384,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -9478,6 +9570,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -10263,6 +10359,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -10359,6 +10459,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 sameExtensions: - title: Migrate from OpenTracing to OpenTelemetry tracing url: /guides/telemetry-opentracing-to-otel-tutorial @@ -11536,10 +11640,18 @@ url: /guides/security-getting-started-tutorial type: tutorial matches: 1 - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using WebSockets url: /guides/websockets type: guide @@ -12940,6 +13052,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -13082,6 +13198,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -13136,6 +13256,10 @@ url: /guides/security-oidc-code-flow-authentication-tutorial type: tutorial matches: 2 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 2 - title: Using Keycloak Admin Client url: /guides/security-keycloak-admin-client type: guide @@ -13391,6 +13515,10 @@ url: /guides/security-oidc-bearer-token-authentication-tutorial type: tutorial matches: 2 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 2 - title: Using Keycloak Admin Client url: /guides/security-keycloak-admin-client type: guide @@ -13586,6 +13714,10 @@ url: /guides/security-oidc-bearer-token-authentication-tutorial type: tutorial matches: 2 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 2 - title: Using Keycloak Admin Client url: /guides/security-keycloak-admin-client type: guide @@ -13791,6 +13923,10 @@ url: /guides/security-getting-started-tutorial type: tutorial matches: 2 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 2 - title: Authentication mechanisms in Quarkus url: /guides/security-authentication-mechanisms type: concepts @@ -14017,6 +14153,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -14095,6 +14235,10 @@ url: /guides/security-oidc-bearer-token-authentication-tutorial type: tutorial matches: 2 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 2 - title: Using Keycloak Admin Client url: /guides/security-keycloak-admin-client type: guide @@ -14362,6 +14506,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -14553,6 +14701,10 @@ url: /guides/hibernate-reactive-panache type: guide matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -14744,6 +14896,10 @@ url: /guides/hibernate-reactive-panache type: guide matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -14895,6 +15051,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15029,6 +15189,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15171,6 +15335,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15309,6 +15477,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15476,6 +15648,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15627,6 +15803,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15757,6 +15937,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -15924,6 +16108,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -16091,6 +16279,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -16262,6 +16454,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -16421,6 +16617,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -16588,6 +16788,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -16727,6 +16931,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -16942,6 +17150,10 @@ url: /guides/getting-started-testing type: guide matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -17109,6 +17321,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -17296,6 +17512,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -17455,6 +17675,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -17597,6 +17821,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -17768,6 +17996,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -17950,6 +18182,10 @@ url: /guides/getting-started-testing type: guide matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -18084,6 +18320,10 @@ url: /guides/security-customization type: guide matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -18230,6 +18470,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -18304,6 +18548,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -18342,6 +18590,10 @@ url: /guides/smallrye-health type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -19188,6 +19440,10 @@ url: /guides/security-vulnerability-detection type: concepts matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using a Credentials Provider url: /guides/credentials-provider type: guide @@ -19437,6 +19693,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -19480,6 +19740,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 - title: Using OpenTelemetry url: /guides/opentelemetry type: guide @@ -19527,6 +19791,10 @@ url: /guides/smallrye-metrics type: guide matches: 1 + - title: Using JDK Flight Recorder + url: /guides/jfr + type: guide + matches: 1 sameExtensions: - title: Using OpenTelemetry url: /guides/opentelemetry @@ -19646,6 +19914,160 @@ url: /guides/podman type: guide matches: 1 +/guides/tls-registry-reference: + sameTopics: + - title: Authorization of web endpoints + url: /guides/security-authorize-web-endpoints-reference + type: reference + matches: 2 + - title: Basic authentication + url: /guides/security-basic-authentication + type: concepts + matches: 2 + - title: Cross-Site Request Forgery Prevention + url: /guides/security-csrf-prevention + type: guide + matches: 2 + - title: Enable Basic authentication + url: /guides/security-basic-authentication-howto + type: howto + matches: 2 + - title: Getting started with Security by using Basic authentication and Jakarta Persistence + url: /guides/security-getting-started-tutorial + type: tutorial + matches: 2 + - title: Authentication mechanisms in Quarkus + url: /guides/security-authentication-mechanisms + type: concepts + matches: 1 + - title: "Build, Sign and Encrypt JSON Web Tokens" + url: /guides/security-jwt-build + type: guide + matches: 1 + - title: Configuring Well-Known OpenID Connect Providers + url: /guides/security-openid-connect-providers + type: concepts + matches: 1 + - title: Dev Services and Dev UI for OpenID Connect (OIDC) + url: /guides/security-openid-connect-dev-services + type: howto + matches: 1 + - title: HTTP Reference + url: /guides/http-reference + type: reference + matches: 1 + - title: Identity providers + url: /guides/security-identity-providers + type: concepts + matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 client and filters + url: /guides/security-openid-connect-client-reference + type: reference + matches: 1 + - title: OpenID Connect (OIDC) Bearer token authentication + url: /guides/security-oidc-bearer-token-authentication + type: concepts + matches: 1 + - title: OpenID Connect (OIDC) configuration properties + url: /guides/security-oidc-configuration-properties-reference + type: reference + matches: 1 + - title: OpenID Connect authorization code flow mechanism for protecting web applications + url: /guides/security-oidc-code-flow-authentication + type: concepts + matches: 1 + - title: OpenID Connect client and token propagation quickstart + url: /guides/security-openid-connect-client + type: tutorial + matches: 1 + - title: Proactive authentication + url: /guides/security-proactive-authentication + type: concepts + matches: 1 + - title: Protect a service application by using OpenID Connect (OIDC) Bearer token authentication + url: /guides/security-oidc-bearer-token-authentication-tutorial + type: tutorial + matches: 1 + - title: Protect a web application by using OpenID Connect (OIDC) authorization code flow + url: /guides/security-oidc-code-flow-authentication-tutorial + type: tutorial + matches: 1 + - title: Quarkus for the Web + url: /guides/web + type: guide + matches: 1 + - title: Quarkus Security architecture + url: /guides/security-architecture + type: concepts + matches: 1 + - title: Quarkus Security overview + url: /guides/security-overview + type: concepts + matches: 1 + - title: Quarkus Security with Jakarta Persistence + url: /guides/security-jpa + type: howto + matches: 1 + - title: Security Testing + url: /guides/security-testing + type: guide + matches: 1 + - title: Security Tips and Tricks + url: /guides/security-customization + type: guide + matches: 1 + - title: Security vulnerability detection and reporting in Quarkus + url: /guides/security-vulnerability-detection + type: concepts + matches: 1 + - title: Using a Credentials Provider + url: /guides/credentials-provider + type: guide + matches: 1 + - title: Using JWT RBAC + url: /guides/security-jwt + type: guide + matches: 1 + - title: Using Keycloak Admin Client + url: /guides/security-keycloak-admin-client + type: guide + matches: 1 + - title: Using OAuth2 RBAC + url: /guides/security-oauth2 + type: guide + matches: 1 + - title: Using OpenID Connect (OIDC) and Keycloak to centralize authorization + url: /guides/security-keycloak-authorization + type: howto + matches: 1 + - title: Using OpenID Connect (OIDC) multitenancy + url: /guides/security-openid-connect-multitenancy + type: howto + matches: 1 + - title: Using Reactive Routes + url: /guides/reactive-routes + type: guide + matches: 1 + - title: Using Security with .properties File + url: /guides/security-properties + type: guide + matches: 1 + - title: Using Security with an LDAP Realm + url: /guides/security-ldap + type: guide + matches: 1 + - title: Using Security with JDBC + url: /guides/security-jdbc + type: guide + matches: 1 + - title: Using Security with WebAuthn + url: /guides/security-webauthn + type: guide + matches: 1 + - title: Web dependency locator + url: /guides/web-dependency-locator + type: guide + matches: 1 /guides/tooling: sameTopics: - title: Building Quarkus apps with Quarkus Command Line Interface (CLI) @@ -20002,10 +20424,14 @@ url: /guides/security-getting-started-tutorial type: tutorial matches: 1 - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 - title: Qute Reference Guide url: /guides/qute-reference type: reference @@ -20014,6 +20440,10 @@ url: /guides/qute type: guide matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using WebSockets url: /guides/websockets type: guide @@ -20056,10 +20486,18 @@ url: /guides/security-getting-started-tutorial type: tutorial matches: 1 - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 - title: Using WebSockets url: /guides/websockets type: guide @@ -20070,7 +20508,7 @@ matches: 1 /guides/websockets: sameTopics: - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 2 @@ -20082,6 +20520,10 @@ url: /guides/http-reference type: reference matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 - title: Quarkus for the Web url: /guides/web type: guide @@ -20096,7 +20538,7 @@ matches: 1 /guides/websockets-next-reference: sameTopics: - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 2 @@ -20108,6 +20550,10 @@ url: /guides/http-reference type: reference matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 - title: Quarkus for the Web url: /guides/web type: guide @@ -20121,7 +20567,7 @@ type: guide matches: 1 sameExtensions: - - title: Getting started with WebSockets-Next + - title: Getting started with WebSockets Next url: /guides/websockets-next-tutorial type: tutorial matches: 1 @@ -20139,6 +20585,10 @@ url: /guides/http-reference type: reference matches: 1 + - title: Load Shedding reference guide + url: /guides/load-shedding-reference + type: reference + matches: 1 - title: Quarkus for the Web url: /guides/web type: guide diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration index 40b03cc9dbd..37338735a4a 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":".use-quarkus-grpc-client","additionalKeys":[],"configDoc":"Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-quarkus-grpc-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USE_QUARKUS_GRPC_CLIENT","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".xds","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.ClientXds","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".xds.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of XDS.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_XDS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".xds.secure","additionalKeys":[],"configDoc":"Use secure credentials.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"secure","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_XDS_SECURE","enum":false}},{"configDocKey":{"type":"string","key":".xds.target","additionalKeys":[],"configDoc":"Optional explicit target.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"target","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_XDS_TARGET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".in-process","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.InProcess","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".in-process.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of in-process.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IN_PROCESS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".in-process.name","additionalKeys":[],"configDoc":"Set in-process name.","withinAMap":false,"defaultValue":"quarkus-grpc","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IN_PROCESS_NAME","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".stork","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.StorkConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"int","key":".stork.threads","additionalKeys":[],"configDoc":"Number of threads on a delayed gRPC ClientCall","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"threads","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_THREADS","enum":false}},{"configDocKey":{"type":"long","key":".stork.deadline","additionalKeys":[],"configDoc":"Deadline in milliseconds of delayed gRPC call","withinAMap":false,"defaultValue":"5000","javaDocSiteLink":"","docMapKey":"deadline","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_DEADLINE","enum":false}},{"configDocKey":{"type":"int","key":".stork.retries","additionalKeys":[],"configDoc":"Number of retries on a gRPC ClientCall","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"retries","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_RETRIES","enum":false}},{"configDocKey":{"type":"long","key":".stork.delay","additionalKeys":[],"configDoc":"Initial delay in seconds on refresh check","withinAMap":false,"defaultValue":"60","javaDocSiteLink":"","docMapKey":"delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_DELAY","enum":false}},{"configDocKey":{"type":"long","key":".stork.period","additionalKeys":[],"configDoc":"Refresh period in seconds","withinAMap":false,"defaultValue":"120","javaDocSiteLink":"","docMapKey":"period","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_PERIOD","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"int","key":".port","additionalKeys":[],"configDoc":"The gRPC service port.","withinAMap":false,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".test-port","additionalKeys":[],"configDoc":"The gRPC service test port.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":".host","additionalKeys":[],"configDoc":"The host name / IP on which the service is exposed.","withinAMap":false,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOST","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".ssl","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.SslClientConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"path","key":".ssl.certificate","additionalKeys":[],"configDoc":"The classpath path or file path to a server certificate or certificate chain in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL_CERTIFICATE","enum":false}},{"configDocKey":{"type":"path","key":".ssl.key","additionalKeys":[],"configDoc":"The classpath path or file path to the corresponding certificate private key file in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL_KEY","enum":false}},{"configDocKey":{"type":"path","key":".ssl.trust-store","additionalKeys":[],"configDoc":"An optional trust store which holds the certificate information of the certificates to trust The trust store can be either on classpath or in an external file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL_TRUST_STORE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tls","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.verify-hostname","additionalKeys":[],"configDoc":"Whether hostname should be verified in the SSL/TLS handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-hostname","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_VERIFY_HOSTNAME","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".name-resolver","additionalKeys":[],"configDoc":"Use a name resolver. Defaults to dns. If set to \"stork\", host will be treated as SmallRye Stork service name","withinAMap":false,"defaultValue":"dns","javaDocSiteLink":"","docMapKey":"name-resolver","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAME_RESOLVER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".plain-text","additionalKeys":[],"configDoc":"Whether `plain-text` should be used instead of `TLS`. Enabled by default, except if TLS/SSL is configured. In this case, `plain-text` is disabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"plain-text","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PLAIN_TEXT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".keep-alive-time","additionalKeys":[],"configDoc":"The duration after which a keep alive ping is sent.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-time","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".flow-control-window","additionalKeys":[],"configDoc":"The flow control window in bytes. Default is 1MiB.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"flow-control-window","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FLOW_CONTROL_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".idle-timeout","additionalKeys":[],"configDoc":"The duration without ongoing RPCs before going to idle mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".keep-alive-timeout","additionalKeys":[],"configDoc":"The amount of time the sender of a keep alive ping waits for an acknowledgement.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":".keep-alive-without-calls","additionalKeys":[],"configDoc":"Whether keep-alive will be performed when there are no outstanding RPC on a connection.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"keep-alive-without-calls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_WITHOUT_CALLS","enum":false}},{"configDocKey":{"type":"int","key":".max-hedged-attempts","additionalKeys":[],"configDoc":"The max number of hedged attempts.","withinAMap":false,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-hedged-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_HEDGED_ATTEMPTS","enum":false}},{"configDocKey":{"type":"int","key":".max-retry-attempts","additionalKeys":[],"configDoc":"The max number of retry attempts. Retry must be explicitly enabled.","withinAMap":false,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-retry-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_RETRY_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-trace-events","additionalKeys":[],"configDoc":"The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-trace-events","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_TRACE_EVENTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-inbound-message-size","additionalKeys":[],"configDoc":"The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-message-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_INBOUND_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-inbound-metadata-size","additionalKeys":[],"configDoc":"The maximum size of metadata allowed to be received (in bytes). Default is 8192B.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-metadata-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_INBOUND_METADATA_SIZE","enum":false}},{"configDocKey":{"type":"string","key":".negotiation-type","additionalKeys":[],"configDoc":"The negotiation type for the HTTP/2 connection. Accepted values are: `TLS`, `PLAINTEXT_UPGRADE`, `PLAINTEXT`","withinAMap":false,"defaultValue":"TLS","javaDocSiteLink":"","docMapKey":"negotiation-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NEGOTIATION_TYPE","enum":false}},{"configDocKey":{"type":"string","key":".override-authority","additionalKeys":[],"configDoc":"Overrides the authority used with TLS and HTTP virtual hosting.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"override-authority","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_OVERRIDE_AUTHORITY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".per-rpc-buffer-limit","additionalKeys":[],"configDoc":"The per RPC buffer limit in bytes used for retry.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"per-rpc-buffer-limit","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PER_RPC_BUFFER_LIMIT","enum":false}},{"configDocKey":{"type":"boolean","key":".retry","additionalKeys":[],"configDoc":"Whether retry is enabled. Note that retry is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"retry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RETRY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".retry-buffer-size","additionalKeys":[],"configDoc":"The retry buffer size in bytes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"retry-buffer-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RETRY_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"string","key":".user-agent","additionalKeys":[],"configDoc":"Use a custom user-agent.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USER_AGENT","enum":false}},{"configDocKey":{"type":"string","key":".load-balancing-policy","additionalKeys":[],"configDoc":"Use a custom load balancing policy. Accepted values are: `pick_first`, `round_robin`, `grpclb`. This value is ignored if name-resolver is set to 'stork'.","withinAMap":false,"defaultValue":"pick_first","javaDocSiteLink":"","docMapKey":"load-balancing-policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOAD_BALANCING_POLICY","enum":false}},{"configDocKey":{"type":"string","key":".compression","additionalKeys":[],"configDoc":"The compression to use for each call. The accepted values are `gzip` and `identity`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COMPRESSION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".deadline","additionalKeys":[],"configDoc":"The deadline used for each call.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"deadline","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEADLINE","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":".use-quarkus-grpc-client","additionalKeys":[],"configDoc":"Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-quarkus-grpc-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USE_QUARKUS_GRPC_CLIENT","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".xds","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.ClientXds","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".xds.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of XDS.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_XDS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".xds.secure","additionalKeys":[],"configDoc":"Use secure credentials.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"secure","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_XDS_SECURE","enum":false}},{"configDocKey":{"type":"string","key":".xds.target","additionalKeys":[],"configDoc":"Optional explicit target.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"target","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_XDS_TARGET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".in-process","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.InProcess","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".in-process.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of in-process.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IN_PROCESS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".in-process.name","additionalKeys":[],"configDoc":"Set in-process name.","withinAMap":false,"defaultValue":"quarkus-grpc","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IN_PROCESS_NAME","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".stork","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.StorkConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"int","key":".stork.threads","additionalKeys":[],"configDoc":"Number of threads on a delayed gRPC ClientCall","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"threads","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_THREADS","enum":false}},{"configDocKey":{"type":"long","key":".stork.deadline","additionalKeys":[],"configDoc":"Deadline in milliseconds of delayed gRPC call","withinAMap":false,"defaultValue":"5000","javaDocSiteLink":"","docMapKey":"deadline","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_DEADLINE","enum":false}},{"configDocKey":{"type":"int","key":".stork.retries","additionalKeys":[],"configDoc":"Number of retries on a gRPC ClientCall","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"retries","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_RETRIES","enum":false}},{"configDocKey":{"type":"long","key":".stork.delay","additionalKeys":[],"configDoc":"Initial delay in seconds on refresh check","withinAMap":false,"defaultValue":"60","javaDocSiteLink":"","docMapKey":"delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_DELAY","enum":false}},{"configDocKey":{"type":"long","key":".stork.period","additionalKeys":[],"configDoc":"Refresh period in seconds","withinAMap":false,"defaultValue":"120","javaDocSiteLink":"","docMapKey":"period","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORK_PERIOD","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"int","key":".port","additionalKeys":[],"configDoc":"The gRPC service port.","withinAMap":false,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".test-port","additionalKeys":[],"configDoc":"The gRPC service test port.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":".host","additionalKeys":[],"configDoc":"The host name / IP on which the service is exposed.","withinAMap":false,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOST","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".ssl","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.SslClientConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"path","key":".ssl.certificate","additionalKeys":[],"configDoc":"The classpath path or file path to a server certificate or certificate chain in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL_CERTIFICATE","enum":false}},{"configDocKey":{"type":"path","key":".ssl.key","additionalKeys":[],"configDoc":"The classpath path or file path to the corresponding certificate private key file in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL_KEY","enum":false}},{"configDocKey":{"type":"path","key":".ssl.trust-store","additionalKeys":[],"configDoc":"An optional trust store which holds the certificate information of the certificates to trust The trust store can be either on classpath or in an external file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL_TRUST_STORE","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used.\n\nImportant: This is only supported when using the Quarkus (Vert.x-based) gRPC client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tls","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.verify-hostname","additionalKeys":[],"configDoc":"Whether hostname should be verified in the SSL/TLS handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-hostname","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_VERIFY_HOSTNAME","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".name-resolver","additionalKeys":[],"configDoc":"Use a name resolver. Defaults to dns. If set to \"stork\", host will be treated as SmallRye Stork service name","withinAMap":false,"defaultValue":"dns","javaDocSiteLink":"","docMapKey":"name-resolver","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAME_RESOLVER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".plain-text","additionalKeys":[],"configDoc":"Whether `plain-text` should be used instead of `TLS`. Enabled by default, except if TLS/SSL is configured. In this case, `plain-text` is disabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"plain-text","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PLAIN_TEXT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".keep-alive-time","additionalKeys":[],"configDoc":"The duration after which a keep alive ping is sent.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-time","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".flow-control-window","additionalKeys":[],"configDoc":"The flow control window in bytes. Default is 1MiB.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"flow-control-window","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FLOW_CONTROL_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".idle-timeout","additionalKeys":[],"configDoc":"The duration without ongoing RPCs before going to idle mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".keep-alive-timeout","additionalKeys":[],"configDoc":"The amount of time the sender of a keep alive ping waits for an acknowledgement.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":".keep-alive-without-calls","additionalKeys":[],"configDoc":"Whether keep-alive will be performed when there are no outstanding RPC on a connection.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"keep-alive-without-calls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_WITHOUT_CALLS","enum":false}},{"configDocKey":{"type":"int","key":".max-hedged-attempts","additionalKeys":[],"configDoc":"The max number of hedged attempts.","withinAMap":false,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-hedged-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_HEDGED_ATTEMPTS","enum":false}},{"configDocKey":{"type":"int","key":".max-retry-attempts","additionalKeys":[],"configDoc":"The max number of retry attempts. Retry must be explicitly enabled.","withinAMap":false,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-retry-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_RETRY_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-trace-events","additionalKeys":[],"configDoc":"The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-trace-events","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_TRACE_EVENTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-inbound-message-size","additionalKeys":[],"configDoc":"The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-message-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_INBOUND_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-inbound-metadata-size","additionalKeys":[],"configDoc":"The maximum size of metadata allowed to be received (in bytes). Default is 8192B.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-metadata-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_INBOUND_METADATA_SIZE","enum":false}},{"configDocKey":{"type":"string","key":".negotiation-type","additionalKeys":[],"configDoc":"The negotiation type for the HTTP/2 connection. Accepted values are: `TLS`, `PLAINTEXT_UPGRADE`, `PLAINTEXT`","withinAMap":false,"defaultValue":"TLS","javaDocSiteLink":"","docMapKey":"negotiation-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NEGOTIATION_TYPE","enum":false}},{"configDocKey":{"type":"string","key":".override-authority","additionalKeys":[],"configDoc":"Overrides the authority used with TLS and HTTP virtual hosting.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"override-authority","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_OVERRIDE_AUTHORITY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".per-rpc-buffer-limit","additionalKeys":[],"configDoc":"The per RPC buffer limit in bytes used for retry.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"per-rpc-buffer-limit","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PER_RPC_BUFFER_LIMIT","enum":false}},{"configDocKey":{"type":"boolean","key":".retry","additionalKeys":[],"configDoc":"Whether retry is enabled. Note that retry is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"retry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RETRY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".retry-buffer-size","additionalKeys":[],"configDoc":"The retry buffer size in bytes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"retry-buffer-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RETRY_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"string","key":".user-agent","additionalKeys":[],"configDoc":"Use a custom user-agent.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USER_AGENT","enum":false}},{"configDocKey":{"type":"string","key":".load-balancing-policy","additionalKeys":[],"configDoc":"Use a custom load balancing policy. Accepted values are: `pick_first`, `round_robin`, `grpclb`. This value is ignored if name-resolver is set to 'stork'.","withinAMap":false,"defaultValue":"pick_first","javaDocSiteLink":"","docMapKey":"load-balancing-policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOAD_BALANCING_POLICY","enum":false}},{"configDocKey":{"type":"string","key":".compression","additionalKeys":[],"configDoc":"The compression to use for each call. The accepted values are `gzip` and `identity`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COMPRESSION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".deadline","additionalKeys":[],"configDoc":"The deadline used for each call.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"deadline","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEADLINE","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit index 93f467d3fa8..e1253e7fa3a 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".datasource","additionalKeys":[],"configDoc":"The name of the datasource which this persistence unit uses.\n\nIf undefined, it will use the default datasource.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"datasource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATASOURCE","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".packages","additionalKeys":[],"configDoc":"The packages in which the entities affected to this persistence unit are located.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"packages","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PACKAGES","enum":false}},{"configDocSection":{"name":".dialect","optional":false,"withinAMap":false,"sectionDetails":"== Dialect related configuration","sectionDetailsTitle":"Dialect related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":".dialect","additionalKeys":[],"configDoc":"Class name of the Hibernate ORM dialect.\n\nThe complete list of bundled dialects is available in the\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM\nJavaDoc].\n\nSetting the dialect directly is only recommended as a last resort:\nmost popular databases have a corresponding Quarkus extension,\nallowing Quarkus to select the dialect automatically,\nin which case you do not need to set the dialect at all,\nthough you may want to set\nxref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as\nhigh as possible\nto benefit from the best performance and latest features.\n\nIf your database does not have a corresponding Quarkus extension,\nyou will need to set the dialect directly.\nIn that case, keep in mind that the JDBC driver and Hibernate ORM dialect\nmay not work properly in GraalVM native executables.","withinAMap":false,"defaultValue":"selected automatically for most popular databases","javaDocSiteLink":"","docMapKey":"dialect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DIALECT","enum":false}},{"configDocKey":{"type":"string","key":".dialect.storage-engine","additionalKeys":[],"configDoc":"The storage engine to use when the dialect supports multiple storage engines.\n\nE.g. `MyISAM` or `InnoDB` for MySQL.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"storage-engine","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DIALECT_STORAGE_ENGINE","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":".sql-load-script","additionalKeys":[],"configDoc":"Path to a file containing the SQL statements to execute when Hibernate ORM starts.\n\nThe file is retrieved from the classpath resources,\nso it must be located in the resources directory (e.g. `src/main/resources`).\n\nThe default value for this setting differs depending on the Quarkus launch mode:\n\n* In dev and test modes, it defaults to `import.sql`.\n Simply add an `import.sql` file in the root of your resources directory\n and it will be picked up without having to set this property.\n Pass `no-file` to force Hibernate ORM to ignore the SQL import file.\n* In production mode, it defaults to `no-file`.\n It means Hibernate ORM won't try to execute any SQL import file by default.\n Pass an explicit value to force Hibernate ORM to execute the SQL import file.\n\nIf you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus\nhttps://quarkus.io/guides/config#configuration-profiles[configuration profiles facility].\n\n[source,property]\n.application.properties\n----\n%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql\n%test.quarkus.hibernate-orm.sql-load-script = import-test.sql\n%prod.quarkus.hibernate-orm.sql-load-script = no-file\n----\n\n[NOTE]\n====\nQuarkus supports `.sql` file with SQL statements or comments spread over multiple lines.\nEach SQL statement must be terminated by a semicolon.\n====","withinAMap":false,"defaultValue":"import.sql in DEV, TEST ; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"sql-load-script","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SQL_LOAD_SCRIPT","enum":false}},{"configDocKey":{"type":"string","key":".physical-naming-strategy","additionalKeys":[],"configDoc":"Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"physical-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PHYSICAL_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":".implicit-naming-strategy","additionalKeys":[],"configDoc":"Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"implicit-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMPLICIT_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":".metadata-builder-contributor","additionalKeys":[],"configDoc":"Class name of a custom\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/spi/MetadataBuilderContributor.html[`org.hibernate.boot.spi.MetadataBuilderContributor`]\nimplementation.\n\n[NOTE]\n====\nNot all customization options exposed by\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/MetadataBuilder.html[`org.hibernate.boot.MetadataBuilder`]\nwill work correctly. Stay clear of options related to classpath scanning in particular.\n\nThis setting is exposed mainly to allow registration of types, converters and SQL functions.\n====","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"metadata-builder-contributor","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_METADATA_BUILDER_CONTRIBUTOR","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".mapping-files","additionalKeys":[],"configDoc":"XML files to configure the entity mapping, e.g. `META-INF/my-orm.xml`.\n\nDefaults to `META-INF/orm.xml` if it exists. Pass `no-file` to force Hibernate ORM to ignore `META-INF/orm.xml`.","withinAMap":false,"defaultValue":"META-INF/orm.xml if it exists; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"mapping-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAPPING_FILES","enum":false}},{"configDocSection":{"name":".mapping","optional":false,"withinAMap":false,"sectionDetails":"== Mapping configuration","sectionDetailsTitle":"Mapping configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitMapping","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.annotations.TimeZoneStorageType","key":".mapping.timezone.default-storage","additionalKeys":[],"configDoc":"How to store timezones in the database by default\nfor properties of type `OffsetDateTime` and `ZonedDateTime`.\n\nThis default may be overridden on a per-property basis using `@TimeZoneStorage`.\n\nNOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this\nsetting].\n\n`default`::\nEquivalent to `native` if supported, `normalize-utc` otherwise.\n`auto`::\nEquivalent to `native` if supported, `column` otherwise.\n`native`::\nStores the timestamp and timezone in a column of type `timestamp with time zone`.\n+\nOnly available on some databases/dialects;\nif not supported, an exception will be thrown during static initialization.\n`column`::\nStores the timezone in a separate column next to the timestamp column.\n+\nUse `@TimeZoneColumn` on the relevant entity property to customize the timezone column.\n`normalize-utc`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value to a timestamp in the UTC timezone.\n`normalize`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value:\n* upon persisting to the database, to a timestamp in the JDBC timezone\nset through `quarkus.hibernate-orm.jdbc.timezone`,\nor the JVM default timezone if not set.\n* upon reading back from the database, to the JVM default timezone.\n+\nUse this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older.","withinAMap":false,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"time-zone-default-storage","configPhase":"BUILD_TIME","acceptedValues":["`native`","`normalize`","`normalize-utc`","`column`","`auto`","`default`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAPPING_TIMEZONE_DEFAULT_STORAGE","enum":true}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdOptimizerType","key":".mapping.id.optimizer.default","additionalKeys":[],"configDoc":"The optimizer to apply to identifier generators\nwhose optimizer is not configured explicitly.\n\nOnly relevant for table- and sequence-based identifier generators.\nOther generators, such as UUID-based generators, will ignore this setting.\n\nThe optimizer is responsible for pooling new identifier values,\nin order to reduce the frequency of database calls to retrieve those values\nand thereby improve performance.","withinAMap":false,"defaultValue":"pooled-lo","javaDocSiteLink":"","docMapKey":"id-optimizer-default","configPhase":"BUILD_TIME","acceptedValues":["`pooled-lo`","`pooled`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAPPING_ID_OPTIMIZER_DEFAULT","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":".query","optional":false,"withinAMap":false,"sectionDetails":"== Query related configuration","sectionDetailsTitle":"Query related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery","showSection":true,"configDocItems":[{"configDocKey":{"type":"int","key":".query.query-plan-cache-max-size","additionalKeys":[],"configDoc":"The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE`","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"query-plan-cache-max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_QUERY_PLAN_CACHE_MAX_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery.NullOrdering","key":".query.default-null-ordering","additionalKeys":[],"configDoc":"Default precedence of null values in `ORDER BY` clauses.\n\nValid values are: `none`, `first`, `last`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"default-null-ordering","configPhase":"BUILD_TIME","acceptedValues":["`none`","`first`","`last`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_DEFAULT_NULL_ORDERING","enum":true}},{"configDocKey":{"type":"boolean","key":".query.in-clause-parameter-padding","additionalKeys":[],"configDoc":"Enables IN clause parameter padding which improves statement caching.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"in-clause-parameter-padding","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_IN_CLAUSE_PARAMETER_PADDING","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".database","optional":false,"withinAMap":false,"sectionDetails":"== Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.nio.charset.Charset","key":".database.charset","additionalKeys":[],"configDoc":"The charset of the database.\n\nUsed for DDL generation and also for the SQL import scripts.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"charset","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_CHARSET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".jdbc","optional":false,"withinAMap":false,"sectionDetails":"== JDBC related configuration","sectionDetailsTitle":"JDBC related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":".jdbc.timezone","additionalKeys":[],"configDoc":"The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"timezone","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_TIMEZONE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".jdbc.statement-fetch-size","additionalKeys":[],"configDoc":"How many rows are fetched at a time by the JDBC driver.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-fetch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_STATEMENT_FETCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".jdbc.statement-batch-size","additionalKeys":[],"configDoc":"The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_STATEMENT_BATCH_SIZE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".fetch","optional":false,"withinAMap":false,"sectionDetails":"== Fetching logic configuration","sectionDetailsTitle":"Fetching logic configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Integer","key":".fetch.batch-size","additionalKeys":[],"configDoc":"The size of the batches used when loading entities and collections.\n\n`-1` means batch loading is disabled.","withinAMap":false,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FETCH_BATCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".fetch.max-depth","additionalKeys":[],"configDoc":"The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).\n\nA `0` disables default outer join fetching.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-depth","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FETCH_MAX_DEPTH","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".cache","optional":false,"withinAMap":false,"sectionDetails":"== Caching configuration","sectionDetailsTitle":"Caching configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.time.Duration","key":".cache.\"cache\".expiration.max-idle","additionalKeys":[],"configDoc":"The maximum time before an object of the cache is considered expired.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-idle","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CACHE__CACHE__EXPIRATION_MAX_IDLE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".cache.\"cache\".memory.object-count","additionalKeys":[],"configDoc":"The maximum number of objects kept in memory in the cache.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"object-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CACHE__CACHE__MEMORY_OBJECT_COUNT","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".discriminator","optional":false,"withinAMap":false,"sectionDetails":"== Discriminator related configuration","sectionDetailsTitle":"Discriminator related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDiscriminator","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":".discriminator.ignore-explicit-for-joined","additionalKeys":[],"configDoc":"Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-explicit-for-joined","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".quote-identifiers","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuoteIdentifiers","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdentifierQuotingStrategy","key":".quote-identifiers.strategy","additionalKeys":[],"configDoc":"Identifiers can be quoted using one of the available strategies.\n\nSet to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`none`","`all`","`all-except-column-definitions`","`only-keywords`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUOTE_IDENTIFIERS_STRATEGY","enum":true}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".second-level-caching-enabled","additionalKeys":[],"configDoc":"The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.\n\nJust cherry-pick which entities should be using the cache.\n\nSet this to false to disable all 2nd level caches.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"second-level-caching-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SECOND_LEVEL_CACHING_ENABLED","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".validation","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceValidation","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".validation.enabled","additionalKeys":[],"configDoc":"Enables the Bean Validation integration.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VALIDATION_ENABLED","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".multitenant","additionalKeys":[],"configDoc":"Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the\nhttps://javadoc.io/doc/org.hibernate/hibernate-core/5.6.10.Final/org/hibernate/MultiTenancyStrategy.html[Hibernate ORM\nJavaDoc].\nThe type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multitenant","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTITENANT","enum":false}},{"configDocKey":{"type":"string","key":".multitenant-schema-datasource","additionalKeys":[],"configDoc":"Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multitenant-schema-datasource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTITENANT_SCHEMA_DATASOURCE","enum":false}},{"configDocKey":{"type":"boolean","key":".validate-in-dev-mode","additionalKeys":[],"configDoc":"If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"validate-in-dev-mode","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VALIDATE_IN_DEV_MODE","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".datasource","additionalKeys":[],"configDoc":"The name of the datasource which this persistence unit uses.\n\nIf undefined, it will use the default datasource.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"datasource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATASOURCE","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".packages","additionalKeys":[],"configDoc":"The packages in which the entities affected to this persistence unit are located.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"packages","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PACKAGES","enum":false}},{"configDocSection":{"name":".dialect","optional":false,"withinAMap":false,"sectionDetails":"== Dialect related configuration","sectionDetailsTitle":"Dialect related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":".dialect","additionalKeys":[],"configDoc":"Class name of the Hibernate ORM dialect.\n\nThe complete list of bundled dialects is available in the\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM\nJavaDoc].\n\nSetting the dialect directly is only recommended as a last resort:\nmost popular databases have a corresponding Quarkus extension,\nallowing Quarkus to select the dialect automatically,\nin which case you do not need to set the dialect at all,\nthough you may want to set\nxref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as\nhigh as possible\nto benefit from the best performance and latest features.\n\nIf your database does not have a corresponding Quarkus extension,\nyou will need to set the dialect directly.\nIn that case, keep in mind that the JDBC driver and Hibernate ORM dialect\nmay not work properly in GraalVM native executables.","withinAMap":false,"defaultValue":"selected automatically for most popular databases","javaDocSiteLink":"","docMapKey":"dialect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DIALECT","enum":false}},{"configDocKey":{"type":"string","key":".dialect.storage-engine","additionalKeys":[],"configDoc":"The storage engine to use when the dialect supports multiple storage engines.\n\nE.g. `MyISAM` or `InnoDB` for MySQL.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"storage-engine","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DIALECT_STORAGE_ENGINE","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":".sql-load-script","additionalKeys":[],"configDoc":"Paths to files containing the SQL statements to execute when Hibernate ORM starts.\n\nThe files are retrieved from the classpath resources,\nso they must be located in the resources directory (e.g. `src/main/resources`).\n\nThe default value for this setting differs depending on the Quarkus launch mode:\n\n* In dev and test modes, it defaults to `import.sql`.\n Simply add an `import.sql` file in the root of your resources directory\n and it will be picked up without having to set this property.\n Pass `no-file` to force Hibernate ORM to ignore the SQL import file.\n* In production mode, it defaults to `no-file`.\n It means Hibernate ORM won't try to execute any SQL import file by default.\n Pass an explicit value to force Hibernate ORM to execute the SQL import file.\n\nIf you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus\nhttps://quarkus.io/guides/config#configuration-profiles[configuration profiles facility].\n\n[source,property]\n.application.properties\n----\n%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql\n%test.quarkus.hibernate-orm.sql-load-script = import-test.sql\n%prod.quarkus.hibernate-orm.sql-load-script = no-file\n----\n\n[NOTE]\n====\nQuarkus supports `.sql` file with SQL statements or comments spread over multiple lines.\nEach SQL statement must be terminated by a semicolon.\n====","withinAMap":false,"defaultValue":"import.sql in dev and test modes ; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"sql-load-script","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SQL_LOAD_SCRIPT","enum":false}},{"configDocKey":{"type":"string","key":".physical-naming-strategy","additionalKeys":[],"configDoc":"Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"physical-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PHYSICAL_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":".implicit-naming-strategy","additionalKeys":[],"configDoc":"Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"implicit-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMPLICIT_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":".metadata-builder-contributor","additionalKeys":[],"configDoc":"Class name of a custom\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/spi/MetadataBuilderContributor.html[`org.hibernate.boot.spi.MetadataBuilderContributor`]\nimplementation.\n\n[NOTE]\n====\nNot all customization options exposed by\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/MetadataBuilder.html[`org.hibernate.boot.MetadataBuilder`]\nwill work correctly. Stay clear of options related to classpath scanning in particular.\n\nThis setting is exposed mainly to allow registration of types, converters and SQL functions.\n====","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"metadata-builder-contributor","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_METADATA_BUILDER_CONTRIBUTOR","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".mapping-files","additionalKeys":[],"configDoc":"XML files to configure the entity mapping, e.g. `META-INF/my-orm.xml`.\n\nDefaults to `META-INF/orm.xml` if it exists. Pass `no-file` to force Hibernate ORM to ignore `META-INF/orm.xml`.","withinAMap":false,"defaultValue":"META-INF/orm.xml if it exists; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"mapping-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAPPING_FILES","enum":false}},{"configDocSection":{"name":".mapping","optional":false,"withinAMap":false,"sectionDetails":"== Mapping configuration","sectionDetailsTitle":"Mapping configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitMapping","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.annotations.TimeZoneStorageType","key":".mapping.timezone.default-storage","additionalKeys":[],"configDoc":"How to store timezones in the database by default\nfor properties of type `OffsetDateTime` and `ZonedDateTime`.\n\nThis default may be overridden on a per-property basis using `@TimeZoneStorage`.\n\nNOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this\nsetting].\n\n`default`::\nEquivalent to `native` if supported, `normalize-utc` otherwise.\n`auto`::\nEquivalent to `native` if supported, `column` otherwise.\n`native`::\nStores the timestamp and timezone in a column of type `timestamp with time zone`.\n+\nOnly available on some databases/dialects;\nif not supported, an exception will be thrown during static initialization.\n`column`::\nStores the timezone in a separate column next to the timestamp column.\n+\nUse `@TimeZoneColumn` on the relevant entity property to customize the timezone column.\n`normalize-utc`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value to a timestamp in the UTC timezone.\n`normalize`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value:\n* upon persisting to the database, to a timestamp in the JDBC timezone\nset through `quarkus.hibernate-orm.jdbc.timezone`,\nor the JVM default timezone if not set.\n* upon reading back from the database, to the JVM default timezone.\n+\nUse this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older.","withinAMap":false,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"time-zone-default-storage","configPhase":"BUILD_TIME","acceptedValues":["`native`","`normalize`","`normalize-utc`","`column`","`auto`","`default`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAPPING_TIMEZONE_DEFAULT_STORAGE","enum":true}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdOptimizerType","key":".mapping.id.optimizer.default","additionalKeys":[],"configDoc":"The optimizer to apply to identifier generators\nwhose optimizer is not configured explicitly.\n\nOnly relevant for table- and sequence-based identifier generators.\nOther generators, such as UUID-based generators, will ignore this setting.\n\nThe optimizer is responsible for pooling new identifier values,\nin order to reduce the frequency of database calls to retrieve those values\nand thereby improve performance.","withinAMap":false,"defaultValue":"pooled-lo","javaDocSiteLink":"","docMapKey":"id-optimizer-default","configPhase":"BUILD_TIME","acceptedValues":["`pooled-lo`","`pooled`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAPPING_ID_OPTIMIZER_DEFAULT","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":".query","optional":false,"withinAMap":false,"sectionDetails":"== Query related configuration","sectionDetailsTitle":"Query related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery","showSection":true,"configDocItems":[{"configDocKey":{"type":"int","key":".query.query-plan-cache-max-size","additionalKeys":[],"configDoc":"The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE`","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"query-plan-cache-max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_QUERY_PLAN_CACHE_MAX_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery.NullOrdering","key":".query.default-null-ordering","additionalKeys":[],"configDoc":"Default precedence of null values in `ORDER BY` clauses.\n\nValid values are: `none`, `first`, `last`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"default-null-ordering","configPhase":"BUILD_TIME","acceptedValues":["`none`","`first`","`last`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_DEFAULT_NULL_ORDERING","enum":true}},{"configDocKey":{"type":"boolean","key":".query.in-clause-parameter-padding","additionalKeys":[],"configDoc":"Enables IN clause parameter padding which improves statement caching.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"in-clause-parameter-padding","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_IN_CLAUSE_PARAMETER_PADDING","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".database","optional":false,"withinAMap":false,"sectionDetails":"== Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.nio.charset.Charset","key":".database.charset","additionalKeys":[],"configDoc":"The charset of the database.\n\nUsed for DDL generation and also for the SQL import scripts.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"charset","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_CHARSET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".jdbc","optional":false,"withinAMap":false,"sectionDetails":"== JDBC related configuration","sectionDetailsTitle":"JDBC related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":".jdbc.timezone","additionalKeys":[],"configDoc":"The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"timezone","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_TIMEZONE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".jdbc.statement-fetch-size","additionalKeys":[],"configDoc":"How many rows are fetched at a time by the JDBC driver.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-fetch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_STATEMENT_FETCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".jdbc.statement-batch-size","additionalKeys":[],"configDoc":"The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_STATEMENT_BATCH_SIZE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".fetch","optional":false,"withinAMap":false,"sectionDetails":"== Fetching logic configuration","sectionDetailsTitle":"Fetching logic configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Integer","key":".fetch.batch-size","additionalKeys":[],"configDoc":"The size of the batches used when loading entities and collections.\n\n`-1` means batch loading is disabled.","withinAMap":false,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FETCH_BATCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".fetch.max-depth","additionalKeys":[],"configDoc":"The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).\n\nA `0` disables default outer join fetching.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-depth","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FETCH_MAX_DEPTH","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".cache","optional":false,"withinAMap":false,"sectionDetails":"== Caching configuration","sectionDetailsTitle":"Caching configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.time.Duration","key":".cache.\"cache\".expiration.max-idle","additionalKeys":[],"configDoc":"The maximum time before an object of the cache is considered expired.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-idle","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CACHE__CACHE__EXPIRATION_MAX_IDLE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".cache.\"cache\".memory.object-count","additionalKeys":[],"configDoc":"The maximum number of objects kept in memory in the cache.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"object-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CACHE__CACHE__MEMORY_OBJECT_COUNT","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".discriminator","optional":false,"withinAMap":false,"sectionDetails":"== Discriminator related configuration","sectionDetailsTitle":"Discriminator related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDiscriminator","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":".discriminator.ignore-explicit-for-joined","additionalKeys":[],"configDoc":"Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-explicit-for-joined","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".quote-identifiers","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuoteIdentifiers","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdentifierQuotingStrategy","key":".quote-identifiers.strategy","additionalKeys":[],"configDoc":"Identifiers can be quoted using one of the available strategies.\n\nSet to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`none`","`all`","`all-except-column-definitions`","`only-keywords`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUOTE_IDENTIFIERS_STRATEGY","enum":true}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".second-level-caching-enabled","additionalKeys":[],"configDoc":"The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.\n\nJust cherry-pick which entities should be using the cache.\n\nSet this to false to disable all 2nd level caches.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"second-level-caching-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SECOND_LEVEL_CACHING_ENABLED","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".validation","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceValidation","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".validation.enabled","additionalKeys":[],"configDoc":"Enables the Bean Validation integration.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VALIDATION_ENABLED","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".multitenant","additionalKeys":[],"configDoc":"Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the\nhttps://javadoc.io/doc/org.hibernate/hibernate-core/5.6.10.Final/org/hibernate/MultiTenancyStrategy.html[Hibernate ORM\nJavaDoc].\nThe type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multitenant","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTITENANT","enum":false}},{"configDocKey":{"type":"boolean","key":".validate-in-dev-mode","additionalKeys":[],"configDoc":"If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"validate-in-dev-mode","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VALIDATE_IN_DEV_MODE","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit index d3b65db4d7c..353e4cda040 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":".active","additionalKeys":[],"configDoc":"Whether this persistence unit should be active at runtime.\n\nSee xref:hibernate-orm.adoc#persistence-unit-active[this section of the documentation].\n\nIf the persistence unit is not active, it won't start with the application,\nand accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session\nwill not be possible.\n\nNote that if Hibernate ORM is disabled (i.e. `quarkus.hibernate-orm.enabled` is set to `false`),\nall persistence units are deactivated, and setting this property to `true` will fail.","withinAMap":false,"defaultValue":"'true' if Hibernate ORM is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ACTIVE","enum":false}},{"configDocSection":{"name":".database","optional":false,"withinAMap":false,"sectionDetails":"== Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":".database.generation","additionalKeys":[],"configDoc":"Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_GENERATION","enum":false}},{"configDocKey":{"type":"boolean","key":".database.generation.create-schemas","additionalKeys":[],"configDoc":"If Hibernate ORM should create the schemas automatically (for databases supporting them).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"create-schemas","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_GENERATION_CREATE_SCHEMAS","enum":false}},{"configDocKey":{"type":"boolean","key":".database.generation.halt-on-error","additionalKeys":[],"configDoc":"Whether we should stop on the first error when applying the schema.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"halt-on-error","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_GENERATION_HALT_ON_ERROR","enum":false}},{"configDocKey":{"type":"string","key":".database.default-catalog","additionalKeys":[],"configDoc":"The default catalog to use for the database objects.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-catalog","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_DEFAULT_CATALOG","enum":false}},{"configDocKey":{"type":"string","key":".database.default-schema","additionalKeys":[],"configDoc":"The default schema to use for the database objects.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-schema","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_DEFAULT_SCHEMA","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".scripts","optional":false,"withinAMap":false,"sectionDetails":"== Database scripts related configuration","sectionDetailsTitle":"Database scripts related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitScripts","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":".scripts.generation","additionalKeys":[],"configDoc":"Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCRIPTS_GENERATION","enum":false}},{"configDocKey":{"type":"string","key":".scripts.generation.create-target","additionalKeys":[],"configDoc":"Filename or URL where the database create DDL file should be generated.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-target","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCRIPTS_GENERATION_CREATE_TARGET","enum":false}},{"configDocKey":{"type":"string","key":".scripts.generation.drop-target","additionalKeys":[],"configDoc":"Filename or URL where the database drop DDL file should be generated.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"drop-target","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCRIPTS_GENERATION_DROP_TARGET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".log","optional":false,"withinAMap":false,"sectionDetails":"== Logging configuration","sectionDetailsTitle":"Logging configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":".log.sql","additionalKeys":[],"configDoc":"Show SQL logs and format them nicely.\n\nSetting it to true is obviously not recommended in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":".log.format-sql","additionalKeys":[],"configDoc":"Format the SQL logs if SQL log is enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"format-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_FORMAT_SQL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".log.jdbc-warnings","additionalKeys":[],"configDoc":"Whether JDBC warnings should be collected and logged.","withinAMap":false,"defaultValue":"depends on dialect","javaDocSiteLink":"","docMapKey":"jdbc-warnings","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_JDBC_WARNINGS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".log.queries-slower-than-ms","additionalKeys":[],"configDoc":"If set, Hibernate will log queries that took more than specified number of milliseconds to execute.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"queries-slower-than-ms","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_QUERIES_SLOWER_THAN_MS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":".unsupported-properties.\"full-property-key\"","additionalKeys":[],"configDoc":"Properties that should be passed on directly to Hibernate ORM.\nUse the full configuration property key here,\nfor instance `quarkus.hibernate-orm.unsupported-properties.\"hibernate.order_inserts\" = true`.\n\n[WARNING]\n====\nProperties set here are completely unsupported:\nas Quarkus doesn't generally know about these properties and their purpose,\nthere is absolutely no guarantee that they will work correctly,\nand even if they do, that may change when upgrading to a newer version of Quarkus\n(even just a micro/patch version).\n====\n\nConsider using a supported configuration property before falling back to unsupported ones.\nIf none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus,\nand more importantly so that the configuration property is tested regularly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"full-property-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":".active","additionalKeys":[],"configDoc":"Whether this persistence unit should be active at runtime.\n\nSee xref:hibernate-orm.adoc#persistence-unit-active[this section of the documentation].\n\nIf the persistence unit is not active, it won't start with the application,\nand accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session\nwill not be possible.\n\nNote that if Hibernate ORM is disabled (i.e. `quarkus.hibernate-orm.enabled` is set to `false`),\nall persistence units are deactivated, and setting this property to `true` will fail.","withinAMap":false,"defaultValue":"'true' if Hibernate ORM is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ACTIVE","enum":false}},{"configDocSection":{"name":".database","optional":false,"withinAMap":false,"sectionDetails":"== Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":".database.generation","additionalKeys":[],"configDoc":"Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_GENERATION","enum":false}},{"configDocKey":{"type":"boolean","key":".database.generation.create-schemas","additionalKeys":[],"configDoc":"If Hibernate ORM should create the schemas automatically (for databases supporting them).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"create-schemas","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_GENERATION_CREATE_SCHEMAS","enum":false}},{"configDocKey":{"type":"boolean","key":".database.generation.halt-on-error","additionalKeys":[],"configDoc":"Whether we should stop on the first error when applying the schema.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"halt-on-error","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_GENERATION_HALT_ON_ERROR","enum":false}},{"configDocKey":{"type":"string","key":".database.default-catalog","additionalKeys":[],"configDoc":"The default catalog to use for the database objects.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-catalog","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_DEFAULT_CATALOG","enum":false}},{"configDocKey":{"type":"string","key":".database.default-schema","additionalKeys":[],"configDoc":"The default schema to use for the database objects.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-schema","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DATABASE_DEFAULT_SCHEMA","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".scripts","optional":false,"withinAMap":false,"sectionDetails":"== Database scripts related configuration","sectionDetailsTitle":"Database scripts related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitScripts","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":".scripts.generation","additionalKeys":[],"configDoc":"Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCRIPTS_GENERATION","enum":false}},{"configDocKey":{"type":"string","key":".scripts.generation.create-target","additionalKeys":[],"configDoc":"Filename or URL where the database create DDL file should be generated.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-target","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCRIPTS_GENERATION_CREATE_TARGET","enum":false}},{"configDocKey":{"type":"string","key":".scripts.generation.drop-target","additionalKeys":[],"configDoc":"Filename or URL where the database drop DDL file should be generated.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"drop-target","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCRIPTS_GENERATION_DROP_TARGET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".log","optional":false,"withinAMap":false,"sectionDetails":"== Logging configuration","sectionDetailsTitle":"Logging configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":".log.sql","additionalKeys":[],"configDoc":"Show SQL logs and format them nicely.\n\nSetting it to true is obviously not recommended in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":".log.format-sql","additionalKeys":[],"configDoc":"Format the SQL logs if SQL log is enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"format-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_FORMAT_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":".log.highlight-sql","additionalKeys":[],"configDoc":"Highlight the SQL logs if SQL log is enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"highlight-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_HIGHLIGHT_SQL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".log.jdbc-warnings","additionalKeys":[],"configDoc":"Whether JDBC warnings should be collected and logged.","withinAMap":false,"defaultValue":"depends on dialect","javaDocSiteLink":"","docMapKey":"jdbc-warnings","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_JDBC_WARNINGS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".log.queries-slower-than-ms","additionalKeys":[],"configDoc":"If set, Hibernate will log queries that took more than specified number of milliseconds to execute.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"queries-slower-than-ms","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_QUERIES_SLOWER_THAN_MS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":".unsupported-properties.\"full-property-key\"","additionalKeys":[],"configDoc":"Properties that should be passed on directly to Hibernate ORM.\nUse the full configuration property key here,\nfor instance `quarkus.hibernate-orm.unsupported-properties.\"hibernate.order_inserts\" = true`.\n\n[WARNING]\n====\nProperties set here are completely unsupported:\nas Quarkus doesn't generally know about these properties and their purpose,\nthere is absolutely no guarantee that they will work correctly,\nand even if they do, that may change when upgrading to a newer version of Quarkus\n(even just a micro/patch version).\n====\n\nConsider using a supported configuration property before falling back to unsupported ones.\nIf none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus,\nand more importantly so that the configuration property is tested regularly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"full-property-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog index 8ea483e8024..d47fff596ef 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":".sql","additionalKeys":[],"configDoc":"Show SQL logs and format them nicely.\n\nSetting it to true is obviously not recommended in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":".format-sql","additionalKeys":[],"configDoc":"Format the SQL logs if SQL log is enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"format-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORMAT_SQL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".jdbc-warnings","additionalKeys":[],"configDoc":"Whether JDBC warnings should be collected and logged.","withinAMap":false,"defaultValue":"depends on dialect","javaDocSiteLink":"","docMapKey":"jdbc-warnings","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_WARNINGS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".queries-slower-than-ms","additionalKeys":[],"configDoc":"If set, Hibernate will log queries that took more than specified number of milliseconds to execute.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"queries-slower-than-ms","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERIES_SLOWER_THAN_MS","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":".sql","additionalKeys":[],"configDoc":"Show SQL logs and format them nicely.\n\nSetting it to true is obviously not recommended in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":".format-sql","additionalKeys":[],"configDoc":"Format the SQL logs if SQL log is enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"format-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORMAT_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":".highlight-sql","additionalKeys":[],"configDoc":"Highlight the SQL logs if SQL log is enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"highlight-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HIGHLIGHT_SQL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".jdbc-warnings","additionalKeys":[],"configDoc":"Whether JDBC warnings should be collected and logged.","withinAMap":false,"defaultValue":"depends on dialect","javaDocSiteLink":"","docMapKey":"jdbc-warnings","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JDBC_WARNINGS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".queries-slower-than-ms","additionalKeys":[],"configDoc":"If set, Hibernate will log queries that took more than specified number of milliseconds to execute.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"queries-slower-than-ms","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERIES_SLOWER_THAN_MS","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig index 81aad41c43f..75b761d2e5d 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".marshaller-class","additionalKeys":[],"configDoc":"Sets the marshallerClass. Default is ProtoStreamMarshaller","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"marshaller-class","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MARSHALLER_CLASS","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".cache.\"cache\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.RemoteCacheConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".cache.\"cache\".configuration-resource","additionalKeys":[],"configDoc":"Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configuration-resource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CACHE__CACHE__CONFIGURATION_RESOURCE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.DevServiceConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":".devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".devservices.tracing.enabled","additionalKeys":[],"configDoc":"Runs the Infinispan Server container with tracing enabled. Traces are disabled by default","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".devservices.tracing.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317","withinAMap":false,"defaultValue":"http://localhost:4317","javaDocSiteLink":"","docMapKey":"exporter-otlp-endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONFIG_FILES","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".marshaller-class","additionalKeys":[],"configDoc":"Sets the marshallerClass. Default is ProtoStreamMarshaller","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"marshaller-class","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MARSHALLER_CLASS","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".cache.\"cache\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.RemoteCacheConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".cache.\"cache\".configuration-resource","additionalKeys":[],"configDoc":"Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configuration-resource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CACHE__CACHE__CONFIGURATION_RESOURCE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.DevServiceConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":".devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONFIG_FILES","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.DevServiceConfiguration b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.DevServiceConfiguration index 5fa8598e943..a83e3a80822 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.DevServiceConfiguration +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientBuildTimeConfig.DevServiceConfiguration @@ -1 +1 @@ -[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".devservices","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":".devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".devservices.tracing.enabled","additionalKeys":[],"configDoc":"Runs the Infinispan Server container with tracing enabled. Traces are disabled by default","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".devservices.tracing.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317","withinAMap":false,"defaultValue":"http://localhost:4317","javaDocSiteLink":"","docMapKey":"exporter-otlp-endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONFIG_FILES","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".devservices","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":".devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEVSERVICES_CONFIG_FILES","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig index dd66fe3890e..76f9001bb36 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":".site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tracing.enabled","additionalKeys":[],"configDoc":"Runs the Infinispan Server container with tracing enabled. Traces are disabled by default","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".tracing.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317","withinAMap":false,"defaultValue":"http://localhost:4317","javaDocSiteLink":"","docMapKey":"exporter-otlp-endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRACING_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONFIG_FILES","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":".site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONFIG_FILES","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig.PriorityLoadShedding b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig.PriorityLoadShedding new file mode 100644 index 00000000000..db6d9dfefb5 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig.PriorityLoadShedding @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Whether priority load shedding should be enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mailer.runtime.MailerRuntimeConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mailer.runtime.MailerRuntimeConfig index 8e190c30bbc..329dcf83c36 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mailer.runtime.MailerRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mailer.runtime.MailerRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".from","additionalKeys":[],"configDoc":"Sets the default `from` attribute when not specified in the `io.quarkus.mailer.Mail` instance. It's the sender email address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FROM","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".mock","additionalKeys":[],"configDoc":"Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.\n\nDisabled by default on PROD, enabled by default on DEV and TEST modes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mock","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MOCK","enum":false}},{"configDocKey":{"type":"string","key":".bounce-address","additionalKeys":[],"configDoc":"Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bounce-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BOUNCE_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":".host","additionalKeys":[],"configDoc":"Sets the SMTP host name.","withinAMap":false,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOST","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"string","key":".username","additionalKeys":[],"configDoc":"Sets the username to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Sets the password to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".ssl","additionalKeys":[],"configDoc":"Enables or disables the TLS/SSL.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ssl","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SSL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".trust-all","additionalKeys":[],"configDoc":"Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_ALL","enum":false}},{"configDocKey":{"type":"int","key":".max-pool-size","additionalKeys":[],"configDoc":"Sets the max number of open connections to the mail server.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"string","key":".own-host-name","additionalKeys":[],"configDoc":"Sets the hostname to be used for HELO/EHLO and the Message-ID.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"own-host-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_OWN_HOST_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":".keep-alive","additionalKeys":[],"configDoc":"Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"boolean","key":".disable-esmtp","additionalKeys":[],"configDoc":"Disable ESMTP. 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.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-esmtp","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DISABLE_ESMTP","enum":false}},{"configDocKey":{"type":"string","key":".start-tls","additionalKeys":[],"configDoc":"Sets the TLS security mode for the connection. Either `DISABLED`, `OPTIONAL` or `REQUIRED`.","withinAMap":false,"defaultValue":"OPTIONAL","javaDocSiteLink":"","docMapKey":"start-tls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_START_TLS","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".dkim","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.mailer.runtime.DkimSignOptionsConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".dkim.enabled","additionalKeys":[],"configDoc":"Enables DKIM signing.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".dkim.private-key","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key used to sign the email.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_PRIVATE_KEY","enum":false}},{"configDocKey":{"type":"string","key":".dkim.private-key-path","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key file path.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_PRIVATE_KEY_PATH","enum":false}},{"configDocKey":{"type":"string","key":".dkim.auid","additionalKeys":[],"configDoc":"Configures the Agent or User Identifier (AUID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auid","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_AUID","enum":false}},{"configDocKey":{"type":"string","key":".dkim.selector","additionalKeys":[],"configDoc":"Configures the selector used to query the public key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"selector","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SELECTOR","enum":false}},{"configDocKey":{"type":"string","key":".dkim.sdid","additionalKeys":[],"configDoc":"Configures the Signing Domain Identifier (SDID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sdid","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SDID","enum":false}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":".dkim.header-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for signed headers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-canon-algo","configPhase":"BUILD_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_HEADER_CANON_ALGO","enum":true}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":".dkim.body-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for mail body.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-canon-algo","configPhase":"BUILD_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_BODY_CANON_ALGO","enum":true}},{"configDocKey":{"type":"java.lang.Integer","key":".dkim.body-limit","additionalKeys":[],"configDoc":"Configures the body limit to sign. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".dkim.signature-timestamp","additionalKeys":[],"configDoc":"Configures to enable or disable signature sign timestamp.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-timestamp","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SIGNATURE_TIMESTAMP","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".dkim.expire-time","additionalKeys":[],"configDoc":"Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"expire-time","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_EXPIRE_TIME","enum":false}},{"configDocKey":{"type":"string","key":".dkim.signed-headers","additionalKeys":[],"configDoc":"Configures the signed headers in DKIM, separated by commas. The order in the list matters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signed-headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SIGNED_HEADERS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".login","additionalKeys":[],"configDoc":"Sets the login mode for the connection. Either `NONE`, @++{++code DISABLED++}++, `OPTIONAL`, `REQUIRED` or `XOAUTH2`.\n\n - DISABLED means no login will be attempted\n - NONE means a login will be attempted if the server supports in and login credentials are set\n - REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise\n - XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"login","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOGIN","enum":false}},{"configDocKey":{"type":"string","key":".auth-methods","additionalKeys":[],"configDoc":"Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-methods","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_AUTH_METHODS","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".truststore","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.mailer.runtime.TrustStoreConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".truststore.password","additionalKeys":[],"configDoc":"Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUSTSTORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".truststore.paths","additionalKeys":[],"configDoc":"Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths.\n\nThe relative paths are relative to the application working directly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUSTSTORE_PATHS","enum":false}},{"configDocKey":{"type":"string","key":".truststore.type","additionalKeys":[],"configDoc":"Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUSTSTORE_TYPE","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".multi-part-only","additionalKeys":[],"configDoc":"Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"multi-part-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTI_PART_ONLY","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-rcpt-errors","additionalKeys":[],"configDoc":"Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-rcpt-errors","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_RCPT_ERRORS","enum":false}},{"configDocKey":{"type":"boolean","key":".pipelining","additionalKeys":[],"configDoc":"Enables or disables the pipelining capability if the SMTP server supports it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pipelining","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PIPELINING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".pool-cleaner-period","additionalKeys":[],"configDoc":"Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-period","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POOL_CLEANER_PERIOD","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".keep-alive-timeout","additionalKeys":[],"configDoc":"Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.","withinAMap":false,"defaultValue":"PT300S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".ntlm","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.mailer.runtime.NtlmConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".ntlm.workstation","additionalKeys":[],"configDoc":"Sets the workstation used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"workstation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NTLM_WORKSTATION","enum":false}},{"configDocKey":{"type":"string","key":".ntlm.domain","additionalKeys":[],"configDoc":"Sets the domain used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"domain","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NTLM_DOMAIN","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.util.regex.Pattern","key":".approved-recipients","additionalKeys":[],"configDoc":"Allows sending emails to these recipients only.\n\nApproved recipients are compiled to a `Pattern` and must be a valid regular expression. The created `Pattern` is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"approved-recipients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_APPROVED_RECIPIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":".log-rejected-recipients","additionalKeys":[],"configDoc":"Log rejected recipients as warnings.\n\nIf false, the rejected recipients will be logged at the DEBUG level.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-rejected-recipients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_REJECTED_RECIPIENTS","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".from","additionalKeys":[],"configDoc":"Sets the default `from` attribute when not specified in the `io.quarkus.mailer.Mail` instance. It's the sender email address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FROM","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".mock","additionalKeys":[],"configDoc":"Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.\n\nDisabled by default on PROD, enabled by default on DEV and TEST modes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mock","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MOCK","enum":false}},{"configDocKey":{"type":"string","key":".bounce-address","additionalKeys":[],"configDoc":"Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bounce-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BOUNCE_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":".host","additionalKeys":[],"configDoc":"Sets the SMTP host name.","withinAMap":false,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOST","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely.\n\nNote that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"string","key":".username","additionalKeys":[],"configDoc":"Sets the username to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Sets the password to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used.\n\nThe default TLS configuration is *not* used by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tls","additionalKeys":[],"configDoc":"Whether the connection should be secured using TLS.\n\nSMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS","enum":false}},{"configDocKey":{"type":"int","key":".max-pool-size","additionalKeys":[],"configDoc":"Sets the max number of open connections to the mail server.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"string","key":".own-host-name","additionalKeys":[],"configDoc":"Sets the hostname to be used for HELO/EHLO and the Message-ID.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"own-host-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_OWN_HOST_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":".keep-alive","additionalKeys":[],"configDoc":"Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"boolean","key":".disable-esmtp","additionalKeys":[],"configDoc":"Disable ESMTP.\n\nThe 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.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-esmtp","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DISABLE_ESMTP","enum":false}},{"configDocKey":{"type":"string","key":".start-tls","additionalKeys":[],"configDoc":"Sets the TLS security mode for the connection. Either `DISABLED`, `OPTIONAL` or `REQUIRED`.","withinAMap":false,"defaultValue":"OPTIONAL","javaDocSiteLink":"","docMapKey":"start-tls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_START_TLS","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".dkim","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.mailer.runtime.DkimSignOptionsConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".dkim.enabled","additionalKeys":[],"configDoc":"Enables DKIM signing.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".dkim.private-key","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key used to sign the email.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_PRIVATE_KEY","enum":false}},{"configDocKey":{"type":"string","key":".dkim.private-key-path","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key file path.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_PRIVATE_KEY_PATH","enum":false}},{"configDocKey":{"type":"string","key":".dkim.auid","additionalKeys":[],"configDoc":"Configures the Agent or User Identifier (AUID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auid","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_AUID","enum":false}},{"configDocKey":{"type":"string","key":".dkim.selector","additionalKeys":[],"configDoc":"Configures the selector used to query the public key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"selector","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SELECTOR","enum":false}},{"configDocKey":{"type":"string","key":".dkim.sdid","additionalKeys":[],"configDoc":"Configures the Signing Domain Identifier (SDID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sdid","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SDID","enum":false}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":".dkim.header-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for signed headers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-canon-algo","configPhase":"BUILD_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_HEADER_CANON_ALGO","enum":true}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":".dkim.body-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for mail body.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-canon-algo","configPhase":"BUILD_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_BODY_CANON_ALGO","enum":true}},{"configDocKey":{"type":"java.lang.Integer","key":".dkim.body-limit","additionalKeys":[],"configDoc":"Configures the body limit to sign. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".dkim.signature-timestamp","additionalKeys":[],"configDoc":"Configures to enable or disable signature sign timestamp.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-timestamp","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SIGNATURE_TIMESTAMP","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".dkim.expire-time","additionalKeys":[],"configDoc":"Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"expire-time","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_EXPIRE_TIME","enum":false}},{"configDocKey":{"type":"string","key":".dkim.signed-headers","additionalKeys":[],"configDoc":"Configures the signed headers in DKIM, separated by commas. The order in the list matters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signed-headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DKIM_SIGNED_HEADERS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".login","additionalKeys":[],"configDoc":"Sets the login mode for the connection. Either `NONE`, @++{++code DISABLED++}++, `OPTIONAL`, `REQUIRED` or `XOAUTH2`.\n\n - DISABLED means no login will be attempted\n - NONE means a login will be attempted if the server supports in and login credentials are set\n - REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise\n - XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"login","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOGIN","enum":false}},{"configDocKey":{"type":"string","key":".auth-methods","additionalKeys":[],"configDoc":"Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used.\n\nThe list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-methods","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_AUTH_METHODS","enum":false}},{"configDocKey":{"type":"boolean","key":".multi-part-only","additionalKeys":[],"configDoc":"Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"multi-part-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTI_PART_ONLY","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-rcpt-errors","additionalKeys":[],"configDoc":"Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-rcpt-errors","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_RCPT_ERRORS","enum":false}},{"configDocKey":{"type":"boolean","key":".pipelining","additionalKeys":[],"configDoc":"Enables or disables the pipelining capability if the SMTP server supports it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pipelining","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PIPELINING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".pool-cleaner-period","additionalKeys":[],"configDoc":"Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-period","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POOL_CLEANER_PERIOD","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".keep-alive-timeout","additionalKeys":[],"configDoc":"Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.","withinAMap":false,"defaultValue":"PT300S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".ntlm","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.mailer.runtime.NtlmConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".ntlm.workstation","additionalKeys":[],"configDoc":"Sets the workstation used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"workstation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NTLM_WORKSTATION","enum":false}},{"configDocKey":{"type":"string","key":".ntlm.domain","additionalKeys":[],"configDoc":"Sets the domain used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"domain","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NTLM_DOMAIN","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.util.regex.Pattern","key":".approved-recipients","additionalKeys":[],"configDoc":"Allows sending emails to these recipients only.\n\nApproved recipients are compiled to a `Pattern` and must be a valid regular expression. The created `Pattern` is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"approved-recipients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_APPROVED_RECIPIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":".log-rejected-recipients","additionalKeys":[],"configDoc":"Log rejected recipients as warnings.\n\nIf false, the rejected recipients will be logged at the DEBUG level.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-rejected-recipients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOG_REJECTED_RECIPIENTS","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mongodb.deployment.DevServicesBuildTimeConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mongodb.deployment.DevServicesBuildTimeConfig index 0a05ff38c22..a5548c60c31 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mongodb.deployment.DevServicesBuildTimeConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.mongodb.deployment.DevServicesBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".properties.\"property-key\"","additionalKeys":[],"configDoc":"Generic properties that are added to the connection URL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"property-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROPERTIES__PROPERTY_KEY_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".properties.\"property-key\"","additionalKeys":[],"configDoc":"Generic properties that are added to the connection URL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"property-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROPERTIES__PROPERTY_KEY_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container.\n\nThe discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value.","withinAMap":false,"defaultValue":"mongodb","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SERVICE_NAME","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.DevServicesConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.DevServicesConfig index b0e5b8db03e..2a0822ac86e 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.DevServicesConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.DevServicesConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`.","withinAMap":false,"defaultValue":"quay.io/keycloak/keycloak:23.0.7","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".keycloak-x-image","additionalKeys":[],"configDoc":"Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keycloak-x-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEYCLOAK_X_IMAGE","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".realm-path","additionalKeys":[],"configDoc":"A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REALM_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".resource-aliases.\"alias-name\"","additionalKeys":[],"configDoc":"Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"alias-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RESOURCE_ALIASES__ALIAS_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".resource-mappings.\"resource-name\"","additionalKeys":[],"configDoc":"Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"resource-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RESOURCE_MAPPINGS__RESOURCE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".java-opts","additionalKeys":[],"configDoc":"The `JAVA_OPTS` passed to the keycloak JVM","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"java-opts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JAVA_OPTS","enum":false}},{"configDocKey":{"type":"boolean","key":".show-logs","additionalKeys":[],"configDoc":"Show Keycloak log messages with a \"Keycloak:\" prefix.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"show-logs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHOW_LOGS","enum":false}},{"configDocKey":{"type":"string","key":".start-command","additionalKeys":[],"configDoc":"Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"start-command","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_START_COMMAND","enum":false}},{"configDocKey":{"type":"string","key":".realm-name","additionalKeys":[],"configDoc":"The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REALM_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":".create-realm","additionalKeys":[],"configDoc":"Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREATE_REALM","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".users.\"users\"","additionalKeys":[],"configDoc":"A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"users","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USERS__USERS_","enum":false}},{"configDocKey":{"type":"java.util.List","key":".roles.\"role-name\"","additionalKeys":[],"configDoc":"A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"The specific port for the dev service to listen on.\n\nIf not specified, a random port is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables to be passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`.","withinAMap":false,"defaultValue":"quay.io/keycloak/keycloak:24.0.4","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".keycloak-x-image","additionalKeys":[],"configDoc":"Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keycloak-x-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEYCLOAK_X_IMAGE","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".realm-path","additionalKeys":[],"configDoc":"A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REALM_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".resource-aliases.\"alias-name\"","additionalKeys":[],"configDoc":"Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"alias-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RESOURCE_ALIASES__ALIAS_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".resource-mappings.\"resource-name\"","additionalKeys":[],"configDoc":"Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"resource-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RESOURCE_MAPPINGS__RESOURCE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".java-opts","additionalKeys":[],"configDoc":"The `JAVA_OPTS` passed to the keycloak JVM","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"java-opts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JAVA_OPTS","enum":false}},{"configDocKey":{"type":"boolean","key":".show-logs","additionalKeys":[],"configDoc":"Show Keycloak log messages with a \"Keycloak:\" prefix.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"show-logs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHOW_LOGS","enum":false}},{"configDocKey":{"type":"string","key":".start-command","additionalKeys":[],"configDoc":"Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"start-command","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_START_COMMAND","enum":false}},{"configDocKey":{"type":"string","key":".realm-name","additionalKeys":[],"configDoc":"The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REALM_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":".create-realm","additionalKeys":[],"configDoc":"Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREATE_REALM","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".users.\"users\"","additionalKeys":[],"configDoc":"A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"users","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USERS__USERS_","enum":false}},{"configDocKey":{"type":"java.util.List","key":".roles.\"role-name\"","additionalKeys":[],"configDoc":"A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"The specific port for the dev service to listen on.\n\nIf not specified, a random port is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables to be passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.build.TracesBuildConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.build.TracesBuildConfig index 662525fc49f..08d1e3f2b3f 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.build.TracesBuildConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.build.TracesBuildConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".exporter","additionalKeys":[],"configDoc":"List of exporters supported by Quarkus.\n\nList of exporters to be used for tracing, separated by commas. Has one of the values on `ExporterType` `otlp`, `cdi`, `none` or the full qualified name of a class implementing `io.opentelemetry.sdk.trace.export.SpanExporter`\n\nDefault on Quarkus is `ExporterType.Constants++#++CDI_VALUE`.","withinAMap":false,"defaultValue":"cdi","javaDocSiteLink":"","docMapKey":"exporter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":".sampler","additionalKeys":[],"configDoc":"The sampler to use for tracing.\n\nHas one of the values on `SamplerType` `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the `io.opentelemetry.sdk.trace.samplers.Sampler` implementation set in the provider: `io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider`.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.sampler.name` or defaults to `SamplerType.Constants++#++PARENT_BASED_ALWAYS_ON`.","withinAMap":false,"defaultValue":"parentbased_always_on","javaDocSiteLink":"","docMapKey":"sampler","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SAMPLER","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".exporter","additionalKeys":[],"configDoc":"List of exporters supported by Quarkus.\n\nList of exporters to be used for tracing, separated by commas. Has one of the values on `ExporterType` `otlp`, `cdi`, `none` or the full qualified name of a class implementing `io.opentelemetry.sdk.trace.export.SpanExporter`\n\nDefault on Quarkus is `ExporterType.Constants++#++CDI_VALUE`.","withinAMap":false,"defaultValue":"cdi","javaDocSiteLink":"","docMapKey":"exporter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":".sampler","additionalKeys":[],"configDoc":"The sampler to use for tracing.\n\nHas one of the values on `SamplerType` `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the `io.opentelemetry.sdk.trace.samplers.Sampler` implementation set in the provider: `io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider`.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.sampler.name` or defaults to `SamplerType.Constants++#++PARENT_BASED_ALWAYS_ON`.","withinAMap":false,"defaultValue":"parentbased_always_on","javaDocSiteLink":"","docMapKey":"sampler","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SAMPLER","enum":false}},{"configDocKey":{"type":"boolean","key":".eusp.enabled","additionalKeys":[],"configDoc":"If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"add-end-user-attributes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EUSP_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig index 3262b9aeb08..aec5cbcaaaa 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":".headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HEADERS","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":".compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COMPRESSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.\n\nCurrently, only `grpc` and `http/protobuf` are allowed.","withinAMap":false,"defaultValue":"grpc","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOL","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.KeyCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.TrustCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".proxy-options","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.ProxyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".proxy-options.enabled","additionalKeys":[],"configDoc":"If proxy connection must be used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_HOST","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":".headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HEADERS","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":".compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COMPRESSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.\n\nCurrently, only `grpc` and `http/protobuf` are allowed.","withinAMap":false,"defaultValue":"grpc","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOL","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.KeyCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.TrustCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".proxy-options","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.ProxyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".proxy-options.enabled","additionalKeys":[],"configDoc":"If proxy connection must be used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_HOST","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.redis.runtime.client.config.RedisClientConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.redis.runtime.client.config.RedisClientConfig index b8a45c65a25..deea9561c4f 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.redis.runtime.client.config.RedisClientConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.redis.runtime.client.config.RedisClientConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"java.net.URI","key":".hosts","additionalKeys":[],"configDoc":"The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.\n\nThe URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":".hosts-provider-name","additionalKeys":[],"configDoc":"The hosts provider bean name.\n\nIt is the `&++#++64;Named` value of the hosts provider bean. It is used to discriminate if multiple `io.quarkus.redis.client.RedisHostsProvider` beans are available.\n\nUsed when `quarkus.redis.hosts` is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts-provider-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"The maximum delay to wait before a blocking command to redis server times out","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TIMEOUT","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisClientType","key":".client-type","additionalKeys":[],"configDoc":"The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.","withinAMap":false,"defaultValue":"standalone","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisClientType.html","docMapKey":"client-type","configPhase":"BUILD_TIME","acceptedValues":["`standalone`","`sentinel`","`cluster`","`replication`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CLIENT_TYPE","enum":true}},{"configDocKey":{"type":"string","key":".master-name","additionalKeys":[],"configDoc":"The master name (only considered in HA mode).","withinAMap":false,"defaultValue":"mymaster","javaDocSiteLink":"","docMapKey":"master-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MASTER_NAME","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisRole","key":".role","additionalKeys":[],"configDoc":"The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.","withinAMap":false,"defaultValue":"master","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisRole.html","docMapKey":"role","configPhase":"BUILD_TIME","acceptedValues":["`master`","`replica`","`sentinel`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ROLE","enum":true}},{"configDocKey":{"type":"io.vertx.redis.client.RedisReplicas","key":".replicas","additionalKeys":[],"configDoc":"Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.","withinAMap":false,"defaultValue":"never","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisReplicas.html","docMapKey":"replicas","configPhase":"BUILD_TIME","acceptedValues":["`never`","`share`","`always`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REPLICAS","enum":true}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"The default password for cluster/sentinel connections.\n\nIf not set it will try to extract the value from the current default `++#++hosts`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool. When working with cluster or sentinel.\n\nThis value should be at least the total number of cluster member (or number of sentinels {plus} 1)","withinAMap":false,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"int","key":".max-pool-waiting","additionalKeys":[],"configDoc":"The maximum waiting requests for a connection from the pool.","withinAMap":false,"defaultValue":"24","javaDocSiteLink":"","docMapKey":"max-pool-waiting","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_POOL_WAITING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".pool-cleaner-interval","additionalKeys":[],"configDoc":"The duration indicating how often should the connection pool cleaner executes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POOL_CLEANER_INTERVAL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".pool-recycle-timeout","additionalKeys":[],"configDoc":"The timeout for a connection recycling.","withinAMap":false,"defaultValue":"15S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-recycle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POOL_RECYCLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"int","key":".max-waiting-handlers","additionalKeys":[],"configDoc":"Sets how many handlers is the client willing to queue.\n\nThe client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you're willing to accept.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-waiting-handlers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_WAITING_HANDLERS","enum":false}},{"configDocKey":{"type":"int","key":".max-nested-arrays","additionalKeys":[],"configDoc":"Tune how much nested arrays are allowed on a redis response. This affects the parser performance.","withinAMap":false,"defaultValue":"32","javaDocSiteLink":"","docMapKey":"max-nested-arrays","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_NESTED_ARRAYS","enum":false}},{"configDocKey":{"type":"int","key":".reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"boolean","key":".protocol-negotiation","additionalKeys":[],"configDoc":"Should the client perform `RESP` protocol negotiation during the connection handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"protocol-negotiation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOL_NEGOTIATION","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.ProtocolVersion","key":".preferred-protocol-version","additionalKeys":[],"configDoc":"The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.","withinAMap":false,"defaultValue":"resp3","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/ProtocolVersion.html","docMapKey":"preferred-protocol-version","configPhase":"BUILD_TIME","acceptedValues":["`resp2`","`resp3`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PREFERRED_PROTOCOL_VERSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".hash-slot-cache-ttl","additionalKeys":[],"configDoc":"The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending `CLUSTER SLOTS` commands to the first statically configured cluster node.\n\nThis setting is only meaningful in case of a clustered Redis client and has no effect otherwise.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"hash-slot-cache-ttl","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HASH_SLOT_CACHE_TTL","enum":false}},{"configDocSection":{"name":".tcp","optional":false,"withinAMap":false,"sectionDetails":"== TCP config","sectionDetailsTitle":"TCP config","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.redis.runtime.client.config.NetConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.alpn","additionalKeys":[],"configDoc":"Set the ALPN usage.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_ALPN","enum":false}},{"configDocKey":{"type":"string","key":".tcp.application-layer-protocols","additionalKeys":[],"configDoc":"Sets the list of application-layer protocols to provide to the server during the `Application-Layer Protocol Negotiation`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"application-layer-protocols","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_APPLICATION_LAYER_PROTOCOLS","enum":false}},{"configDocKey":{"type":"string","key":".tcp.secure-transport-protocols","additionalKeys":[],"configDoc":"Sets the list of enabled SSL/TLS protocols.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secure-transport-protocols","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_SECURE_TRANSPORT_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.idle-timeout","additionalKeys":[],"configDoc":"Set the idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.connection-timeout","additionalKeys":[],"configDoc":"Set the connect timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".tcp.non-proxy-hosts","additionalKeys":[],"configDoc":"Set a list of remote hosts that are not proxied when the client is configured to use a proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":".tcp.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".tcp.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":".tcp.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port. Defaults to 3128.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":".tcp.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_HOST","enum":false}},{"configDocKey":{"type":"io.vertx.core.net.ProxyType","key":".tcp.proxy-options.type","additionalKeys":[],"configDoc":"Set proxy type. Accepted values are: `HTTP` (default), `SOCKS4` and `SOCKS5`.","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/net/ProxyType.html","docMapKey":"type","configPhase":"BUILD_TIME","acceptedValues":["`http`","`socks4`","`socks5`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_TYPE","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.read-idle-timeout","additionalKeys":[],"configDoc":"Set the read idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_READ_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.receive-buffer-size","additionalKeys":[],"configDoc":"Set the TCP receive buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"receive-buffer-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_RECEIVE_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.reconnect-attempts","additionalKeys":[],"configDoc":"Set the value of reconnect attempts.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.reconnect-interval","additionalKeys":[],"configDoc":"Set the reconnect interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.reuse-address","additionalKeys":[],"configDoc":"Whether to reuse the address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_REUSE_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.reuse-port","additionalKeys":[],"configDoc":"Whether to reuse the port.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_REUSE_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.send-buffer-size","additionalKeys":[],"configDoc":"Set the TCP send buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"send-buffer-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_SEND_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.so-linger","additionalKeys":[],"configDoc":"Set the `SO_linger` keep alive duration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"so-linger","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_SO_LINGER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.cork","additionalKeys":[],"configDoc":"Enable the `TCP_CORK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cork","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_CORK","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.fast-open","additionalKeys":[],"configDoc":"Enable the `TCP_FASTOPEN` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"fast-open","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.keep-alive","additionalKeys":[],"configDoc":"Set whether keep alive is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.no-delay","additionalKeys":[],"configDoc":"Set whether no delay is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"no-delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_NO_DELAY","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.quick-ack","additionalKeys":[],"configDoc":"Enable the `TCP_QUICKACK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"quick-ack","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.traffic-class","additionalKeys":[],"configDoc":"Set the value of traffic class.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"traffic-class","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_TRAFFIC_CLASS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.write-idle-timeout","additionalKeys":[],"configDoc":"Set the write idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"write-idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_WRITE_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".tcp.local-address","additionalKeys":[],"configDoc":"Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_LOCAL_ADDRESS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".tls","optional":false,"withinAMap":false,"sectionDetails":"== SSL/TLS config","sectionDetailsTitle":"SSL/TLS config","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.redis.runtime.client.config.TlsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).\n\nIf set to `NONE`, it does not verify the hostname.","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"java.net.URI","key":".hosts","additionalKeys":[],"configDoc":"The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.\n\nThe URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":".hosts-provider-name","additionalKeys":[],"configDoc":"The hosts provider bean name.\n\nIt is the `&++#++64;Named` value of the hosts provider bean. It is used to discriminate if multiple `io.quarkus.redis.client.RedisHostsProvider` beans are available.\n\nUsed when `quarkus.redis.hosts` is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts-provider-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"The maximum delay to wait before a blocking command to redis server times out","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TIMEOUT","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisClientType","key":".client-type","additionalKeys":[],"configDoc":"The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.","withinAMap":false,"defaultValue":"standalone","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisClientType.html","docMapKey":"client-type","configPhase":"BUILD_TIME","acceptedValues":["`standalone`","`sentinel`","`cluster`","`replication`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CLIENT_TYPE","enum":true}},{"configDocKey":{"type":"string","key":".master-name","additionalKeys":[],"configDoc":"The master name (only considered in HA mode).","withinAMap":false,"defaultValue":"mymaster","javaDocSiteLink":"","docMapKey":"master-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MASTER_NAME","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisRole","key":".role","additionalKeys":[],"configDoc":"The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.","withinAMap":false,"defaultValue":"master","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisRole.html","docMapKey":"role","configPhase":"BUILD_TIME","acceptedValues":["`master`","`replica`","`sentinel`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ROLE","enum":true}},{"configDocKey":{"type":"io.vertx.redis.client.RedisReplicas","key":".replicas","additionalKeys":[],"configDoc":"Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.","withinAMap":false,"defaultValue":"never","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisReplicas.html","docMapKey":"replicas","configPhase":"BUILD_TIME","acceptedValues":["`never`","`share`","`always`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REPLICAS","enum":true}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"The default password for cluster/sentinel connections.\n\nIf not set it will try to extract the value from the current default `++#++hosts`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool. When working with cluster or sentinel.\n\nThis value should be at least the total number of cluster member (or number of sentinels {plus} 1)","withinAMap":false,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"int","key":".max-pool-waiting","additionalKeys":[],"configDoc":"The maximum waiting requests for a connection from the pool.","withinAMap":false,"defaultValue":"24","javaDocSiteLink":"","docMapKey":"max-pool-waiting","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_POOL_WAITING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".pool-cleaner-interval","additionalKeys":[],"configDoc":"The duration indicating how often should the connection pool cleaner executes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POOL_CLEANER_INTERVAL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".pool-recycle-timeout","additionalKeys":[],"configDoc":"The timeout for a connection recycling.","withinAMap":false,"defaultValue":"15S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-recycle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POOL_RECYCLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"int","key":".max-waiting-handlers","additionalKeys":[],"configDoc":"Sets how many handlers is the client willing to queue.\n\nThe client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you're willing to accept.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-waiting-handlers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_WAITING_HANDLERS","enum":false}},{"configDocKey":{"type":"int","key":".max-nested-arrays","additionalKeys":[],"configDoc":"Tune how much nested arrays are allowed on a redis response. This affects the parser performance.","withinAMap":false,"defaultValue":"32","javaDocSiteLink":"","docMapKey":"max-nested-arrays","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_NESTED_ARRAYS","enum":false}},{"configDocKey":{"type":"int","key":".reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"boolean","key":".protocol-negotiation","additionalKeys":[],"configDoc":"Should the client perform `RESP` protocol negotiation during the connection handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"protocol-negotiation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOL_NEGOTIATION","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.ProtocolVersion","key":".preferred-protocol-version","additionalKeys":[],"configDoc":"The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.","withinAMap":false,"defaultValue":"resp3","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/ProtocolVersion.html","docMapKey":"preferred-protocol-version","configPhase":"BUILD_TIME","acceptedValues":["`resp2`","`resp3`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PREFERRED_PROTOCOL_VERSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".hash-slot-cache-ttl","additionalKeys":[],"configDoc":"The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending `CLUSTER SLOTS` commands to the first statically configured cluster node.\n\nThis setting is only meaningful in case of a clustered Redis client and has no effect otherwise.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"hash-slot-cache-ttl","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HASH_SLOT_CACHE_TTL","enum":false}},{"configDocSection":{"name":".tcp","optional":false,"withinAMap":false,"sectionDetails":"== TCP config","sectionDetailsTitle":"TCP config","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.redis.runtime.client.config.NetConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.alpn","additionalKeys":[],"configDoc":"Set the ALPN usage.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_ALPN","enum":false}},{"configDocKey":{"type":"string","key":".tcp.application-layer-protocols","additionalKeys":[],"configDoc":"Sets the list of application-layer protocols to provide to the server during the `Application-Layer Protocol Negotiation`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"application-layer-protocols","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_APPLICATION_LAYER_PROTOCOLS","enum":false}},{"configDocKey":{"type":"string","key":".tcp.secure-transport-protocols","additionalKeys":[],"configDoc":"Sets the list of enabled SSL/TLS protocols.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secure-transport-protocols","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_SECURE_TRANSPORT_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.idle-timeout","additionalKeys":[],"configDoc":"Set the idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.connection-timeout","additionalKeys":[],"configDoc":"Set the connect timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".tcp.non-proxy-hosts","additionalKeys":[],"configDoc":"Set a list of remote hosts that are not proxied when the client is configured to use a proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":".tcp.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".tcp.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":".tcp.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port. Defaults to 3128.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":".tcp.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_HOST","enum":false}},{"configDocKey":{"type":"io.vertx.core.net.ProxyType","key":".tcp.proxy-options.type","additionalKeys":[],"configDoc":"Set proxy type. Accepted values are: `HTTP` (default), `SOCKS4` and `SOCKS5`.","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/net/ProxyType.html","docMapKey":"type","configPhase":"BUILD_TIME","acceptedValues":["`http`","`socks4`","`socks5`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_PROXY_OPTIONS_TYPE","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.read-idle-timeout","additionalKeys":[],"configDoc":"Set the read idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_READ_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.receive-buffer-size","additionalKeys":[],"configDoc":"Set the TCP receive buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"receive-buffer-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_RECEIVE_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.reconnect-attempts","additionalKeys":[],"configDoc":"Set the value of reconnect attempts.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.reconnect-interval","additionalKeys":[],"configDoc":"Set the reconnect interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.reuse-address","additionalKeys":[],"configDoc":"Whether to reuse the address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_REUSE_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.reuse-port","additionalKeys":[],"configDoc":"Whether to reuse the port.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_REUSE_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.send-buffer-size","additionalKeys":[],"configDoc":"Set the TCP send buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"send-buffer-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_SEND_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.so-linger","additionalKeys":[],"configDoc":"Set the `SO_linger` keep alive duration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"so-linger","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_SO_LINGER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.cork","additionalKeys":[],"configDoc":"Enable the `TCP_CORK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cork","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_CORK","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.fast-open","additionalKeys":[],"configDoc":"Enable the `TCP_FASTOPEN` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"fast-open","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.keep-alive","additionalKeys":[],"configDoc":"Set whether keep alive is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.no-delay","additionalKeys":[],"configDoc":"Set whether no delay is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"no-delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_NO_DELAY","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".tcp.quick-ack","additionalKeys":[],"configDoc":"Enable the `TCP_QUICKACK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"quick-ack","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".tcp.traffic-class","additionalKeys":[],"configDoc":"Set the value of traffic class.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"traffic-class","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_TRAFFIC_CLASS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".tcp.write-idle-timeout","additionalKeys":[],"configDoc":"Set the write idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"write-idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_WRITE_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".tcp.local-address","additionalKeys":[],"configDoc":"Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TCP_LOCAL_ADDRESS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".tls","optional":false,"withinAMap":false,"sectionDetails":"== SSL/TLS config","sectionDetailsTitle":"SSL/TLS config","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.redis.runtime.client.config.TlsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_TRUST_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":".tls.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_KEY_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).\n\nIf set to `NONE`, it does not verify the hostname.","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used.\n\nThe default TLS configuration is *not* used by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientConfig index 563404337c6..1f1f0fd5659 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientConfig @@ -1 +1 @@ -[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".multipart","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.restclient.config.RestClientMultipartConfig","showSection":false,"configDocItems":[],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".url","additionalKeys":[],"configDoc":"The base URL to use for this service. This property or the `uri` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_URL","enum":false}},{"configDocKey":{"type":"string","key":".uri","additionalKeys":[],"configDoc":"The base URI to use for this service. This property or the `url` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"uri","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_URI","enum":false}},{"configDocKey":{"type":"string","key":".providers","additionalKeys":[],"configDoc":"Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"providers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROVIDERS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".connect-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait to connect to the remote endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connect-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONNECT_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".read-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait for a response from the remote endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"read-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".follow-redirects","additionalKeys":[],"configDoc":"A boolean value used to determine whether the client should follow HTTP redirect responses.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"follow-redirects","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FOLLOW_REDIRECTS","enum":false}},{"configDocKey":{"type":"string","key":".multipart-post-encoder-mode","additionalKeys":[],"configDoc":"Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the link:https://netty.io/4.1/api/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.EncoderMode.html[Netty documentation]\n\nBy default, Rest Client Reactive uses RFC1738.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multipart-post-encoder-mode","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTIPART_POST_ENCODER_MODE","enum":false}},{"configDocKey":{"type":"string","key":".proxy-address","additionalKeys":[],"configDoc":"A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use. Use `none` to disable proxy","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":".proxy-user","additionalKeys":[],"configDoc":"Proxy username.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-user","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_USER","enum":false}},{"configDocKey":{"type":"string","key":".proxy-password","additionalKeys":[],"configDoc":"Proxy password.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".non-proxy-hosts","additionalKeys":[],"configDoc":"Hosts to access without proxy\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"org.eclipse.microprofile.rest.client.ext.QueryParamStyle","key":".query-param-style","additionalKeys":[],"configDoc":"An enumerated type string value with possible values of \"MULTI_PAIRS\" (default), \"COMMA_SEPARATED\", or \"ARRAY_PAIRS\" that specifies the format in which multiple values for the same query parameter is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"query-param-style","configPhase":"BUILD_TIME","acceptedValues":["`multi-pairs`","`comma-separated`","`array-pairs`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_PARAM_STYLE","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":".verify-host","additionalKeys":[],"configDoc":"Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verify-host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERIFY_HOST","enum":false}},{"configDocKey":{"type":"string","key":".trust-store","additionalKeys":[],"configDoc":"The trust store location. Can point to either a classpath resource or a file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":".trust-store-password","additionalKeys":[],"configDoc":"The trust store password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".trust-store-type","additionalKeys":[],"configDoc":"The type of the trust store. Defaults to \"JKS\".","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":".key-store","additionalKeys":[],"configDoc":"The key store location. Can point to either a classpath resource or a file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":".key-store-password","additionalKeys":[],"configDoc":"The key store password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".key-store-type","additionalKeys":[],"configDoc":"The type of the key store. Defaults to \"JKS\".","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":".hostname-verifier","additionalKeys":[],"configDoc":"The class name of the host name verifier. The class must have a public no-argument constructor.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTNAME_VERIFIER","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".connection-ttl","additionalKeys":[],"configDoc":"The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of `0` means there is no timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-ttl","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONNECTION_TTL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".connection-pool-size","additionalKeys":[],"configDoc":"The size of the connection pool for this client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONNECTION_POOL_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".keep-alive-enabled","additionalKeys":[],"configDoc":"If set to false disables the keep alive completely.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-redirects","additionalKeys":[],"configDoc":"The maximum number of redirection a request can follow.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-redirects","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_REDIRECTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".headers.\"header-name\"","additionalKeys":[],"configDoc":"The HTTP headers that should be applied to all requests of the rest client.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".shared","additionalKeys":[],"configDoc":"Set to true to share the HTTP client between REST clients. There can be multiple shared clients distinguished by _name_, when no specific name is set, the name `__vertx.DEFAULT` is used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".name","additionalKeys":[],"configDoc":"Set the HTTP client name, used when the client is shared, otherwise ignored.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAME","enum":false}},{"configDocKey":{"type":"string","key":".user-agent","additionalKeys":[],"configDoc":"Configure the HTTP user-agent header to use.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USER_AGENT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".http2","additionalKeys":[],"configDoc":"If this is true then HTTP/2 will be enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http2","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HTTP2","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":".max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size (8096 bytes by default).\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"8K","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".alpn","additionalKeys":[],"configDoc":"If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALPN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".capture-stacktrace","additionalKeys":[],"configDoc":"If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"capture-stacktrace","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CAPTURE_STACKTRACE","enum":false}}] \ No newline at end of file +[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".multipart","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.restclient.config.RestClientMultipartConfig","showSection":false,"configDocItems":[],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".url","additionalKeys":[],"configDoc":"The base URL to use for this service. This property or the `uri` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_URL","enum":false}},{"configDocKey":{"type":"string","key":".uri","additionalKeys":[],"configDoc":"The base URI to use for this service. This property or the `url` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"uri","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_URI","enum":false}},{"configDocKey":{"type":"string","key":".providers","additionalKeys":[],"configDoc":"Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"providers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROVIDERS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".connect-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait to connect to the remote endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connect-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONNECT_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":".read-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait for a response from the remote endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"read-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".follow-redirects","additionalKeys":[],"configDoc":"A boolean value used to determine whether the client should follow HTTP redirect responses.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"follow-redirects","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FOLLOW_REDIRECTS","enum":false}},{"configDocKey":{"type":"string","key":".multipart-post-encoder-mode","additionalKeys":[],"configDoc":"Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the link:https://netty.io/4.1/api/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.EncoderMode.html[Netty documentation]\n\nBy default, Rest Client Reactive uses RFC1738.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multipart-post-encoder-mode","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MULTIPART_POST_ENCODER_MODE","enum":false}},{"configDocKey":{"type":"string","key":".proxy-address","additionalKeys":[],"configDoc":"A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use. Use `none` to disable proxy","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-address","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":".proxy-user","additionalKeys":[],"configDoc":"Proxy username.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-user","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_USER","enum":false}},{"configDocKey":{"type":"string","key":".proxy-password","additionalKeys":[],"configDoc":"Proxy password.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".non-proxy-hosts","additionalKeys":[],"configDoc":"Hosts to access without proxy\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"org.eclipse.microprofile.rest.client.ext.QueryParamStyle","key":".query-param-style","additionalKeys":[],"configDoc":"An enumerated type string value with possible values of \"MULTI_PAIRS\" (default), \"COMMA_SEPARATED\", or \"ARRAY_PAIRS\" that specifies the format in which multiple values for the same query parameter is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"query-param-style","configPhase":"BUILD_TIME","acceptedValues":["`multi-pairs`","`comma-separated`","`array-pairs`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_QUERY_PARAM_STYLE","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":".verify-host","additionalKeys":[],"configDoc":"Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verify-host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERIFY_HOST","enum":false}},{"configDocKey":{"type":"string","key":".trust-store","additionalKeys":[],"configDoc":"The trust store location. Can point to either a classpath resource or a file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":".trust-store-password","additionalKeys":[],"configDoc":"The trust store password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".trust-store-type","additionalKeys":[],"configDoc":"The type of the trust store. Defaults to \"JKS\".","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":".key-store","additionalKeys":[],"configDoc":"The key store location. Can point to either a classpath resource or a file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":".key-store-password","additionalKeys":[],"configDoc":"The key store password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".key-store-type","additionalKeys":[],"configDoc":"The type of the key store. Defaults to \"JKS\".","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":".hostname-verifier","additionalKeys":[],"configDoc":"The class name of the host name verifier. The class must have a public no-argument constructor.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTNAME_VERIFIER","enum":false}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".connection-ttl","additionalKeys":[],"configDoc":"The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of `0` means there is no timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-ttl","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONNECTION_TTL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".connection-pool-size","additionalKeys":[],"configDoc":"The size of the connection pool for this client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONNECTION_POOL_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".keep-alive-enabled","additionalKeys":[],"configDoc":"If set to false disables the keep alive completely.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEEP_ALIVE_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-redirects","additionalKeys":[],"configDoc":"The maximum number of redirection a request can follow.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-redirects","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_REDIRECTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".headers.\"header-name\"","additionalKeys":[],"configDoc":"The HTTP headers that should be applied to all requests of the rest client.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".shared","additionalKeys":[],"configDoc":"Set to true to share the HTTP client between REST clients. There can be multiple shared clients distinguished by _name_, when no specific name is set, the name `__vertx.DEFAULT` is used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SHARED","enum":false}},{"configDocKey":{"type":"string","key":".name","additionalKeys":[],"configDoc":"Set the HTTP client name, used when the client is shared, otherwise ignored.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAME","enum":false}},{"configDocKey":{"type":"string","key":".user-agent","additionalKeys":[],"configDoc":"Configure the HTTP user-agent header to use.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USER_AGENT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".http2","additionalKeys":[],"configDoc":"If this is true then HTTP/2 will be enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http2","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HTTP2","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":".max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size (8096 bytes by default).\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"8K","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".alpn","additionalKeys":[],"configDoc":"If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALPN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".capture-stacktrace","additionalKeys":[],"configDoc":"If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"capture-stacktrace","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CAPTURE_STACKTRACE","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.JsonConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.JsonConfig index 4d795cc4580..84e5f4e1705 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.JsonConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.JsonConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":".allow-special-floating-point-values","additionalKeys":[],"configDoc":"Removes JSON specification restriction on special floating-point values such as `NaN` and `Infinity` and enables their serialization and deserialization. When enabling it, please ensure that the receiving party will be able to encode and decode these special values.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-special-floating-point-values","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_SPECIAL_FLOATING_POINT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-structured-map-keys","additionalKeys":[],"configDoc":"Enables structured objects to be serialized as map keys by changing serialized form of the map from JSON object (key-value pairs) to flat array like `++[++k1, v1, k2, v2++]++`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-structured-map-keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_STRUCTURED_MAP_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".class-discriminator","additionalKeys":[],"configDoc":"Name of the class descriptor property for polymorphic serialization.","withinAMap":false,"defaultValue":"type","javaDocSiteLink":"","docMapKey":"class-discriminator","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CLASS_DISCRIMINATOR","enum":false}},{"configDocKey":{"type":"boolean","key":".coerce-input-values","additionalKeys":[],"configDoc":"Enables coercing incorrect JSON values to the default property value in the following cases: 1. JSON value is `null` but property type is non-nullable. 2. Property type is an enum type, but JSON value contains unknown enum member.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"coerce-input-values","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COERCE_INPUT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":".encode-defaults","additionalKeys":[],"configDoc":"Specifies whether default values of Kotlin properties should be encoded.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encode-defaults","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCODE_DEFAULTS","enum":false}},{"configDocKey":{"type":"boolean","key":".explicit-nulls","additionalKeys":[],"configDoc":"Specifies whether `null` values should be encoded for nullable properties and must be present in JSON object during decoding.\n\nWhen this flag is disabled properties with `null` values without default are not encoded; during decoding, the absence of a field value is treated as `null` for nullable properties without a default value.\n\n`true` by default.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"explicit-nulls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXPLICIT_NULLS","enum":false}},{"configDocKey":{"type":"boolean","key":".ignore-unknown-keys","additionalKeys":[],"configDoc":"Specifies whether encounters of unknown properties in the input JSON should be ignored instead of throwing ++[++SerializationException++]++.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-unknown-keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IGNORE_UNKNOWN_KEYS","enum":false}},{"configDocKey":{"type":"boolean","key":".is-lenient","additionalKeys":[],"configDoc":"Removes JSON specification restriction (RFC-4627) and makes parser more liberal to the malformed input. In lenient mode quoted boolean literals, and unquoted string literals are allowed.\n\nIts relaxations can be expanded in the future, so that lenient parser becomes even more permissive to invalid value in the input, replacing them with defaults.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"is-lenient","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IS_LENIENT","enum":false}},{"configDocKey":{"type":"boolean","key":".pretty-print","additionalKeys":[],"configDoc":"Specifies whether resulting JSON should be pretty-printed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pretty-print","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PRETTY_PRINT","enum":false}},{"configDocKey":{"type":"string","key":".pretty-print-indent","additionalKeys":[],"configDoc":"Specifies indent string to use with ++[++prettyPrint++]++ mode","withinAMap":false,"defaultValue":" ","javaDocSiteLink":"","docMapKey":"pretty-print-indent","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PRETTY_PRINT_INDENT","enum":false}},{"configDocKey":{"type":"boolean","key":".use-alternative-names","additionalKeys":[],"configDoc":"Specifies whether Json instance makes use of ++[++JsonNames++]++ annotation.\n\nDisabling this flag when one does not use ++[++JsonNames++]++ at all may sometimes result in better performance, particularly when a large count of fields is skipped with ++[++ignoreUnknownKeys++]++.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"use-alternative-names","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USE_ALTERNATIVE_NAMES","enum":false}},{"configDocKey":{"type":"boolean","key":".use-array-polymorphism","additionalKeys":[],"configDoc":"Switches polymorphic serialization to the default array format. This is an option for legacy JSON format and should not be generally used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-array-polymorphism","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USE_ARRAY_POLYMORPHISM","enum":false}},{"configDocKey":{"type":"string","key":".naming-strategy","additionalKeys":[],"configDoc":"Specifies the `JsonNamingStrategy` that should be used for all properties in classes for serialization and deserialization. This strategy is applied for all entities that have `StructureKind.CLASS`.\n\n\n\n`null` by default.\n\n\n\nThis element can be one of two things:\n\n . the fully qualified class name of a type implements the `NamingStrategy` interface and has a no-arg constructor\n - a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"boolean","key":".decode-enums-case-insensitive","additionalKeys":[],"configDoc":"Specifies if the enum values should be decoded case insensitively.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"decode-enums-case-insensitive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DECODE_ENUMS_CASE_INSENSITIVE","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-trailing-comma","additionalKeys":[],"configDoc":"Specifies if trailing comma is allowed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-trailing-comma","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_TRAILING_COMMA","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":".allow-special-floating-point-values","additionalKeys":[],"configDoc":"Removes JSON specification restriction on special floating-point values such as `NaN` and `Infinity` and enables their serialization and deserialization. When enabling it, please ensure that the receiving party will be able to encode and decode these special values.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-special-floating-point-values","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_SPECIAL_FLOATING_POINT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-structured-map-keys","additionalKeys":[],"configDoc":"Enables structured objects to be serialized as map keys by changing serialized form of the map from JSON object (key-value pairs) to flat array like `++[++k1, v1, k2, v2++]++`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-structured-map-keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_STRUCTURED_MAP_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".class-discriminator","additionalKeys":[],"configDoc":"Name of the class descriptor property for polymorphic serialization.","withinAMap":false,"defaultValue":"type","javaDocSiteLink":"","docMapKey":"class-discriminator","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CLASS_DISCRIMINATOR","enum":false}},{"configDocKey":{"type":"boolean","key":".coerce-input-values","additionalKeys":[],"configDoc":"Enables coercing incorrect JSON values to the default property value in the following cases: 1. JSON value is `null` but property type is non-nullable. 2. Property type is an enum type, but JSON value contains unknown enum member.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"coerce-input-values","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COERCE_INPUT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":".encode-defaults","additionalKeys":[],"configDoc":"Specifies whether default values of Kotlin properties should be encoded.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encode-defaults","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCODE_DEFAULTS","enum":false}},{"configDocKey":{"type":"boolean","key":".explicit-nulls","additionalKeys":[],"configDoc":"Specifies whether `null` values should be encoded for nullable properties and must be present in JSON object during decoding.\n\nWhen this flag is disabled properties with `null` values without default are not encoded; during decoding, the absence of a field value is treated as `null` for nullable properties without a default value.\n\n`true` by default.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"explicit-nulls","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXPLICIT_NULLS","enum":false}},{"configDocKey":{"type":"boolean","key":".ignore-unknown-keys","additionalKeys":[],"configDoc":"Specifies whether encounters of unknown properties in the input JSON should be ignored instead of throwing ++[++SerializationException++]++.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-unknown-keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IGNORE_UNKNOWN_KEYS","enum":false}},{"configDocKey":{"type":"boolean","key":".is-lenient","additionalKeys":[],"configDoc":"Removes JSON specification restriction (RFC-4627) and makes parser more liberal to the malformed input. In lenient mode quoted boolean literals, and unquoted string literals are allowed.\n\nIts relaxations can be expanded in the future, so that lenient parser becomes even more permissive to invalid value in the input, replacing them with defaults.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"is-lenient","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_IS_LENIENT","enum":false}},{"configDocKey":{"type":"boolean","key":".pretty-print","additionalKeys":[],"configDoc":"Specifies whether resulting JSON should be pretty-printed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pretty-print","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PRETTY_PRINT","enum":false}},{"configDocKey":{"type":"string","key":".pretty-print-indent","additionalKeys":[],"configDoc":"Specifies indent string to use with ++[++prettyPrint++]++ mode","withinAMap":false,"defaultValue":" ","javaDocSiteLink":"","docMapKey":"pretty-print-indent","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PRETTY_PRINT_INDENT","enum":false}},{"configDocKey":{"type":"boolean","key":".use-alternative-names","additionalKeys":[],"configDoc":"Specifies whether Json instance makes use of ++[++JsonNames++]++ annotation.\n\nDisabling this flag when one does not use ++[++JsonNames++]++ at all may sometimes result in better performance, particularly when a large count of fields is skipped with ++[++ignoreUnknownKeys++]++.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"use-alternative-names","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USE_ALTERNATIVE_NAMES","enum":false}},{"configDocKey":{"type":"boolean","key":".use-array-polymorphism","additionalKeys":[],"configDoc":"Switches polymorphic serialization to the default array format. This is an option for legacy JSON format and should not be generally used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-array-polymorphism","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_USE_ARRAY_POLYMORPHISM","enum":false}},{"configDocKey":{"type":"string","key":".naming-strategy","additionalKeys":[],"configDoc":"Specifies the `JsonNamingStrategy` that should be used for all properties in classes for serialization and deserialization. This strategy is applied for all entities that have `StructureKind.CLASS`.\n\n\n\n`null` by default.\n\n\n\nThis element can be one of two things:\n\n . the fully qualified class name of a type implements the `NamingStrategy` interface and has a no-arg constructor\n - a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"boolean","key":".decode-enums-case-insensitive","additionalKeys":[],"configDoc":"Specifies if the enum values should be decoded case insensitively.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"decode-enums-case-insensitive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DECODE_ENUMS_CASE_INSENSITIVE","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-trailing-comma","additionalKeys":[],"configDoc":"Specifies if trailing comma is allowed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-trailing-comma","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_TRAILING_COMMA","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-comments","additionalKeys":[],"configDoc":"Allows parser to accept C/Java-style comments in JSON input.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-comments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALLOW_COMMENTS","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.JKSKeyStoreConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.JKSKeyStoreConfig new file mode 100644 index 00000000000..7193a477843 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.JKSKeyStoreConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".path","additionalKeys":[],"configDoc":"Path to the keystore file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROVIDER","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.JKSTrustStoreConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.JKSTrustStoreConfig new file mode 100644 index 00000000000..8b5138b0556 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.JKSTrustStoreConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".path","additionalKeys":[],"configDoc":"Path to the trust store file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".alias","additionalKeys":[],"configDoc":"Alias of the key in the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROVIDER","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.KeyStoreConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.KeyStoreConfig new file mode 100644 index 00000000000..efc9a18179f --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.KeyStoreConfig @@ -0,0 +1 @@ +[{"configDocSection":{"name":".pem","optional":true,"withinAMap":false,"sectionDetails":"== Configures the PEM key/certificate pair","sectionDetailsTitle":"Configures the PEM key/certificate pair","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.PemKeyCertConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".pem.\"key-certs\".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PEM__KEY_CERTS__KEY","enum":false}},{"configDocKey":{"type":"path","key":".pem.\"key-certs\".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PEM__KEY_CERTS__CERT","enum":false}},{"configDocKey":{"type":"string","key":".pem.order","additionalKeys":[],"configDoc":"The order of the key/cert files, based on the names in the `keyCerts` map.\n\nBy default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PEM_ORDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".p12","optional":true,"withinAMap":false,"sectionDetails":"== Configure the PKCS12 key store","sectionDetailsTitle":"Configure the PKCS12 key store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.P12KeyStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".p12.path","additionalKeys":[],"configDoc":"Path to the key store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".p12.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".p12.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".p12.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".p12.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".jks","optional":true,"withinAMap":false,"sectionDetails":"== Configure the JKS key store","sectionDetailsTitle":"Configure the JKS key store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.JKSKeyStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".jks.path","additionalKeys":[],"configDoc":"Path to the keystore file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".jks.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".jks.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".jks.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".jks.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI).\n\nServer Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios.\n\nWith this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.\n\nWhen configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SNI","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".credentials-provider","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.KeyStoreCredentialProviderConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":".credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":".credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store password.\n\nIf the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":".credentials-provider.alias-password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store alias password.\n\nIf the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store.","withinAMap":false,"defaultValue":"alias-password","javaDocSiteLink":"","docMapKey":"alias-password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.KeyStoreCredentialProviderConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.KeyStoreCredentialProviderConfig new file mode 100644 index 00000000000..55ba73264f2 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.KeyStoreCredentialProviderConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"string","key":".name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAME","enum":false}},{"configDocKey":{"type":"string","key":".bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":".password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store password.\n\nIf the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":".alias-password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store alias password.\n\nIf the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store.","withinAMap":false,"defaultValue":"alias-password","javaDocSiteLink":"","docMapKey":"alias-password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS_PASSWORD_KEY","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.P12KeyStoreConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.P12KeyStoreConfig new file mode 100644 index 00000000000..5190c79e3c2 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.P12KeyStoreConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".path","additionalKeys":[],"configDoc":"Path to the key store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROVIDER","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.P12TrustStoreConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.P12TrustStoreConfig new file mode 100644 index 00000000000..fd6e58f66df --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.P12TrustStoreConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".path","additionalKeys":[],"configDoc":"Path to the trust store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".alias","additionalKeys":[],"configDoc":"Alias of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROVIDER","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemCertsConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemCertsConfig new file mode 100644 index 00000000000..121320bb438 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemCertsConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".certs","additionalKeys":[],"configDoc":"List of the trusted cert paths (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTS","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemCertsConfig.KeyCertConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemCertsConfig.KeyCertConfig new file mode 100644 index 00000000000..537fee5b030 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemCertsConfig.KeyCertConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY","enum":false}},{"configDocKey":{"type":"path","key":".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERT","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemKeyCertConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemKeyCertConfig new file mode 100644 index 00000000000..d88c7c67eb4 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemKeyCertConfig @@ -0,0 +1 @@ +[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".\"key-certs\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.PemKeyCertConfig.KeyCertConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"path","key":".\"key-certs\".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"__KEY_CERTS__KEY","enum":false}},{"configDocKey":{"type":"path","key":".\"key-certs\".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"__KEY_CERTS__CERT","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".order","additionalKeys":[],"configDoc":"The order of the key/cert files, based on the names in the `keyCerts` map.\n\nBy default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ORDER","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemKeyCertConfig.KeyCertConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemKeyCertConfig.KeyCertConfig new file mode 100644 index 00000000000..537fee5b030 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.PemKeyCertConfig.KeyCertConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"path","key":".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY","enum":false}},{"configDocKey":{"type":"path","key":".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERT","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TlsBucketConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TlsBucketConfig new file mode 100644 index 00000000000..f1a312b9ad0 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TlsBucketConfig @@ -0,0 +1 @@ +[{"configDocSection":{"name":".key-store","optional":true,"withinAMap":false,"sectionDetails":"== The key store configuration\n\nKey stores are used to store private keys and their associated X.509 certificate chains. For example, for `HTTPS`, it stores the server's private key and the server's certificate. The certificate is used to prove the server's identity to the client.","sectionDetailsTitle":"The key store configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.KeyStoreConfig","showSection":true,"configDocItems":[{"configDocSection":{"name":".key-store.pem","optional":true,"withinAMap":false,"sectionDetails":"== Configures the PEM key/certificate pair","sectionDetailsTitle":"Configures the PEM key/certificate pair","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.PemKeyCertConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".key-store.pem.\"key-certs\".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_PEM__KEY_CERTS__KEY","enum":false}},{"configDocKey":{"type":"path","key":".key-store.pem.\"key-certs\".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_PEM__KEY_CERTS__CERT","enum":false}},{"configDocKey":{"type":"string","key":".key-store.pem.order","additionalKeys":[],"configDoc":"The order of the key/cert files, based on the names in the `keyCerts` map.\n\nBy default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_PEM_ORDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".key-store.p12","optional":true,"withinAMap":false,"sectionDetails":"== Configure the PKCS12 key store","sectionDetailsTitle":"Configure the PKCS12 key store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.P12KeyStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".key-store.p12.path","additionalKeys":[],"configDoc":"Path to the key store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".key-store.p12.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".key-store.p12.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".key-store.p12.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_P12_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".key-store.p12.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_P12_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".key-store.jks","optional":true,"withinAMap":false,"sectionDetails":"== Configure the JKS key store","sectionDetailsTitle":"Configure the JKS key store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.JKSKeyStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".key-store.jks.path","additionalKeys":[],"configDoc":"Path to the keystore file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".key-store.jks.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".key-store.jks.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".key-store.jks.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_JKS_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".key-store.jks.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_JKS_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".key-store.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI).\n\nServer Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios.\n\nWith this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.\n\nWhen configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_SNI","enum":false}},{"configDocKey":{"type":"string","key":".key-store.credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":".key-store.credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":".key-store.credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store password.\n\nIf the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":".key-store.credentials-provider.alias-password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store alias password.\n\nIf the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store.","withinAMap":false,"defaultValue":"alias-password","javaDocSiteLink":"","docMapKey":"alias-password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".trust-store","optional":true,"withinAMap":false,"sectionDetails":"== The trust store configuration\n\nTrust stores are used to store certificates from trusted entities. For example, for `HTTPS`, it stores the certificate authorities that are trusted by the server. The server uses the trust store to verify the client's certificate when mTLS (client authentication) is enabled.","sectionDetailsTitle":"The trust store configuration","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.TrustStoreConfig","showSection":true,"configDocItems":[{"configDocSection":{"name":".trust-store.pem","optional":true,"withinAMap":false,"sectionDetails":"== Configures the list of trusted certificates","sectionDetailsTitle":"Configures the list of trusted certificates","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.PemCertsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".trust-store.pem.certs","additionalKeys":[],"configDoc":"List of the trusted cert paths (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_PEM_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".trust-store.p12","optional":true,"withinAMap":false,"sectionDetails":"== Configure the PKCS12 trust store","sectionDetailsTitle":"Configure the PKCS12 trust store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.P12TrustStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".trust-store.p12.path","additionalKeys":[],"configDoc":"Path to the trust store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.p12.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.p12.alias","additionalKeys":[],"configDoc":"Alias of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.p12.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_P12_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".trust-store.jks","optional":true,"withinAMap":false,"sectionDetails":"== Configure the JKS trust store","sectionDetailsTitle":"Configure the JKS trust store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.JKSTrustStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".trust-store.jks.path","additionalKeys":[],"configDoc":"Path to the trust store file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.jks.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.jks.alias","additionalKeys":[],"configDoc":"Alias of the key in the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.jks.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_JKS_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".trust-store.credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":".trust-store.credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the trust store password.\n\nIf the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".cipher-suites","additionalKeys":[],"configDoc":"Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers.\n\nWhen suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":".protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.\n\nAlso, setting this replaces the default list of protocols.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".handshake-timeout","additionalKeys":[],"configDoc":"The timeout for the TLS handshake phase.\n\nIf not set, it defaults to 10 seconds.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"handshake-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HANDSHAKE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":".alpn","additionalKeys":[],"configDoc":"Enables the Application-Layer Protocol Negotiation (ALPN).\n\nApplication-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ALPN","enum":false}},{"configDocKey":{"type":"path","key":".certificate-revocation-list","additionalKeys":[],"configDoc":"Sets the list of revoked certificates (paths to files).\n\nA Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore.\n\nTwo formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-revocation-list","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTIFICATE_REVOCATION_LIST","enum":false}},{"configDocKey":{"type":"boolean","key":".trust-all","additionalKeys":[],"configDoc":"If set to `true`, the server trusts all certificates.\n\nThis is useful for testing, but should not be used in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":".hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.\n\nIf set to `NONE`, it does not verify the hostname.\n\nIf not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be \"HTTPS\". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to \"HTTPS\" or \"LDAPS\".","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TrustStoreConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TrustStoreConfig new file mode 100644 index 00000000000..561d6888749 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TrustStoreConfig @@ -0,0 +1 @@ +[{"configDocSection":{"name":".pem","optional":true,"withinAMap":false,"sectionDetails":"== Configures the list of trusted certificates","sectionDetailsTitle":"Configures the list of trusted certificates","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.PemCertsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".pem.certs","additionalKeys":[],"configDoc":"List of the trusted cert paths (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PEM_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".p12","optional":true,"withinAMap":false,"sectionDetails":"== Configure the PKCS12 trust store","sectionDetailsTitle":"Configure the PKCS12 trust store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.P12TrustStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".p12.path","additionalKeys":[],"configDoc":"Path to the trust store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".p12.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".p12.alias","additionalKeys":[],"configDoc":"Alias of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".p12.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_P12_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".jks","optional":true,"withinAMap":false,"sectionDetails":"== Configure the JKS trust store","sectionDetailsTitle":"Configure the JKS trust store","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.JKSTrustStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":".jks.path","additionalKeys":[],"configDoc":"Path to the trust store file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".jks.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":".jks.alias","additionalKeys":[],"configDoc":"Alias of the key in the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":".jks.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_JKS_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".credentials-provider","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.tls.runtime.config.TrustStoreCredentialProviderConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":".credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":".credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the trust store password.\n\nIf the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TrustStoreCredentialProviderConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TrustStoreCredentialProviderConfig new file mode 100644 index 00000000000..4450fb36b22 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.tls.runtime.config.TrustStoreCredentialProviderConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"string","key":".name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_NAME","enum":false}},{"configDocKey":{"type":"string","key":".bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":".password-key","additionalKeys":[],"configDoc":"The key used to retrieve the trust store password.\n\nIf the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD_KEY","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.vertx.http.runtime.AuthRuntimeConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.vertx.http.runtime.AuthRuntimeConfig index 0918908ef76..b2c4a174bb1 100644 --- a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.vertx.http.runtime.AuthRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.vertx.http.runtime.AuthRuntimeConfig @@ -1 +1 @@ -[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".permission.\"permissions\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.PolicyMappingConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".permission.\"permissions\".enabled","additionalKeys":[],"configDoc":"Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".policy","additionalKeys":[],"configDoc":"The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__POLICY","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".methods","additionalKeys":[],"configDoc":"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.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__METHODS","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".paths","additionalKeys":[],"configDoc":"The paths that this permission check applies to. If the path ends in /++*++ then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__PATHS","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".auth-mechanism","additionalKeys":[],"configDoc":"Path specific authentication mechanism which must be used to authenticate a user. It needs to match `HttpCredentialTransport` authentication scheme such as 'basic', 'bearer', 'form', etc.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-mechanism","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__AUTH_MECHANISM","enum":false}},{"configDocKey":{"type":"boolean","key":".permission.\"permissions\".shared","additionalKeys":[],"configDoc":"Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__SHARED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo","key":".permission.\"permissions\".applies-to","additionalKeys":[],"configDoc":"Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.","withinAMap":true,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"applies-to","configPhase":"BUILD_TIME","acceptedValues":["tooltip:all[Apply on all matching paths.]","tooltip:jaxrs[Declares that a permission check must only be applied on the Jakarta REST request paths. Use this option to delay the permission check if an authentication mechanism is chosen with an annotation on the matching Jakarta REST endpoint. This option must be set if the following REST endpoint annotations are used: - `io.quarkus.oidc.Tenant` annotation which selects an OIDC authentication mechanism with a tenant identifier - `io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` which selects the Basic authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` which selects the Form-based authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` which selects the mTLS authentication mechanism - `io.quarkus.security.webauthn.WebAuthn` which selects the WebAuth authentication mechanism - `io.quarkus.oidc.BearerTokenAuthentication` which selects the OpenID Connect Bearer token authentication mechanism - `io.quarkus.oidc.AuthorizationCodeFlow` which selects the OpenID Connect Code authentication mechanism]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__APPLIES_TO","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".policy.\"role-policy\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.PolicyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".policy.\"role-policy\".roles-allowed","additionalKeys":[],"configDoc":"The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.","withinAMap":true,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"roles-allowed","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__ROLES_ALLOWED","enum":false}},{"configDocKey":{"type":"java.util.List","key":".policy.\"role-policy\".roles.\"role-name\"","additionalKeys":[],"configDoc":"Add roles granted to the `SecurityIdentity` based on the roles that the `SecurityIdentity` already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.util.List","key":".policy.\"role-policy\".permissions.\"role-name\"","additionalKeys":[],"configDoc":"Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".policy.\"role-policy\".permission-class","additionalKeys":[],"configDoc":"Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String++[]++`). Permission class must be registered for reflection if you run your application in a native mode.","withinAMap":true,"defaultValue":"io.quarkus.security.StringPermission","javaDocSiteLink":"","docMapKey":"permission-class","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__PERMISSION_CLASS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.util.List","key":".roles-mapping.\"role-name\"","additionalKeys":[],"configDoc":"Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.\n\nFor example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ROLES_MAPPING__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"path","key":".certificate-role-properties","additionalKeys":[],"configDoc":"Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.\n\nProperties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-role-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTIFICATE_ROLE_PROPERTIES","enum":false}},{"configDocKey":{"type":"string","key":".realm","additionalKeys":[],"configDoc":"The authentication realm","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REALM","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".form","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.FormAuthRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".form.login-page","additionalKeys":[],"configDoc":"The login page. Redirect to login page can be disabled by setting `quarkus.http.auth.form.login-page=`.","withinAMap":false,"defaultValue":"/login.html","javaDocSiteLink":"","docMapKey":"login-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_LOGIN_PAGE","enum":false}},{"configDocKey":{"type":"string","key":".form.username-parameter","additionalKeys":[],"configDoc":"The username field name.","withinAMap":false,"defaultValue":"j_username","javaDocSiteLink":"","docMapKey":"username-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_USERNAME_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":".form.password-parameter","additionalKeys":[],"configDoc":"The password field name.","withinAMap":false,"defaultValue":"j_password","javaDocSiteLink":"","docMapKey":"password-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_PASSWORD_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":".form.error-page","additionalKeys":[],"configDoc":"The error page. Redirect to error page can be disabled by setting `quarkus.http.auth.form.error-page=`.","withinAMap":false,"defaultValue":"/error.html","javaDocSiteLink":"","docMapKey":"error-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_ERROR_PAGE","enum":false}},{"configDocKey":{"type":"string","key":".form.landing-page","additionalKeys":[],"configDoc":"The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting `quarkus.http.auth.form.landing-page=`.","withinAMap":false,"defaultValue":"/index.html","javaDocSiteLink":"","docMapKey":"landing-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_LANDING_PAGE","enum":false}},{"configDocKey":{"type":"string","key":".form.location-cookie","additionalKeys":[],"configDoc":"Option to control the name of the cookie used to redirect the user back to the location they want to access.","withinAMap":false,"defaultValue":"quarkus-redirect-location","javaDocSiteLink":"","docMapKey":"location-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_LOCATION_COOKIE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".form.timeout","additionalKeys":[],"configDoc":"The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.","withinAMap":false,"defaultValue":"PT30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".form.new-cookie-interval","additionalKeys":[],"configDoc":"How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as \"renewal-timeout\". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user's last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.","withinAMap":false,"defaultValue":"PT1M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"new-cookie-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_NEW_COOKIE_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":".form.cookie-name","additionalKeys":[],"configDoc":"The cookie that is used to store the persistent session","withinAMap":false,"defaultValue":"quarkus-credential","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_COOKIE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".form.cookie-path","additionalKeys":[],"configDoc":"The cookie path for the session and location cookies.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_COOKIE_PATH","enum":false}},{"configDocKey":{"type":"boolean","key":".form.http-only-cookie","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http-only-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_HTTP_ONLY_COOKIE","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.FormAuthRuntimeConfig.CookieSameSite","key":".form.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session and location cookies.","withinAMap":false,"defaultValue":"strict","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"BUILD_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_COOKIE_SAME_SITE","enum":true}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".permission.\"permissions\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.PolicyMappingConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".permission.\"permissions\".enabled","additionalKeys":[],"configDoc":"Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".policy","additionalKeys":[],"configDoc":"The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__POLICY","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".methods","additionalKeys":[],"configDoc":"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.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__METHODS","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".paths","additionalKeys":[],"configDoc":"The paths that this permission check applies to. If the path ends in /++*++ then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__PATHS","enum":false}},{"configDocKey":{"type":"string","key":".permission.\"permissions\".auth-mechanism","additionalKeys":[],"configDoc":"Path specific authentication mechanism which must be used to authenticate a user. It needs to match `HttpCredentialTransport` authentication scheme such as 'basic', 'bearer', 'form', etc.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-mechanism","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__AUTH_MECHANISM","enum":false}},{"configDocKey":{"type":"boolean","key":".permission.\"permissions\".shared","additionalKeys":[],"configDoc":"Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__SHARED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo","key":".permission.\"permissions\".applies-to","additionalKeys":[],"configDoc":"Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.","withinAMap":true,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"applies-to","configPhase":"BUILD_TIME","acceptedValues":["tooltip:all[Apply on all matching paths.]","tooltip:jaxrs[Declares that a permission check must only be applied on the Jakarta REST request paths. Use this option to delay the permission check if an authentication mechanism is chosen with an annotation on the matching Jakarta REST endpoint. This option must be set if the following REST endpoint annotations are used: - `io.quarkus.oidc.Tenant` annotation which selects an OIDC authentication mechanism with a tenant identifier - `io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` which selects the Basic authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` which selects the Form-based authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` which selects the mTLS authentication mechanism - `io.quarkus.security.webauthn.WebAuthn` which selects the WebAuth authentication mechanism - `io.quarkus.oidc.BearerTokenAuthentication` which selects the OpenID Connect Bearer token authentication mechanism - `io.quarkus.oidc.AuthorizationCodeFlow` which selects the OpenID Connect Code authentication mechanism]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PERMISSION__PERMISSIONS__APPLIES_TO","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".policy.\"role-policy\"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.PolicyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".policy.\"role-policy\".roles-allowed","additionalKeys":[],"configDoc":"The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.","withinAMap":true,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"roles-allowed","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__ROLES_ALLOWED","enum":false}},{"configDocKey":{"type":"java.util.List","key":".policy.\"role-policy\".roles.\"role-name\"","additionalKeys":[],"configDoc":"Add roles granted to the `SecurityIdentity` based on the roles that the `SecurityIdentity` already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.util.List","key":".policy.\"role-policy\".permissions.\"role-name\"","additionalKeys":[],"configDoc":"Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".policy.\"role-policy\".permission-class","additionalKeys":[],"configDoc":"Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String++[]++`). Permission class must be registered for reflection if you run your application in a native mode.","withinAMap":true,"defaultValue":"io.quarkus.security.StringPermission","javaDocSiteLink":"","docMapKey":"permission-class","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POLICY__ROLE_POLICY__PERMISSION_CLASS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.util.List","key":".roles-mapping.\"role-name\"","additionalKeys":[],"configDoc":"Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.\n\nFor example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ROLES_MAPPING__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":".certificate-role-attribute","additionalKeys":[],"configDoc":"Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:\n\n - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.\n - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.\n - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).\n - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`","withinAMap":false,"defaultValue":"CN","javaDocSiteLink":"","docMapKey":"certificate-role-attribute","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTIFICATE_ROLE_ATTRIBUTE","enum":false}},{"configDocKey":{"type":"path","key":".certificate-role-properties","additionalKeys":[],"configDoc":"Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.\n\nProperties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-role-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTIFICATE_ROLE_PROPERTIES","enum":false}},{"configDocKey":{"type":"string","key":".realm","additionalKeys":[],"configDoc":"The authentication realm","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_REALM","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".form","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.FormAuthRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".form.login-page","additionalKeys":[],"configDoc":"The login page. Redirect to login page can be disabled by setting `quarkus.http.auth.form.login-page=`.","withinAMap":false,"defaultValue":"/login.html","javaDocSiteLink":"","docMapKey":"login-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_LOGIN_PAGE","enum":false}},{"configDocKey":{"type":"string","key":".form.username-parameter","additionalKeys":[],"configDoc":"The username field name.","withinAMap":false,"defaultValue":"j_username","javaDocSiteLink":"","docMapKey":"username-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_USERNAME_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":".form.password-parameter","additionalKeys":[],"configDoc":"The password field name.","withinAMap":false,"defaultValue":"j_password","javaDocSiteLink":"","docMapKey":"password-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_PASSWORD_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":".form.error-page","additionalKeys":[],"configDoc":"The error page. Redirect to error page can be disabled by setting `quarkus.http.auth.form.error-page=`.","withinAMap":false,"defaultValue":"/error.html","javaDocSiteLink":"","docMapKey":"error-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_ERROR_PAGE","enum":false}},{"configDocKey":{"type":"string","key":".form.landing-page","additionalKeys":[],"configDoc":"The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting `quarkus.http.auth.form.landing-page=`.","withinAMap":false,"defaultValue":"/index.html","javaDocSiteLink":"","docMapKey":"landing-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_LANDING_PAGE","enum":false}},{"configDocKey":{"type":"string","key":".form.location-cookie","additionalKeys":[],"configDoc":"Option to control the name of the cookie used to redirect the user back to the location they want to access.","withinAMap":false,"defaultValue":"quarkus-redirect-location","javaDocSiteLink":"","docMapKey":"location-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_LOCATION_COOKIE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".form.timeout","additionalKeys":[],"configDoc":"The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.","withinAMap":false,"defaultValue":"PT30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".form.new-cookie-interval","additionalKeys":[],"configDoc":"How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as \"renewal-timeout\". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user's last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.","withinAMap":false,"defaultValue":"PT1M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"new-cookie-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_NEW_COOKIE_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":".form.cookie-name","additionalKeys":[],"configDoc":"The cookie that is used to store the persistent session","withinAMap":false,"defaultValue":"quarkus-credential","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_COOKIE_NAME","enum":false}},{"configDocKey":{"type":"string","key":".form.cookie-path","additionalKeys":[],"configDoc":"The cookie path for the session and location cookies.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_COOKIE_PATH","enum":false}},{"configDocKey":{"type":"boolean","key":".form.http-only-cookie","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http-only-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_HTTP_ONLY_COOKIE","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.FormAuthRuntimeConfig.CookieSameSite","key":".form.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session and location cookies.","withinAMap":false,"defaultValue":"strict","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"BUILD_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FORM_COOKIE_SAME_SITE","enum":true}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.websockets.next.TrafficLoggingConfig b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.websockets.next.TrafficLoggingConfig new file mode 100644 index 00000000000..b80dcfe148d --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.websockets.next.TrafficLoggingConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":".text-payload-limit","additionalKeys":[],"configDoc":"The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"text-payload-limit","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TEXT_PAYLOAD_LIMIT","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig.Security b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig.Security new file mode 100644 index 00000000000..daf0ffbce33 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig.Security @@ -0,0 +1 @@ +[{"configDocKey":{"type":"string","key":".auth-failure-redirect-url","additionalKeys":[],"configDoc":"Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-failure-redirect-url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_AUTH_FAILURE_REDIRECT_URL","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.deployment.ContainerImageConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.deployment.ContainerImageConfig index 437064979a3..f4bbb87f96a 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.deployment.ContainerImageConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.deployment.ContainerImageConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.container-image.group","additionalKeys":[],"configDoc":"The group the container image will be part of","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_GROUP","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.name","additionalKeys":[],"configDoc":"The name of the container image. If not set defaults to the application name","withinAMap":false,"defaultValue":"${quarkus.application.name:unset}","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.tag","additionalKeys":[],"configDoc":"The tag of the container image. If not set defaults to the application version","withinAMap":false,"defaultValue":"${quarkus.application.version:latest}","javaDocSiteLink":"","docMapKey":"tag","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_TAG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.additional-tags","additionalKeys":[],"configDoc":"Additional tags of the container image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-tags","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_ADDITIONAL_TAGS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.container-image.labels.\"label-name\"","additionalKeys":[],"configDoc":"Custom labels to add to the generated image.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"label-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_LABELS__LABEL_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.registry","additionalKeys":[],"configDoc":"The container registry to use","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"registry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_REGISTRY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.image","additionalKeys":[],"configDoc":"Represents the entire image string. If set, then `group`, `name`, `registry`, `tags`, `additionalTags` are ignored","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.username","additionalKeys":[],"configDoc":"The username to use to authenticate with the registry where the built image will be pushed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.password","additionalKeys":[],"configDoc":"The password to use to authenticate with the registry where the built image will be pushed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.container-image.insecure","additionalKeys":[],"configDoc":"Whether or not insecure registries are allowed","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"insecure","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_INSECURE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.container-image.build","additionalKeys":[],"configDoc":"Whether or not a image build will be performed.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"build","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_BUILD","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.container-image.push","additionalKeys":[],"configDoc":"Whether or not an image push will be performed.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"push","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_PUSH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.builder","additionalKeys":[],"configDoc":"The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"builder","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_BUILDER","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.container-image.group","additionalKeys":[],"configDoc":"The group the container image will be part of","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_GROUP","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.name","additionalKeys":[],"configDoc":"The name of the container image. If not set defaults to the application name","withinAMap":false,"defaultValue":"${quarkus.application.name:unset}","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.tag","additionalKeys":[],"configDoc":"The tag of the container image. If not set defaults to the application version","withinAMap":false,"defaultValue":"${quarkus.application.version:latest}","javaDocSiteLink":"","docMapKey":"tag","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_TAG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.additional-tags","additionalKeys":[],"configDoc":"Additional tags of the container image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-tags","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_ADDITIONAL_TAGS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.container-image.labels.\"label-name\"","additionalKeys":[],"configDoc":"Custom labels to add to the generated image.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"label-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_LABELS__LABEL_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.registry","additionalKeys":[],"configDoc":"The container registry to use","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"registry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_REGISTRY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.image","additionalKeys":[],"configDoc":"Represents the entire image string. If set, then `group`, `name`, `registry`, `tags`, `additionalTags` are ignored","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.username","additionalKeys":[],"configDoc":"The username to use to authenticate with the registry where the built image will be pushed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.password","additionalKeys":[],"configDoc":"The password to use to authenticate with the registry where the built image will be pushed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.container-image.insecure","additionalKeys":[],"configDoc":"Whether or not insecure registries are allowed","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"insecure","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_INSECURE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.container-image.build","additionalKeys":[],"configDoc":"Whether or not a image build will be performed.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"build","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_BUILD","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.container-image.push","additionalKeys":[],"configDoc":"Whether or not an image push will be performed.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"push","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_PUSH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.container-image.builder","additionalKeys":[],"configDoc":"The name of the container image extension to use (e.g. docker, podman, jib, s2i). The option will be used in case multiple extensions are present.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"builder","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.container-image","since":null,"environmentVariable":"QUARKUS_CONTAINER_IMAGE_BUILDER","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.docker.deployment.DockerConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.docker.deployment.DockerConfig index a2cbec487cf..1585f2c7ca0 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.docker.deployment.DockerConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.docker.deployment.DockerConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-jvm-path","additionalKeys":[],"configDoc":"Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.","withinAMap":false,"defaultValue":"src/main/docker/Dockerfile.jvm","javaDocSiteLink":"","docMapKey":"dockerfile-jvm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_DOCKERFILE_JVM_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-native-path","additionalKeys":[],"configDoc":"Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.","withinAMap":false,"defaultValue":"src/main/docker/Dockerfile.native","javaDocSiteLink":"","docMapKey":"dockerfile-native-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.docker.build-args.\"arg-name\"","additionalKeys":[],"configDoc":"Build args passed to docker via `--build-arg`","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"arg-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.cache-from","additionalKeys":[],"configDoc":"Images to consider as cache sources. Values are passed to `docker build` via the `cache-from` option","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cache-from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_CACHE_FROM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.network","additionalKeys":[],"configDoc":"The networking mode for the RUN instructions during build","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_NETWORK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.executable-name","additionalKeys":[],"configDoc":"Name of binary used to execute the docker commands. This setting can override the global container runtime detection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"executable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_EXECUTABLE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.additional-args","additionalKeys":[],"configDoc":"Additional arbitrary arguments passed to the executable when building the container image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_ADDITIONAL_ARGS","enum":false}},{"configDocSection":{"name":"quarkus.docker.buildx","optional":false,"withinAMap":false,"sectionDetails":"= Configuration for Docker Buildx options","sectionDetailsTitle":"Configuration for Docker Buildx options","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.docker","configGroupType":"io.quarkus.container.image.docker.deployment.DockerConfig.DockerBuildxConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.platform","additionalKeys":[],"configDoc":"Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++platform","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"platform","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILDX_PLATFORM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.output","additionalKeys":[],"configDoc":"Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"output","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILDX_OUTPUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.progress","additionalKeys":[],"configDoc":"Set type of progress output (`auto`, `plain`, `tty`). Use `plain` to show container output (default “`auto`”). See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++progress","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"progress","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILDX_PROGRESS","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-jvm-path","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"dockerfile-jvm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_DOCKERFILE_JVM_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-native-path","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"dockerfile-native-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.docker.build-args.\"build-args\"","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"build-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.cache-from","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cache-from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_CACHE_FROM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.network","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_NETWORK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.executable-name","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"executable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_EXECUTABLE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.additional-args","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_ADDITIONAL_ARGS","enum":false}},{"configDocSection":{"name":"quarkus.docker.buildx","optional":false,"withinAMap":false,"sectionDetails":"= Configuration for Docker Buildx options","sectionDetailsTitle":"Configuration for Docker Buildx options","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.docker","configGroupType":"io.quarkus.container.image.docker.deployment.DockerConfig.DockerBuildxConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.platform","additionalKeys":[],"configDoc":"Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++platform","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"platform","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILDX_PLATFORM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.output","additionalKeys":[],"configDoc":"Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"output","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILDX_OUTPUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.progress","additionalKeys":[],"configDoc":"Set type of progress output (`auto`, `plain`, `tty`). Use `plain` to show container output (default “`auto`”). See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++progress","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"progress","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","since":null,"environmentVariable":"QUARKUS_DOCKER_BUILDX_PROGRESS","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.podman.deployment.PodmanConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.podman.deployment.PodmanConfig new file mode 100644 index 00000000000..c1505c553cb --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.container.image.podman.deployment.PodmanConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"string","key":"quarkus.podman.dockerfile-jvm-path","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"dockerfile-jvm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_DOCKERFILE_JVM_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.podman.dockerfile-native-path","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"dockerfile-native-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.podman.build-args.\"build-args\"","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"build-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.podman.cache-from","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cache-from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_CACHE_FROM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.podman.network","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_NETWORK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.podman.executable-name","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"executable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_EXECUTABLE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.podman.additional-args","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_ADDITIONAL_ARGS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.podman.platform","additionalKeys":[],"configDoc":"Which platform(s) to target during the build. See https://docs.podman.io/en/latest/markdown/podman-build.1.html++#++platform-os-arch-variant","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"platform","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.podman","since":null,"environmentVariable":"QUARKUS_PODMAN_PLATFORM","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.dev.devservices.GlobalDevServicesConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.dev.devservices.GlobalDevServicesConfig index f1224308dd0..aca589775df 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.dev.devservices.GlobalDevServicesConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.dev.devservices.GlobalDevServicesConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.devservices.enabled","additionalKeys":[],"configDoc":"Global flag that can be used to disable all Dev Services. If this is set to false then Dev Services will not be used.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.devservices","since":null,"environmentVariable":"QUARKUS_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.devservices.launch-on-shared-network","additionalKeys":[],"configDoc":"Global flag that can be used to force the attachmment of Dev Services to shared netxork. Default is false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"launch-on-shared-network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.devservices","since":null,"environmentVariable":"QUARKUS_DEVSERVICES_LAUNCH_ON_SHARED_NETWORK","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.devservices.timeout","additionalKeys":[],"configDoc":"The timeout for starting a container","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.devservices","since":null,"environmentVariable":"QUARKUS_DEVSERVICES_TIMEOUT","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.devservices.enabled","additionalKeys":[],"configDoc":"Global flag that can be used to disable all Dev Services. If this is set to false then Dev Services will not be used.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.devservices","since":null,"environmentVariable":"QUARKUS_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.devservices.launch-on-shared-network","additionalKeys":[],"configDoc":"Global flag that can be used to force the attachmment of Dev Services to shared network. Default is false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"launch-on-shared-network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.devservices","since":null,"environmentVariable":"QUARKUS_DEVSERVICES_LAUNCH_ON_SHARED_NETWORK","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.devservices.timeout","additionalKeys":[],"configDoc":"The timeout for starting a container","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.devservices","since":null,"environmentVariable":"QUARKUS_DEVSERVICES_TIMEOUT","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.pkg.NativeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.pkg.NativeConfig index d24e00e56a4..ea0f4eef216 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.pkg.NativeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.deployment.pkg.NativeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.native.enabled","additionalKeys":[],"configDoc":"Set to enable native-image building using GraalVM.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.sources-only","additionalKeys":[],"configDoc":"Set to prevent the native-image process from actually building the native image.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sources-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_SOURCES_ONLY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.additional-build-args","additionalKeys":[],"configDoc":"Comma-separated, additional arguments to pass to the build process. If an argument includes the `,` symbol, it needs to be escaped, e.g. `++\\\\++,`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-build-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-http-url-handler","additionalKeys":[],"configDoc":"If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-http-url-handler","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-https-url-handler","additionalKeys":[],"configDoc":"If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-https-url-handler","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.headless","additionalKeys":[],"configDoc":"The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"headless","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_HEADLESS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.native.file-encoding","additionalKeys":[],"configDoc":"Defines the file encoding as in `-Dfile.encoding=...`. Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"file-encoding","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_FILE_ENCODING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.add-all-charsets","additionalKeys":[],"configDoc":"If all character sets should be added to the native image. This increases image size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"add-all-charsets","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ADD_ALL_CHARSETS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.graalvm-home","additionalKeys":[],"configDoc":"The location of the Graal distribution","withinAMap":false,"defaultValue":"${GRAALVM_HOME:}","javaDocSiteLink":"","docMapKey":"graalvm-home","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_GRAALVM_HOME","enum":false}},{"configDocKey":{"type":"java.io.File","key":"quarkus.native.java-home","additionalKeys":[],"configDoc":"The location of the JDK","withinAMap":false,"defaultValue":"${java.home}","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/io/File.html","docMapKey":"java-home","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_JAVA_HOME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.native-image-xmx","additionalKeys":[],"configDoc":"The maximum Java heap to be used during the native image generation","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-image-xmx","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_NATIVE_IMAGE_XMX","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.debug-build-process","additionalKeys":[],"configDoc":"If the native image build should wait for a debugger to be attached before running. This is an advanced option and is generally only intended for those familiar with GraalVM internals","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"debug-build-process","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_DEBUG_BUILD_PROCESS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.publish-debug-build-process-port","additionalKeys":[],"configDoc":"If the debug port should be published when building with docker and debug-build-process is true","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"publish-debug-build-process-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-isolates","additionalKeys":[],"configDoc":"If isolates should be enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-isolates","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_ISOLATES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-fallback-images","additionalKeys":[],"configDoc":"If a JVM based 'fallback image' should be created if native image fails. This is not recommended, as this is functionally the same as just running the application in a JVM","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-fallback-images","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.auto-service-loader-registration","additionalKeys":[],"configDoc":"If all META-INF/services entries should be automatically registered","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"auto-service-loader-registration","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.dump-proxies","additionalKeys":[],"configDoc":"If the bytecode of all proxies should be dumped for inspection","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"dump-proxies","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_DUMP_PROXIES","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.native.container-build","additionalKeys":[],"configDoc":"If this build should be done using a container runtime. Unless container-runtime is also set, docker will be used by default. If docker is not available or is an alias to podman, podman will be used instead as the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-build","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_CONTAINER_BUILD","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.native.pie","additionalKeys":[],"configDoc":"Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"pie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_PIE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.march","additionalKeys":[],"configDoc":"Generate instructions for a specific machine type. Defaults to `x86-64-v3` on AMD64 and `armv8-a` on AArch64. Use `compatibility` for best compatibility, or `native` for best performance if a native executable is deployed on the same machine or on a machine with the same CPU features. A list of all available machine types is available by executing `native-image -march=list`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"march","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_MARCH","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.remote-container-build","additionalKeys":[],"configDoc":"If this build is done using a remote docker daemon.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"remote-container-build","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.builder-image","additionalKeys":[],"configDoc":"The docker image to use to do the image build. It can be one of `graalvm`, `mandrel`, or the full image path, e.g. `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21`.","withinAMap":false,"defaultValue":"mandrel","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_BUILDER_IMAGE","enum":false}},{"configDocKey":{"type":"io.quarkus.deployment.pkg.NativeConfig.ImagePullStrategy","key":"quarkus.native.builder-image.pull","additionalKeys":[],"configDoc":"The strategy for pulling the builder image during the build.\n\nDefaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated.\n\nUse 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited.\n\nUse 'never' to fail the build if there is no image locally.","withinAMap":false,"defaultValue":"always","javaDocSiteLink":"","docMapKey":"pull","configPhase":"BUILD_TIME","acceptedValues":["`always`","`missing`","`never`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_BUILDER_IMAGE_PULL","enum":true}},{"configDocKey":{"type":"io.quarkus.deployment.util.ContainerRuntimeUtil.ContainerRuntime","key":"quarkus.native.container-runtime","additionalKeys":[],"configDoc":"The container runtime (e.g. docker) that is used to do an image based build. If this is set then a container build is always done.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-runtime","configPhase":"BUILD_TIME","acceptedValues":["`docker`","`docker-rootless`","`wsl`","`wsl-rootless`","`podman`","`podman-rootless`","`unavailable`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_CONTAINER_RUNTIME","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.native.container-runtime-options","additionalKeys":[],"configDoc":"Options to pass to the container runtime","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-runtime-options","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS","enum":false}},{"configDocKey":{"type":"io.quarkus.deployment.pkg.NativeConfig.MonitoringOption","key":"quarkus.native.monitoring","additionalKeys":[],"configDoc":"Enable monitoring various monitoring options. The value should be comma separated.\n\n - `jfr` for JDK flight recorder support\n - `jvmstat` for JVMStat support\n - `heapdump` for heampdump support\n - `jmxclient` for JMX client support (experimental)\n - `jmxserver` for JMX server support (experimental)\n - `all` for all monitoring features","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"monitoring","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_MONITORING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-reports","additionalKeys":[],"configDoc":"If the reports on call paths and included packages/classes/methods should be generated","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-reports","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_REPORTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.report-exception-stack-traces","additionalKeys":[],"configDoc":"If exceptions should be reported with a full stack trace","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"report-exception-stack-traces","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.report-errors-at-runtime","additionalKeys":[],"configDoc":"If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"report-errors-at-runtime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.reuse-existing","additionalKeys":[],"configDoc":"Don't build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"reuse-existing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REUSE_EXISTING","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.resources.includes","additionalKeys":[],"configDoc":"A comma separated list of globs to match resource paths that should be added to the native image.\n\nUse slash (`/`) as a path separator on all platforms. Globs must not start with slash.\n\nBy default, no resources are included.\n\nExample: Given that you have `src/main/resources/ignored.png` and `src/main/resources/foo/selected.png` in your source tree and one of your dependency JARs contains `bar/some.txt` file, with the following configuration\n\n```\nquarkus.native.resources.includes = foo/**,bar/**/*.txt\n```\n\nthe files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included.\n\nSupported glob features Feature Description `++*++` Matches a (possibly empty) sequence of characters that does not contain slash (`/`) `++**++` Matches a (possibly empty) sequence of characters that may contain slash (`/`) `?` Matches one character, but not slash `++[++abc++]++` Matches one character given in the bracket, but not slash `++[++a-z++]++` Matches one character from the range given in the bracket, but not slash `++[++!abc++]++` Matches one character not named in the bracket; does not match slash `++[++a-z++]++` Matches one character outside the range given in the bracket; does not match slash `++{++one,two,three++}++` Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges `++\\++` The escape character\n\nNote that there are three levels of escaping when passing this option via `application.properties`:\n\n . `application.properties` parser\n - MicroProfile Config list converter that splits the comma separated list\n - Glob parser All three levels use backslash (`++\\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape.\n\nNote that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"includes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_RESOURCES_INCLUDES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.resources.excludes","additionalKeys":[],"configDoc":"A comma separated list of globs to match resource paths that should *not* be added to the native image.\n\nUse slash (`/`) as a path separator on all platforms. Globs must not start with slash.\n\nPlease refer to `includes` for details about the glob syntax.\n\nBy default, no resources are excluded.\n\nExample: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration\n\n```\nquarkus.native.resources.includes = **/*.png\nquarkus.native.resources.excludes = foo/**,**/green.png\n```\n\nthe resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excludes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_RESOURCES_EXCLUDES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.debug.enabled","additionalKeys":[],"configDoc":"If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_DEBUG_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-dashboard-dump","additionalKeys":[],"configDoc":"Generate the report files for GraalVM Dashboard.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-dashboard-dump","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.native.compression.level","additionalKeys":[],"configDoc":"The compression level in ++[++1, 10++]++. 10 means _best_.\n\nHigher compression level requires more time to compress the executable.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"level","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.compression.additional-args","additionalKeys":[],"configDoc":"Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.native.enabled","additionalKeys":[],"configDoc":"Set to enable native-image building using GraalVM.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.sources-only","additionalKeys":[],"configDoc":"Set to prevent the native-image process from actually building the native image.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sources-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_SOURCES_ONLY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.additional-build-args","additionalKeys":[],"configDoc":"Comma-separated, additional arguments to pass to the build process. If an argument includes the `,` symbol, it needs to be escaped, e.g. `++\\\\++,`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-build-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-http-url-handler","additionalKeys":[],"configDoc":"If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-http-url-handler","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-https-url-handler","additionalKeys":[],"configDoc":"If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-https-url-handler","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.headless","additionalKeys":[],"configDoc":"The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"headless","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_HEADLESS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.native.file-encoding","additionalKeys":[],"configDoc":"Defines the file encoding as in `-Dfile.encoding=...`. Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"file-encoding","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_FILE_ENCODING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.add-all-charsets","additionalKeys":[],"configDoc":"If all character sets should be added to the native image. This increases image size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"add-all-charsets","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ADD_ALL_CHARSETS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.graalvm-home","additionalKeys":[],"configDoc":"The location of the Graal distribution","withinAMap":false,"defaultValue":"${GRAALVM_HOME:}","javaDocSiteLink":"","docMapKey":"graalvm-home","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_GRAALVM_HOME","enum":false}},{"configDocKey":{"type":"java.io.File","key":"quarkus.native.java-home","additionalKeys":[],"configDoc":"The location of the JDK","withinAMap":false,"defaultValue":"${java.home}","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/io/File.html","docMapKey":"java-home","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_JAVA_HOME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.native-image-xmx","additionalKeys":[],"configDoc":"The maximum Java heap to be used during the native image generation","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-image-xmx","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_NATIVE_IMAGE_XMX","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.debug-build-process","additionalKeys":[],"configDoc":"If the native image build should wait for a debugger to be attached before running. This is an advanced option and is generally only intended for those familiar with GraalVM internals","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"debug-build-process","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_DEBUG_BUILD_PROCESS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.publish-debug-build-process-port","additionalKeys":[],"configDoc":"If the debug port should be published when building with docker and debug-build-process is true","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"publish-debug-build-process-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-isolates","additionalKeys":[],"configDoc":"If isolates should be enabled","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-isolates","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_ISOLATES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-fallback-images","additionalKeys":[],"configDoc":"If a JVM based 'fallback image' should be created if native image fails. This is not recommended, as this is functionally the same as just running the application in a JVM","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-fallback-images","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.auto-service-loader-registration","additionalKeys":[],"configDoc":"If all META-INF/services entries should be automatically registered","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"auto-service-loader-registration","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.dump-proxies","additionalKeys":[],"configDoc":"If the bytecode of all proxies should be dumped for inspection","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"dump-proxies","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_DUMP_PROXIES","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.native.container-build","additionalKeys":[],"configDoc":"If this build should be done using a container runtime. Unless container-runtime is also set, docker will be used by default. If docker is not available or is an alias to podman, podman will be used instead as the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-build","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_CONTAINER_BUILD","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.native.pie","additionalKeys":[],"configDoc":"Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"pie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_PIE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.march","additionalKeys":[],"configDoc":"Generate instructions for a specific machine type. Defaults to `x86-64-v3` on AMD64 and `armv8-a` on AArch64. Use `compatibility` for best compatibility, or `native` for best performance if a native executable is deployed on the same machine or on a machine with the same CPU features. A list of all available machine types is available by executing `native-image -march=list`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"march","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_MARCH","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.remote-container-build","additionalKeys":[],"configDoc":"If this build is done using a remote docker daemon.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"remote-container-build","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.builder-image","additionalKeys":[],"configDoc":"The docker image to use to do the image build. It can be one of `graalvm`, `mandrel`, or the full image path, e.g. `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21`.","withinAMap":false,"defaultValue":"mandrel","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_BUILDER_IMAGE","enum":false}},{"configDocKey":{"type":"io.quarkus.deployment.pkg.NativeConfig.ImagePullStrategy","key":"quarkus.native.builder-image.pull","additionalKeys":[],"configDoc":"The strategy for pulling the builder image during the build.\n\nDefaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated.\n\nUse 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited.\n\nUse 'never' to fail the build if there is no image locally.","withinAMap":false,"defaultValue":"always","javaDocSiteLink":"","docMapKey":"pull","configPhase":"BUILD_TIME","acceptedValues":["`always`","`missing`","`never`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_BUILDER_IMAGE_PULL","enum":true}},{"configDocKey":{"type":"io.quarkus.deployment.util.ContainerRuntimeUtil.ContainerRuntime","key":"quarkus.native.container-runtime","additionalKeys":[],"configDoc":"The container runtime (e.g. docker) that is used to do an image based build. If this is set then a container build is always done.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-runtime","configPhase":"BUILD_TIME","acceptedValues":["`docker`","`docker-rootless`","`wsl`","`wsl-rootless`","`podman`","`podman-rootless`","`unavailable`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_CONTAINER_RUNTIME","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.native.container-runtime-options","additionalKeys":[],"configDoc":"Options to pass to the container runtime","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-runtime-options","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS","enum":false}},{"configDocKey":{"type":"io.quarkus.deployment.pkg.NativeConfig.MonitoringOption","key":"quarkus.native.monitoring","additionalKeys":[],"configDoc":"Enable monitoring various monitoring options. The value should be comma separated.\n\n - `jfr` for JDK flight recorder support\n - `jvmstat` for JVMStat support\n - `heapdump` for heampdump support\n - `jmxclient` for JMX client support (experimental)\n - `jmxserver` for JMX server support (experimental)\n - `all` for all monitoring features","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"monitoring","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_MONITORING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-reports","additionalKeys":[],"configDoc":"If the reports on call paths and included packages/classes/methods should be generated","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-reports","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_REPORTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.report-exception-stack-traces","additionalKeys":[],"configDoc":"If exceptions should be reported with a full stack trace","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"report-exception-stack-traces","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.report-errors-at-runtime","additionalKeys":[],"configDoc":"If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"report-errors-at-runtime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.reuse-existing","additionalKeys":[],"configDoc":"Don't build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"reuse-existing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_REUSE_EXISTING","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.resources.includes","additionalKeys":[],"configDoc":"A comma separated list of globs to match resource paths that should be added to the native image.\n\nUse slash (`/`) as a path separator on all platforms. Globs must not start with slash.\n\nBy default, no resources are included.\n\nExample: Given that you have `src/main/resources/ignored.png` and `src/main/resources/foo/selected.png` in your source tree and one of your dependency JARs contains `bar/some.txt` file, with the following configuration\n\n```\nquarkus.native.resources.includes = foo/**,bar/**/*.txt\n```\n\nthe files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included.\n\nSupported glob features Feature Description `++*++` Matches a (possibly empty) sequence of characters that does not contain slash (`/`) `++**++` Matches a (possibly empty) sequence of characters that may contain slash (`/`) `?` Matches one character, but not slash `++[++abc++]++` Matches one character given in the bracket, but not slash `++[++a-z++]++` Matches one character from the range given in the bracket, but not slash `++[++!abc++]++` Matches one character not named in the bracket; does not match slash `++[++a-z++]++` Matches one character outside the range given in the bracket; does not match slash `++{++one,two,three++}++` Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges `++\\++` The escape character\n\nNote that there are three levels of escaping when passing this option via `application.properties`:\n\n . `application.properties` parser\n - MicroProfile Config list converter that splits the comma separated list\n - Glob parser All three levels use backslash (`++\\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape.\n\nNote that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"includes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_RESOURCES_INCLUDES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.resources.excludes","additionalKeys":[],"configDoc":"A comma separated list of globs to match resource paths that should *not* be added to the native image.\n\nUse slash (`/`) as a path separator on all platforms. Globs must not start with slash.\n\nPlease refer to `includes` for details about the glob syntax.\n\nBy default, no resources are excluded.\n\nExample: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration\n\n```\nquarkus.native.resources.includes = **/*.png\nquarkus.native.resources.excludes = foo/**,**/green.png\n```\n\nthe resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excludes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_RESOURCES_EXCLUDES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.debug.enabled","additionalKeys":[],"configDoc":"If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_DEBUG_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.enable-dashboard-dump","additionalKeys":[],"configDoc":"Generate the report files for GraalVM Dashboard.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-dashboard-dump","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.native.compression.level","additionalKeys":[],"configDoc":"The compression level in ++[++1, 10++]++. 10 means _best_.\n\nHigher compression level requires more time to compress the executable.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"level","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.native.compression.additional-args","additionalKeys":[],"configDoc":"Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.native.agent-configuration-apply","additionalKeys":[],"configDoc":"Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process.\n\nEnabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"agent-configuration-apply","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.native","since":null,"environmentVariable":"QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.devui.deployment.DevUIConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.devui.deployment.DevUIConfig index f3fd49cd25d..0da802e1b49 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.devui.deployment.DevUIConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.devui.deployment.DevUIConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"int","key":"quarkus.dev-ui.history-size","additionalKeys":[],"configDoc":"The number of history log entries to remember.","withinAMap":false,"defaultValue":"50","javaDocSiteLink":"","docMapKey":"history-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_HISTORY_SIZE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.dev-ui.show-json-rpc-log","additionalKeys":[],"configDoc":"Show the JsonRPC Log. Useful for extension developers","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"show-json-rpc-log","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.dev-ui.cors.enabled","additionalKeys":[],"configDoc":"Enable CORS filter.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_CORS_ENABLED","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"int","key":"quarkus.dev-ui.history-size","additionalKeys":[],"configDoc":"The number of history log entries to remember.","withinAMap":false,"defaultValue":"50","javaDocSiteLink":"","docMapKey":"history-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_HISTORY_SIZE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.dev-ui.show-json-rpc-log","additionalKeys":[],"configDoc":"Show the JsonRPC Log. Useful for extension developers","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"show-json-rpc-log","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.dev-ui.hosts","additionalKeys":[],"configDoc":"More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_HOSTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.dev-ui.cors.enabled","additionalKeys":[],"configDoc":"Enable CORS filter.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.dev-ui","since":null,"environmentVariable":"QUARKUS_DEV_UI_CORS_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.grpc.runtime.config.GrpcConfiguration b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.grpc.runtime.config.GrpcConfiguration index a3252f09f09..674d6427fa5 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.grpc.runtime.config.GrpcConfiguration +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.grpc.runtime.config.GrpcConfiguration @@ -1 +1 @@ -[{"configDocSection":{"name":"quarkus.grpc.clients","optional":false,"withinAMap":false,"sectionDetails":"= Configures the gRPC clients","sectionDetailsTitle":"Configures the gRPC clients","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.grpc","configGroupType":"io.quarkus.grpc.runtime.config.GrpcClientConfiguration","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".use-quarkus-grpc-client","additionalKeys":[],"configDoc":"Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-quarkus-grpc-client","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".xds.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of XDS.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".xds.secure","additionalKeys":[],"configDoc":"Use secure credentials.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".xds.target","additionalKeys":[],"configDoc":"Optional explicit target.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"target","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".in-process.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of in-process.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IN_PROCESS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".in-process.name","additionalKeys":[],"configDoc":"Set in-process name.","withinAMap":true,"defaultValue":"quarkus-grpc","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IN_PROCESS_NAME","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".stork.threads","additionalKeys":[],"configDoc":"Number of threads on a delayed gRPC ClientCall","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"threads","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_THREADS","enum":false}},{"configDocKey":{"type":"long","key":"quarkus.grpc.clients.\"client-name\".stork.deadline","additionalKeys":[],"configDoc":"Deadline in milliseconds of delayed gRPC call","withinAMap":true,"defaultValue":"5000","javaDocSiteLink":"","docMapKey":"deadline","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_DEADLINE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".stork.retries","additionalKeys":[],"configDoc":"Number of retries on a gRPC ClientCall","withinAMap":true,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"retries","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_RETRIES","enum":false}},{"configDocKey":{"type":"long","key":"quarkus.grpc.clients.\"client-name\".stork.delay","additionalKeys":[],"configDoc":"Initial delay in seconds on refresh check","withinAMap":true,"defaultValue":"60","javaDocSiteLink":"","docMapKey":"delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_DELAY","enum":false}},{"configDocKey":{"type":"long","key":"quarkus.grpc.clients.\"client-name\".stork.period","additionalKeys":[],"configDoc":"Refresh period in seconds","withinAMap":true,"defaultValue":"120","javaDocSiteLink":"","docMapKey":"period","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_PERIOD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".port","additionalKeys":[],"configDoc":"The gRPC service port.","withinAMap":true,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".test-port","additionalKeys":[],"configDoc":"The gRPC service test port.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".host","additionalKeys":[],"configDoc":"The host name / IP on which the service is exposed.","withinAMap":true,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__HOST","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.clients.\"client-name\".ssl.certificate","additionalKeys":[],"configDoc":"The classpath path or file path to a server certificate or certificate chain in PEM format.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_CERTIFICATE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.clients.\"client-name\".ssl.key","additionalKeys":[],"configDoc":"The classpath path or file path to the corresponding certificate private key file in PEM format.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.clients.\"client-name\".ssl.trust-store","additionalKeys":[],"configDoc":"An optional trust store which holds the certificate information of the certificates to trust The trust store can be either on classpath or in an external file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_TRUST_STORE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".tls.verify-hostname","additionalKeys":[],"configDoc":"Whether hostname should be verified in the SSL/TLS handshake.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-hostname","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_VERIFY_HOSTNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".name-resolver","additionalKeys":[],"configDoc":"Use a name resolver. Defaults to dns. If set to \"stork\", host will be treated as SmallRye Stork service name","withinAMap":true,"defaultValue":"dns","javaDocSiteLink":"","docMapKey":"name-resolver","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__NAME_RESOLVER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.grpc.clients.\"client-name\".plain-text","additionalKeys":[],"configDoc":"Whether `plain-text` should be used instead of `TLS`. Enabled by default, except if TLS/SSL is configured. In this case, `plain-text` is disabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"plain-text","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PLAIN_TEXT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".keep-alive-time","additionalKeys":[],"configDoc":"The duration after which a keep alive ping is sent.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".flow-control-window","additionalKeys":[],"configDoc":"The flow control window in bytes. Default is 1MiB.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"flow-control-window","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__FLOW_CONTROL_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".idle-timeout","additionalKeys":[],"configDoc":"The duration without ongoing RPCs before going to idle mode.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".keep-alive-timeout","additionalKeys":[],"configDoc":"The amount of time the sender of a keep alive ping waits for an acknowledgement.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".keep-alive-without-calls","additionalKeys":[],"configDoc":"Whether keep-alive will be performed when there are no outstanding RPC on a connection.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"keep-alive-without-calls","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_WITHOUT_CALLS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".max-hedged-attempts","additionalKeys":[],"configDoc":"The max number of hedged attempts.","withinAMap":true,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-hedged-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_HEDGED_ATTEMPTS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".max-retry-attempts","additionalKeys":[],"configDoc":"The max number of retry attempts. Retry must be explicitly enabled.","withinAMap":true,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-retry-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_RETRY_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".max-trace-events","additionalKeys":[],"configDoc":"The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-trace-events","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_TRACE_EVENTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".max-inbound-message-size","additionalKeys":[],"configDoc":"The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_INBOUND_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".max-inbound-metadata-size","additionalKeys":[],"configDoc":"The maximum size of metadata allowed to be received (in bytes). Default is 8192B.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-metadata-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_INBOUND_METADATA_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".negotiation-type","additionalKeys":[],"configDoc":"The negotiation type for the HTTP/2 connection. Accepted values are: `TLS`, `PLAINTEXT_UPGRADE`, `PLAINTEXT`","withinAMap":true,"defaultValue":"TLS","javaDocSiteLink":"","docMapKey":"negotiation-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__NEGOTIATION_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".override-authority","additionalKeys":[],"configDoc":"Overrides the authority used with TLS and HTTP virtual hosting.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"override-authority","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__OVERRIDE_AUTHORITY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.grpc.clients.\"client-name\".per-rpc-buffer-limit","additionalKeys":[],"configDoc":"The per RPC buffer limit in bytes used for retry.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"per-rpc-buffer-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PER_RPC_BUFFER_LIMIT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".retry","additionalKeys":[],"configDoc":"Whether retry is enabled. Note that retry is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"retry","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__RETRY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.grpc.clients.\"client-name\".retry-buffer-size","additionalKeys":[],"configDoc":"The retry buffer size in bytes.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"retry-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__RETRY_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".user-agent","additionalKeys":[],"configDoc":"Use a custom user-agent.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USER_AGENT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".load-balancing-policy","additionalKeys":[],"configDoc":"Use a custom load balancing policy. Accepted values are: `pick_first`, `round_robin`, `grpclb`. This value is ignored if name-resolver is set to 'stork'.","withinAMap":true,"defaultValue":"pick_first","javaDocSiteLink":"","docMapKey":"load-balancing-policy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__LOAD_BALANCING_POLICY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".compression","additionalKeys":[],"configDoc":"The compression to use for each call. The accepted values are `gzip` and `identity`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__COMPRESSION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".deadline","additionalKeys":[],"configDoc":"The deadline used for each call.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"deadline","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__DEADLINE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.grpc.server","optional":false,"withinAMap":false,"sectionDetails":"= Configure the gRPC server","sectionDetailsTitle":"Configure the gRPC server","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.grpc","configGroupType":"io.quarkus.grpc.runtime.config.GrpcServerConfiguration","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.use-separate-server","additionalKeys":[],"configDoc":"Do we use separate HTTP server to serve gRPC requests. Set this to false if you want to use new Vert.x gRPC support, which uses existing Vert.x HTTP server.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"use-separate-server","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_USE_SEPARATE_SERVER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.xds.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of XDS.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_XDS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.xds.secure","additionalKeys":[],"configDoc":"Use secure credentials.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_XDS_SECURE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.in-process.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of in-process.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_IN_PROCESS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.in-process.name","additionalKeys":[],"configDoc":"Set in-process name.","withinAMap":false,"defaultValue":"quarkus-grpc","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_IN_PROCESS_NAME","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.server.port","additionalKeys":[],"configDoc":"The gRPC Server port.","withinAMap":false,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.server.test-port","additionalKeys":[],"configDoc":"The gRPC Server port used for tests.","withinAMap":false,"defaultValue":"9001","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.host","additionalKeys":[],"configDoc":"The gRPC server host.","withinAMap":false,"defaultValue":"0.0.0.0","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_HOST","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.server.handshake-timeout","additionalKeys":[],"configDoc":"The gRPC handshake timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"handshake-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_HANDSHAKE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.server.max-inbound-message-size","additionalKeys":[],"configDoc":"The max inbound message size in bytes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_MAX_INBOUND_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.server.max-inbound-metadata-size","additionalKeys":[],"configDoc":"The max inbound metadata size in bytes","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-metadata-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_MAX_INBOUND_METADATA_SIZE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.certificate","additionalKeys":[],"configDoc":"The classpath path or file path to a server certificate or certificate chain in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_CERTIFICATE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.key","additionalKeys":[],"configDoc":"The classpath path or file path to the corresponding certificate private key file in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.key-store","additionalKeys":[],"configDoc":"An optional keystore that holds the certificate information instead of specifying separate files. The keystore can be either on classpath or an external file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-alias-password","additionalKeys":[],"configDoc":"A parameter to specify the alias password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.trust-store","additionalKeys":[],"configDoc":"An optional trust store which holds the certificate information of the certificates to trust\n\nThe trust store can be either on classpath or an external file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.trust-store-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the trust store file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.cipher-suites","additionalKeys":[],"configDoc":"The cipher suites to use. If none is given, a reasonable default is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled SSL/TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_PROTOCOLS","enum":false}},{"configDocKey":{"type":"io.vertx.core.http.ClientAuth","key":"quarkus.grpc.server.ssl.client-auth","additionalKeys":[],"configDoc":"Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/http/ClientAuth.html","docMapKey":"client-auth","configPhase":"RUN_TIME","acceptedValues":["`none`","`request`","`required`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_CLIENT_AUTH","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.plain-text","additionalKeys":[],"configDoc":"Disables SSL, and uses plain text instead. If disabled, configure the ssl configuration.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"plain-text","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_PLAIN_TEXT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.alpn","additionalKeys":[],"configDoc":"Whether ALPN should be used.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_ALPN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.transport-security.certificate","additionalKeys":[],"configDoc":"The path to the certificate file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_TRANSPORT_SECURITY_CERTIFICATE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.transport-security.key","additionalKeys":[],"configDoc":"The path to the private key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_TRANSPORT_SECURITY_KEY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.enable-reflection-service","additionalKeys":[],"configDoc":"Enables the gRPC Reflection Service. By default, the reflection service is only exposed in `dev` mode. This setting allows overriding this choice and enable the reflection service every time.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-reflection-service","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_ENABLE_REFLECTION_SERVICE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.server.instances","additionalKeys":[],"configDoc":"Number of gRPC server verticle instances. This is useful for scaling easily across multiple cores. The number should not exceed the amount of event loops.","withinAMap":false,"defaultValue":"1","javaDocSiteLink":"","docMapKey":"instances","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_INSTANCES","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.server.netty.keep-alive-time","additionalKeys":[],"configDoc":"Sets a custom keep-alive duration. This configures the time before sending a `keepalive` ping when there is no read activity.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_NETTY_KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.server.netty.permit-keep-alive-time","additionalKeys":[],"configDoc":"Sets a custom permit-keep-alive duration. This configures the most aggressive keep-alive time clients are permitted to configure. The server will try to detect clients exceeding this rate and when detected will forcefully close the connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"permit-keep-alive-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.grpc.server.netty.permit-keep-alive-without-calls","additionalKeys":[],"configDoc":"Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"permit-keep-alive-without-calls","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_WITHOUT_CALLS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.compression","additionalKeys":[],"configDoc":"gRPC compression, e.g. \"gzip\"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_COMPRESSION","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocSection":{"name":"quarkus.grpc.clients","optional":false,"withinAMap":false,"sectionDetails":"= Configures the gRPC clients","sectionDetailsTitle":"Configures the gRPC clients","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.grpc","configGroupType":"io.quarkus.grpc.runtime.config.GrpcClientConfiguration","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".use-quarkus-grpc-client","additionalKeys":[],"configDoc":"Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-quarkus-grpc-client","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".xds.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of XDS.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".xds.secure","additionalKeys":[],"configDoc":"Use secure credentials.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".xds.target","additionalKeys":[],"configDoc":"Optional explicit target.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"target","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".in-process.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of in-process.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IN_PROCESS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".in-process.name","additionalKeys":[],"configDoc":"Set in-process name.","withinAMap":true,"defaultValue":"quarkus-grpc","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IN_PROCESS_NAME","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".stork.threads","additionalKeys":[],"configDoc":"Number of threads on a delayed gRPC ClientCall","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"threads","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_THREADS","enum":false}},{"configDocKey":{"type":"long","key":"quarkus.grpc.clients.\"client-name\".stork.deadline","additionalKeys":[],"configDoc":"Deadline in milliseconds of delayed gRPC call","withinAMap":true,"defaultValue":"5000","javaDocSiteLink":"","docMapKey":"deadline","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_DEADLINE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".stork.retries","additionalKeys":[],"configDoc":"Number of retries on a gRPC ClientCall","withinAMap":true,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"retries","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_RETRIES","enum":false}},{"configDocKey":{"type":"long","key":"quarkus.grpc.clients.\"client-name\".stork.delay","additionalKeys":[],"configDoc":"Initial delay in seconds on refresh check","withinAMap":true,"defaultValue":"60","javaDocSiteLink":"","docMapKey":"delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_DELAY","enum":false}},{"configDocKey":{"type":"long","key":"quarkus.grpc.clients.\"client-name\".stork.period","additionalKeys":[],"configDoc":"Refresh period in seconds","withinAMap":true,"defaultValue":"120","javaDocSiteLink":"","docMapKey":"period","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_PERIOD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".port","additionalKeys":[],"configDoc":"The gRPC service port.","withinAMap":true,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".test-port","additionalKeys":[],"configDoc":"The gRPC service test port.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".host","additionalKeys":[],"configDoc":"The host name / IP on which the service is exposed.","withinAMap":true,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__HOST","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.clients.\"client-name\".ssl.certificate","additionalKeys":[],"configDoc":"The classpath path or file path to a server certificate or certificate chain in PEM format.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_CERTIFICATE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.clients.\"client-name\".ssl.key","additionalKeys":[],"configDoc":"The classpath path or file path to the corresponding certificate private key file in PEM format.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.clients.\"client-name\".ssl.trust-store","additionalKeys":[],"configDoc":"An optional trust store which holds the certificate information of the certificates to trust The trust store can be either on classpath or in an external file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used.\n\nImportant: This is only supported when using the Quarkus (Vert.x-based) gRPC client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.trust-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".tls.key-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".tls.verify-hostname","additionalKeys":[],"configDoc":"Whether hostname should be verified in the SSL/TLS handshake.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-hostname","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_VERIFY_HOSTNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".name-resolver","additionalKeys":[],"configDoc":"Use a name resolver. Defaults to dns. If set to \"stork\", host will be treated as SmallRye Stork service name","withinAMap":true,"defaultValue":"dns","javaDocSiteLink":"","docMapKey":"name-resolver","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__NAME_RESOLVER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.grpc.clients.\"client-name\".plain-text","additionalKeys":[],"configDoc":"Whether `plain-text` should be used instead of `TLS`. Enabled by default, except if TLS/SSL is configured. In this case, `plain-text` is disabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"plain-text","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PLAIN_TEXT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".keep-alive-time","additionalKeys":[],"configDoc":"The duration after which a keep alive ping is sent.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".flow-control-window","additionalKeys":[],"configDoc":"The flow control window in bytes. Default is 1MiB.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"flow-control-window","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__FLOW_CONTROL_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".idle-timeout","additionalKeys":[],"configDoc":"The duration without ongoing RPCs before going to idle mode.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".keep-alive-timeout","additionalKeys":[],"configDoc":"The amount of time the sender of a keep alive ping waits for an acknowledgement.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".keep-alive-without-calls","additionalKeys":[],"configDoc":"Whether keep-alive will be performed when there are no outstanding RPC on a connection.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"keep-alive-without-calls","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_WITHOUT_CALLS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".max-hedged-attempts","additionalKeys":[],"configDoc":"The max number of hedged attempts.","withinAMap":true,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-hedged-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_HEDGED_ATTEMPTS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.clients.\"client-name\".max-retry-attempts","additionalKeys":[],"configDoc":"The max number of retry attempts. Retry must be explicitly enabled.","withinAMap":true,"defaultValue":"5","javaDocSiteLink":"","docMapKey":"max-retry-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_RETRY_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".max-trace-events","additionalKeys":[],"configDoc":"The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-trace-events","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_TRACE_EVENTS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".max-inbound-message-size","additionalKeys":[],"configDoc":"The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_INBOUND_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.clients.\"client-name\".max-inbound-metadata-size","additionalKeys":[],"configDoc":"The maximum size of metadata allowed to be received (in bytes). Default is 8192B.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-metadata-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_INBOUND_METADATA_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".negotiation-type","additionalKeys":[],"configDoc":"The negotiation type for the HTTP/2 connection. Accepted values are: `TLS`, `PLAINTEXT_UPGRADE`, `PLAINTEXT`","withinAMap":true,"defaultValue":"TLS","javaDocSiteLink":"","docMapKey":"negotiation-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__NEGOTIATION_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".override-authority","additionalKeys":[],"configDoc":"Overrides the authority used with TLS and HTTP virtual hosting.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"override-authority","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__OVERRIDE_AUTHORITY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.grpc.clients.\"client-name\".per-rpc-buffer-limit","additionalKeys":[],"configDoc":"The per RPC buffer limit in bytes used for retry.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"per-rpc-buffer-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PER_RPC_BUFFER_LIMIT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.clients.\"client-name\".retry","additionalKeys":[],"configDoc":"Whether retry is enabled. Note that retry is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"retry","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__RETRY","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.grpc.clients.\"client-name\".retry-buffer-size","additionalKeys":[],"configDoc":"The retry buffer size in bytes.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"retry-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__RETRY_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".user-agent","additionalKeys":[],"configDoc":"Use a custom user-agent.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USER_AGENT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".load-balancing-policy","additionalKeys":[],"configDoc":"Use a custom load balancing policy. Accepted values are: `pick_first`, `round_robin`, `grpclb`. This value is ignored if name-resolver is set to 'stork'.","withinAMap":true,"defaultValue":"pick_first","javaDocSiteLink":"","docMapKey":"load-balancing-policy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__LOAD_BALANCING_POLICY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.clients.\"client-name\".compression","additionalKeys":[],"configDoc":"The compression to use for each call. The accepted values are `gzip` and `identity`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__COMPRESSION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.clients.\"client-name\".deadline","additionalKeys":[],"configDoc":"The deadline used for each call.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"deadline","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_CLIENTS__CLIENT_NAME__DEADLINE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.grpc.server","optional":false,"withinAMap":false,"sectionDetails":"= Configure the gRPC server","sectionDetailsTitle":"Configure the gRPC server","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.grpc","configGroupType":"io.quarkus.grpc.runtime.config.GrpcServerConfiguration","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.use-separate-server","additionalKeys":[],"configDoc":"Do we use separate HTTP server to serve gRPC requests. Set this to false if you want to use new Vert.x gRPC support, which uses existing Vert.x HTTP server.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"use-separate-server","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_USE_SEPARATE_SERVER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.xds.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of XDS.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_XDS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.xds.secure","additionalKeys":[],"configDoc":"Use secure credentials.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_XDS_SECURE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.in-process.enabled","additionalKeys":[],"configDoc":"Explicitly enable use of in-process.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_IN_PROCESS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.in-process.name","additionalKeys":[],"configDoc":"Set in-process name.","withinAMap":false,"defaultValue":"quarkus-grpc","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_IN_PROCESS_NAME","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.server.port","additionalKeys":[],"configDoc":"The gRPC Server port.","withinAMap":false,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.server.test-port","additionalKeys":[],"configDoc":"The gRPC Server port used for tests.","withinAMap":false,"defaultValue":"9001","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.host","additionalKeys":[],"configDoc":"The gRPC server host.","withinAMap":false,"defaultValue":"0.0.0.0","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_HOST","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.server.handshake-timeout","additionalKeys":[],"configDoc":"The gRPC handshake timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"handshake-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_HANDSHAKE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.server.max-inbound-message-size","additionalKeys":[],"configDoc":"The max inbound message size in bytes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_MAX_INBOUND_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.grpc.server.max-inbound-metadata-size","additionalKeys":[],"configDoc":"The max inbound metadata size in bytes","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-inbound-metadata-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_MAX_INBOUND_METADATA_SIZE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.certificate","additionalKeys":[],"configDoc":"The classpath path or file path to a server certificate or certificate chain in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_CERTIFICATE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.key","additionalKeys":[],"configDoc":"The classpath path or file path to the corresponding certificate private key file in PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.key-store","additionalKeys":[],"configDoc":"An optional keystore that holds the certificate information instead of specifying separate files. The keystore can be either on classpath or an external file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.key-store-alias-password","additionalKeys":[],"configDoc":"A parameter to specify the alias password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_KEY_STORE_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.grpc.server.ssl.trust-store","additionalKeys":[],"configDoc":"An optional trust store which holds the certificate information of the certificates to trust\n\nThe trust store can be either on classpath or an external file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.trust-store-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the trust store file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.cipher-suites","additionalKeys":[],"configDoc":"The cipher suites to use. If none is given, a reasonable default is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.ssl.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled SSL/TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_PROTOCOLS","enum":false}},{"configDocKey":{"type":"io.vertx.core.http.ClientAuth","key":"quarkus.grpc.server.ssl.client-auth","additionalKeys":[],"configDoc":"Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/http/ClientAuth.html","docMapKey":"client-auth","configPhase":"RUN_TIME","acceptedValues":["`none`","`request`","`required`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_SSL_CLIENT_AUTH","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.plain-text","additionalKeys":[],"configDoc":"Disables SSL, and uses plain text instead. If disabled, configure the ssl configuration.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"plain-text","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_PLAIN_TEXT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.alpn","additionalKeys":[],"configDoc":"Whether ALPN should be used.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_ALPN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.transport-security.certificate","additionalKeys":[],"configDoc":"The path to the certificate file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_TRANSPORT_SECURITY_CERTIFICATE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.transport-security.key","additionalKeys":[],"configDoc":"The path to the private key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_TRANSPORT_SECURITY_KEY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.grpc.server.enable-reflection-service","additionalKeys":[],"configDoc":"Enables the gRPC Reflection Service. By default, the reflection service is only exposed in `dev` mode. This setting allows overriding this choice and enable the reflection service every time.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-reflection-service","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_ENABLE_REFLECTION_SERVICE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.grpc.server.instances","additionalKeys":[],"configDoc":"Number of gRPC server verticle instances. This is useful for scaling easily across multiple cores. The number should not exceed the amount of event loops.","withinAMap":false,"defaultValue":"1","javaDocSiteLink":"","docMapKey":"instances","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_INSTANCES","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.server.netty.keep-alive-time","additionalKeys":[],"configDoc":"Sets a custom keep-alive duration. This configures the time before sending a `keepalive` ping when there is no read activity.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_NETTY_KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.grpc.server.netty.permit-keep-alive-time","additionalKeys":[],"configDoc":"Sets a custom permit-keep-alive duration. This configures the most aggressive keep-alive time clients are permitted to configure. The server will try to detect clients exceeding this rate and when detected will forcefully close the connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"permit-keep-alive-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_TIME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.grpc.server.netty.permit-keep-alive-without-calls","additionalKeys":[],"configDoc":"Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"permit-keep-alive-without-calls","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_WITHOUT_CALLS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.grpc.server.compression","additionalKeys":[],"configDoc":"gRPC compression, e.g. \"gzip\"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.grpc","since":null,"environmentVariable":"QUARKUS_GRPC_SERVER_COMPRESSION","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfig index af1352a5a41..4672c51980b 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.enabled","additionalKeys":[],"configDoc":"Whether Hibernate ORM is enabled *during the build*.\n\nIf Hibernate ORM is disabled during the build, all processing related to Hibernate ORM will be skipped,\nbut it will not be possible to activate Hibernate ORM at runtime:\n`quarkus.hibernate-orm.active` will default to `false` and setting it to `true` will lead to an error.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_ENABLED","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.database","optional":false,"withinAMap":false,"sectionDetails":"= Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfig.HibernateOrmConfigDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"io.quarkus.hibernate.orm.runtime.config.DatabaseOrmCompatibilityVersion","key":"quarkus.hibernate-orm.database.orm-compatibility.version","additionalKeys":[],"configDoc":"When set, attempts to exchange data with the database\nas the given version of Hibernate ORM would have,\n*on a best-effort basis*.\n\nPlease note:\n\n* schema validation may still fail in some cases:\nthis attempts to make Hibernate ORM 6+ behave correctly at runtime,\nbut it may still expect a different (but runtime-compatible) schema.\n* robust test suites are still useful and recommended:\nyou should still check that your application behaves as intended with your legacy schema.\n* this feature is inherently unstable:\nsome aspects of it may stop working in future versions of Quarkus,\nand older versions will be dropped as Hibernate ORM changes pile up\nand support for those older versions becomes too unreliable.\n* you should still plan a migration of your schema to a newer version of Hibernate ORM.\nFor help with migration, refer to\nlink:https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.0:-Hibernate-ORM-5-to-6-migration[the Quarkus 3\nmigration guide from Hibernate ORM 5 to 6].","withinAMap":false,"defaultValue":"latest","javaDocSiteLink":"","docMapKey":"orm-compatibility-version","configPhase":"BUILD_TIME","acceptedValues":["`5.6`","`latest`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION","enum":true}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.hibernate-orm.database.charset","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.charset"],"configDoc":"The charset of the database.\n\nUsed for DDL generation and also for the SQL import scripts.","withinAMap":true,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"charset","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.datasource","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".datasource"],"configDoc":"The name of the datasource which this persistence unit uses.\n\nIf undefined, it will use the default datasource.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"datasource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATASOURCE","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.packages","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".packages"],"configDoc":"The packages in which the entities affected to this persistence unit are located.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"packages","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_PACKAGES","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.dialect","optional":false,"withinAMap":true,"sectionDetails":"== Dialect related configuration","sectionDetailsTitle":"Dialect related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.dialect","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".dialect"],"configDoc":"Class name of the Hibernate ORM dialect.\n\nThe complete list of bundled dialects is available in the\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM\nJavaDoc].\n\nSetting the dialect directly is only recommended as a last resort:\nmost popular databases have a corresponding Quarkus extension,\nallowing Quarkus to select the dialect automatically,\nin which case you do not need to set the dialect at all,\nthough you may want to set\nxref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as\nhigh as possible\nto benefit from the best performance and latest features.\n\nIf your database does not have a corresponding Quarkus extension,\nyou will need to set the dialect directly.\nIn that case, keep in mind that the JDBC driver and Hibernate ORM dialect\nmay not work properly in GraalVM native executables.","withinAMap":true,"defaultValue":"selected automatically for most popular databases","javaDocSiteLink":"","docMapKey":"dialect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DIALECT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.dialect.storage-engine","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".dialect.storage-engine"],"configDoc":"The storage engine to use when the dialect supports multiple storage engines.\n\nE.g. `MyISAM` or `InnoDB` for MySQL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"storage-engine","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.sql-load-script","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".sql-load-script"],"configDoc":"Path to a file containing the SQL statements to execute when Hibernate ORM starts.\n\nThe file is retrieved from the classpath resources,\nso it must be located in the resources directory (e.g. `src/main/resources`).\n\nThe default value for this setting differs depending on the Quarkus launch mode:\n\n* In dev and test modes, it defaults to `import.sql`.\n Simply add an `import.sql` file in the root of your resources directory\n and it will be picked up without having to set this property.\n Pass `no-file` to force Hibernate ORM to ignore the SQL import file.\n* In production mode, it defaults to `no-file`.\n It means Hibernate ORM won't try to execute any SQL import file by default.\n Pass an explicit value to force Hibernate ORM to execute the SQL import file.\n\nIf you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus\nhttps://quarkus.io/guides/config#configuration-profiles[configuration profiles facility].\n\n[source,property]\n.application.properties\n----\n%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql\n%test.quarkus.hibernate-orm.sql-load-script = import-test.sql\n%prod.quarkus.hibernate-orm.sql-load-script = no-file\n----\n\n[NOTE]\n====\nQuarkus supports `.sql` file with SQL statements or comments spread over multiple lines.\nEach SQL statement must be terminated by a semicolon.\n====","withinAMap":true,"defaultValue":"import.sql in DEV, TEST ; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"sql-load-script","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.physical-naming-strategy","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".physical-naming-strategy"],"configDoc":"Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"physical-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_PHYSICAL_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.implicit-naming-strategy","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".implicit-naming-strategy"],"configDoc":"Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"implicit-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_IMPLICIT_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.metadata-builder-contributor","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".metadata-builder-contributor"],"configDoc":"Class name of a custom\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/spi/MetadataBuilderContributor.html[`org.hibernate.boot.spi.MetadataBuilderContributor`]\nimplementation.\n\n[NOTE]\n====\nNot all customization options exposed by\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/MetadataBuilder.html[`org.hibernate.boot.MetadataBuilder`]\nwill work correctly. Stay clear of options related to classpath scanning in particular.\n\nThis setting is exposed mainly to allow registration of types, converters and SQL functions.\n====","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"metadata-builder-contributor","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_METADATA_BUILDER_CONTRIBUTOR","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.mapping-files","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".mapping-files"],"configDoc":"XML files to configure the entity mapping, e.g. `META-INF/my-orm.xml`.\n\nDefaults to `META-INF/orm.xml` if it exists. Pass `no-file` to force Hibernate ORM to ignore `META-INF/orm.xml`.","withinAMap":true,"defaultValue":"META-INF/orm.xml if it exists; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"mapping-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MAPPING_FILES","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.mapping","optional":false,"withinAMap":true,"sectionDetails":"== Mapping configuration","sectionDetailsTitle":"Mapping configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitMapping","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.annotations.TimeZoneStorageType","key":"quarkus.hibernate-orm.mapping.timezone.default-storage","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".mapping.timezone.default-storage"],"configDoc":"How to store timezones in the database by default\nfor properties of type `OffsetDateTime` and `ZonedDateTime`.\n\nThis default may be overridden on a per-property basis using `@TimeZoneStorage`.\n\nNOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this\nsetting].\n\n`default`::\nEquivalent to `native` if supported, `normalize-utc` otherwise.\n`auto`::\nEquivalent to `native` if supported, `column` otherwise.\n`native`::\nStores the timestamp and timezone in a column of type `timestamp with time zone`.\n+\nOnly available on some databases/dialects;\nif not supported, an exception will be thrown during static initialization.\n`column`::\nStores the timezone in a separate column next to the timestamp column.\n+\nUse `@TimeZoneColumn` on the relevant entity property to customize the timezone column.\n`normalize-utc`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value to a timestamp in the UTC timezone.\n`normalize`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value:\n* upon persisting to the database, to a timestamp in the JDBC timezone\nset through `quarkus.hibernate-orm.jdbc.timezone`,\nor the JVM default timezone if not set.\n* upon reading back from the database, to the JVM default timezone.\n+\nUse this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older.","withinAMap":true,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"time-zone-default-storage","configPhase":"BUILD_TIME","acceptedValues":["`native`","`normalize`","`normalize-utc`","`column`","`auto`","`default`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MAPPING_TIMEZONE_DEFAULT_STORAGE","enum":true}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdOptimizerType","key":"quarkus.hibernate-orm.mapping.id.optimizer.default","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".mapping.id.optimizer.default"],"configDoc":"The optimizer to apply to identifier generators\nwhose optimizer is not configured explicitly.\n\nOnly relevant for table- and sequence-based identifier generators.\nOther generators, such as UUID-based generators, will ignore this setting.\n\nThe optimizer is responsible for pooling new identifier values,\nin order to reduce the frequency of database calls to retrieve those values\nand thereby improve performance.","withinAMap":true,"defaultValue":"pooled-lo","javaDocSiteLink":"","docMapKey":"id-optimizer-default","configPhase":"BUILD_TIME","acceptedValues":["`pooled-lo`","`pooled`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MAPPING_ID_OPTIMIZER_DEFAULT","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.query","optional":false,"withinAMap":true,"sectionDetails":"== Query related configuration","sectionDetailsTitle":"Query related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery","showSection":true,"configDocItems":[{"configDocKey":{"type":"int","key":"quarkus.hibernate-orm.query.query-plan-cache-max-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".query.query-plan-cache-max-size"],"configDoc":"The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE`","withinAMap":true,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"query-plan-cache-max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUERY_QUERY_PLAN_CACHE_MAX_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery.NullOrdering","key":"quarkus.hibernate-orm.query.default-null-ordering","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".query.default-null-ordering"],"configDoc":"Default precedence of null values in `ORDER BY` clauses.\n\nValid values are: `none`, `first`, `last`.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"default-null-ordering","configPhase":"BUILD_TIME","acceptedValues":["`none`","`first`","`last`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.query.in-clause-parameter-padding","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".query.in-clause-parameter-padding"],"configDoc":"Enables IN clause parameter padding which improves statement caching.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"in-clause-parameter-padding","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.jdbc","optional":false,"withinAMap":true,"sectionDetails":"== JDBC related configuration","sectionDetailsTitle":"JDBC related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.jdbc.timezone","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".jdbc.timezone"],"configDoc":"The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"timezone","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.jdbc.statement-fetch-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".jdbc.statement-fetch-size"],"configDoc":"How many rows are fetched at a time by the JDBC driver.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-fetch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.jdbc.statement-batch-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".jdbc.statement-batch-size"],"configDoc":"The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.fetch","optional":false,"withinAMap":true,"sectionDetails":"== Fetching logic configuration","sectionDetailsTitle":"Fetching logic configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.fetch.batch-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".fetch.batch-size"],"configDoc":"The size of the batches used when loading entities and collections.\n\n`-1` means batch loading is disabled.","withinAMap":true,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.fetch.max-depth","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".fetch.max-depth"],"configDoc":"The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).\n\nA `0` disables default outer join fetching.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-depth","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.cache","optional":false,"withinAMap":true,"sectionDetails":"== Caching configuration","sectionDetailsTitle":"Caching configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-orm.cache.\"cache\".expiration.max-idle","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".cache.\"cache\".expiration.max-idle"],"configDoc":"The maximum time before an object of the cache is considered expired.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-idle","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.hibernate-orm.cache.\"cache\".memory.object-count","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".cache.\"cache\".memory.object-count"],"configDoc":"The maximum number of objects kept in memory in the cache.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"object-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.discriminator","optional":false,"withinAMap":true,"sectionDetails":"== Discriminator related configuration","sectionDetailsTitle":"Discriminator related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDiscriminator","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".discriminator.ignore-explicit-for-joined"],"configDoc":"Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-explicit-for-joined","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdentifierQuotingStrategy","key":"quarkus.hibernate-orm.quote-identifiers.strategy","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".quote-identifiers.strategy"],"configDoc":"Identifiers can be quoted using one of the available strategies.\n\nSet to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`none`","`all`","`all-except-column-definitions`","`only-keywords`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.second-level-caching-enabled","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".second-level-caching-enabled"],"configDoc":"The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.\n\nJust cherry-pick which entities should be using the cache.\n\nSet this to false to disable all 2nd level caches.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"second-level-caching-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SECOND_LEVEL_CACHING_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.validation.enabled","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".validation.enabled"],"configDoc":"Enables the Bean Validation integration.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_VALIDATION_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.multitenant","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".multitenant"],"configDoc":"Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the\nhttps://javadoc.io/doc/org.hibernate/hibernate-core/5.6.10.Final/org/hibernate/MultiTenancyStrategy.html[Hibernate ORM\nJavaDoc].\nThe type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multitenant","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MULTITENANT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.multitenant-schema-datasource","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".multitenant-schema-datasource"],"configDoc":"Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multitenant-schema-datasource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.validate-in-dev-mode","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".validate-in-dev-mode"],"configDoc":"If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"validate-in-dev-mode","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_VALIDATE_IN_DEV_MODE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.persistence-xml.ignore","additionalKeys":[],"configDoc":"If `true`, Quarkus will ignore any `persistence.xml` file in the classpath and rely exclusively on the Quarkus configuration.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_PERSISTENCE_XML_IGNORE","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.log","optional":false,"withinAMap":false,"sectionDetails":"= Logging configuration","sectionDetailsTitle":"Logging configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfig.HibernateOrmConfigLog","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.bind-parameters","additionalKeys":[],"configDoc":"Logs SQL bind parameters.\n\nSetting it to true is obviously not recommended in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"bind-parameters","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.statistics","additionalKeys":[],"configDoc":"Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statistics","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_STATISTICS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.log-session-metrics","additionalKeys":[],"configDoc":"Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled (`quarkus.hibernate-orm.statistics`). The default is false (which means both `statistics` and `log-session-metrics` need to be enabled for the session metrics to appear in the log).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"log-session-metrics","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_SESSION_METRICS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published if a metrics extension is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_METRICS_ENABLED","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.enabled","additionalKeys":[],"configDoc":"Whether Hibernate ORM is enabled *during the build*.\n\nIf Hibernate ORM is disabled during the build, all processing related to Hibernate ORM will be skipped,\nbut it will not be possible to activate Hibernate ORM at runtime:\n`quarkus.hibernate-orm.active` will default to `false` and setting it to `true` will lead to an error.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_ENABLED","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.database","optional":false,"withinAMap":false,"sectionDetails":"= Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfig.HibernateOrmConfigDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"io.quarkus.hibernate.orm.runtime.config.DatabaseOrmCompatibilityVersion","key":"quarkus.hibernate-orm.database.orm-compatibility.version","additionalKeys":[],"configDoc":"When set, attempts to exchange data with the database\nas the given version of Hibernate ORM would have,\n*on a best-effort basis*.\n\nPlease note:\n\n* schema validation may still fail in some cases:\nthis attempts to make Hibernate ORM 6+ behave correctly at runtime,\nbut it may still expect a different (but runtime-compatible) schema.\n* robust test suites are still useful and recommended:\nyou should still check that your application behaves as intended with your legacy schema.\n* this feature is inherently unstable:\nsome aspects of it may stop working in future versions of Quarkus,\nand older versions will be dropped as Hibernate ORM changes pile up\nand support for those older versions becomes too unreliable.\n* you should still plan a migration of your schema to a newer version of Hibernate ORM.\nFor help with migration, refer to\nlink:https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.0:-Hibernate-ORM-5-to-6-migration[the Quarkus 3\nmigration guide from Hibernate ORM 5 to 6].","withinAMap":false,"defaultValue":"latest","javaDocSiteLink":"","docMapKey":"orm-compatibility-version","configPhase":"BUILD_TIME","acceptedValues":["`5.6`","`latest`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION","enum":true}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.hibernate-orm.database.charset","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.charset"],"configDoc":"The charset of the database.\n\nUsed for DDL generation and also for the SQL import scripts.","withinAMap":true,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"charset","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.datasource","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".datasource"],"configDoc":"The name of the datasource which this persistence unit uses.\n\nIf undefined, it will use the default datasource.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"datasource","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATASOURCE","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.packages","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".packages"],"configDoc":"The packages in which the entities affected to this persistence unit are located.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"packages","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_PACKAGES","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.dialect","optional":false,"withinAMap":true,"sectionDetails":"== Dialect related configuration","sectionDetailsTitle":"Dialect related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.dialect","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".dialect"],"configDoc":"Class name of the Hibernate ORM dialect.\n\nThe complete list of bundled dialects is available in the\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM\nJavaDoc].\n\nSetting the dialect directly is only recommended as a last resort:\nmost popular databases have a corresponding Quarkus extension,\nallowing Quarkus to select the dialect automatically,\nin which case you do not need to set the dialect at all,\nthough you may want to set\nxref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as\nhigh as possible\nto benefit from the best performance and latest features.\n\nIf your database does not have a corresponding Quarkus extension,\nyou will need to set the dialect directly.\nIn that case, keep in mind that the JDBC driver and Hibernate ORM dialect\nmay not work properly in GraalVM native executables.","withinAMap":true,"defaultValue":"selected automatically for most popular databases","javaDocSiteLink":"","docMapKey":"dialect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DIALECT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.dialect.storage-engine","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".dialect.storage-engine"],"configDoc":"The storage engine to use when the dialect supports multiple storage engines.\n\nE.g. `MyISAM` or `InnoDB` for MySQL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"storage-engine","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.sql-load-script","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".sql-load-script"],"configDoc":"Paths to files containing the SQL statements to execute when Hibernate ORM starts.\n\nThe files are retrieved from the classpath resources,\nso they must be located in the resources directory (e.g. `src/main/resources`).\n\nThe default value for this setting differs depending on the Quarkus launch mode:\n\n* In dev and test modes, it defaults to `import.sql`.\n Simply add an `import.sql` file in the root of your resources directory\n and it will be picked up without having to set this property.\n Pass `no-file` to force Hibernate ORM to ignore the SQL import file.\n* In production mode, it defaults to `no-file`.\n It means Hibernate ORM won't try to execute any SQL import file by default.\n Pass an explicit value to force Hibernate ORM to execute the SQL import file.\n\nIf you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus\nhttps://quarkus.io/guides/config#configuration-profiles[configuration profiles facility].\n\n[source,property]\n.application.properties\n----\n%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql\n%test.quarkus.hibernate-orm.sql-load-script = import-test.sql\n%prod.quarkus.hibernate-orm.sql-load-script = no-file\n----\n\n[NOTE]\n====\nQuarkus supports `.sql` file with SQL statements or comments spread over multiple lines.\nEach SQL statement must be terminated by a semicolon.\n====","withinAMap":true,"defaultValue":"import.sql in dev and test modes ; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"sql-load-script","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.physical-naming-strategy","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".physical-naming-strategy"],"configDoc":"Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"physical-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_PHYSICAL_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.implicit-naming-strategy","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".implicit-naming-strategy"],"configDoc":"Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"implicit-naming-strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_IMPLICIT_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.metadata-builder-contributor","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".metadata-builder-contributor"],"configDoc":"Class name of a custom\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/spi/MetadataBuilderContributor.html[`org.hibernate.boot.spi.MetadataBuilderContributor`]\nimplementation.\n\n[NOTE]\n====\nNot all customization options exposed by\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/boot/MetadataBuilder.html[`org.hibernate.boot.MetadataBuilder`]\nwill work correctly. Stay clear of options related to classpath scanning in particular.\n\nThis setting is exposed mainly to allow registration of types, converters and SQL functions.\n====","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"metadata-builder-contributor","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_METADATA_BUILDER_CONTRIBUTOR","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.mapping-files","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".mapping-files"],"configDoc":"XML files to configure the entity mapping, e.g. `META-INF/my-orm.xml`.\n\nDefaults to `META-INF/orm.xml` if it exists. Pass `no-file` to force Hibernate ORM to ignore `META-INF/orm.xml`.","withinAMap":true,"defaultValue":"META-INF/orm.xml if it exists; no-file otherwise","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"mapping-files","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MAPPING_FILES","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.mapping","optional":false,"withinAMap":true,"sectionDetails":"== Mapping configuration","sectionDetailsTitle":"Mapping configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitMapping","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.annotations.TimeZoneStorageType","key":"quarkus.hibernate-orm.mapping.timezone.default-storage","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".mapping.timezone.default-storage"],"configDoc":"How to store timezones in the database by default\nfor properties of type `OffsetDateTime` and `ZonedDateTime`.\n\nThis default may be overridden on a per-property basis using `@TimeZoneStorage`.\n\nNOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this\nsetting].\n\n`default`::\nEquivalent to `native` if supported, `normalize-utc` otherwise.\n`auto`::\nEquivalent to `native` if supported, `column` otherwise.\n`native`::\nStores the timestamp and timezone in a column of type `timestamp with time zone`.\n+\nOnly available on some databases/dialects;\nif not supported, an exception will be thrown during static initialization.\n`column`::\nStores the timezone in a separate column next to the timestamp column.\n+\nUse `@TimeZoneColumn` on the relevant entity property to customize the timezone column.\n`normalize-utc`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value to a timestamp in the UTC timezone.\n`normalize`::\nDoes not store the timezone, and loses timezone information upon persisting.\n+\nInstead, normalizes the value:\n* upon persisting to the database, to a timestamp in the JDBC timezone\nset through `quarkus.hibernate-orm.jdbc.timezone`,\nor the JVM default timezone if not set.\n* upon reading back from the database, to the JVM default timezone.\n+\nUse this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older.","withinAMap":true,"defaultValue":"default","javaDocSiteLink":"","docMapKey":"time-zone-default-storage","configPhase":"BUILD_TIME","acceptedValues":["`native`","`normalize`","`normalize-utc`","`column`","`auto`","`default`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MAPPING_TIMEZONE_DEFAULT_STORAGE","enum":true}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdOptimizerType","key":"quarkus.hibernate-orm.mapping.id.optimizer.default","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".mapping.id.optimizer.default"],"configDoc":"The optimizer to apply to identifier generators\nwhose optimizer is not configured explicitly.\n\nOnly relevant for table- and sequence-based identifier generators.\nOther generators, such as UUID-based generators, will ignore this setting.\n\nThe optimizer is responsible for pooling new identifier values,\nin order to reduce the frequency of database calls to retrieve those values\nand thereby improve performance.","withinAMap":true,"defaultValue":"pooled-lo","javaDocSiteLink":"","docMapKey":"id-optimizer-default","configPhase":"BUILD_TIME","acceptedValues":["`pooled-lo`","`pooled`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MAPPING_ID_OPTIMIZER_DEFAULT","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.query","optional":false,"withinAMap":true,"sectionDetails":"== Query related configuration","sectionDetailsTitle":"Query related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery","showSection":true,"configDocItems":[{"configDocKey":{"type":"int","key":"quarkus.hibernate-orm.query.query-plan-cache-max-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".query.query-plan-cache-max-size"],"configDoc":"The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE`","withinAMap":true,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"query-plan-cache-max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUERY_QUERY_PLAN_CACHE_MAX_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery.NullOrdering","key":"quarkus.hibernate-orm.query.default-null-ordering","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".query.default-null-ordering"],"configDoc":"Default precedence of null values in `ORDER BY` clauses.\n\nValid values are: `none`, `first`, `last`.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"default-null-ordering","configPhase":"BUILD_TIME","acceptedValues":["`none`","`first`","`last`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.query.in-clause-parameter-padding","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".query.in-clause-parameter-padding"],"configDoc":"Enables IN clause parameter padding which improves statement caching.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"in-clause-parameter-padding","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.jdbc","optional":false,"withinAMap":true,"sectionDetails":"== JDBC related configuration","sectionDetailsTitle":"JDBC related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.jdbc.timezone","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".jdbc.timezone"],"configDoc":"The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"timezone","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.jdbc.statement-fetch-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".jdbc.statement-fetch-size"],"configDoc":"How many rows are fetched at a time by the JDBC driver.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-fetch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.jdbc.statement-batch-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".jdbc.statement-batch-size"],"configDoc":"The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statement-batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.fetch","optional":false,"withinAMap":true,"sectionDetails":"== Fetching logic configuration","sectionDetailsTitle":"Fetching logic configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.fetch.batch-size","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".fetch.batch-size"],"configDoc":"The size of the batches used when loading entities and collections.\n\n`-1` means batch loading is disabled.","withinAMap":true,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"batch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-orm.fetch.max-depth","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".fetch.max-depth"],"configDoc":"The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).\n\nA `0` disables default outer join fetching.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-depth","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.cache","optional":false,"withinAMap":true,"sectionDetails":"== Caching configuration","sectionDetailsTitle":"Caching configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-orm.cache.\"cache\".expiration.max-idle","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".cache.\"cache\".expiration.max-idle"],"configDoc":"The maximum time before an object of the cache is considered expired.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-idle","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.hibernate-orm.cache.\"cache\".memory.object-count","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".cache.\"cache\".memory.object-count"],"configDoc":"The maximum number of objects kept in memory in the cache.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"object-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.discriminator","optional":false,"withinAMap":true,"sectionDetails":"== Discriminator related configuration","sectionDetailsTitle":"Discriminator related configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDiscriminator","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".discriminator.ignore-explicit-for-joined"],"configDoc":"Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-explicit-for-joined","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit.IdentifierQuotingStrategy","key":"quarkus.hibernate-orm.quote-identifiers.strategy","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".quote-identifiers.strategy"],"configDoc":"Identifiers can be quoted using one of the available strategies.\n\nSet to `none` by default, meaning no identifiers will be quoted. If set to `all`, all identifiers and column definitions will be quoted. Additionally, setting it to `all-except-column-definitions` will skip the column definitions, which can usually be required when they exist, or else use the option `only-keywords` to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`none`","`all`","`all-except-column-definitions`","`only-keywords`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.second-level-caching-enabled","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".second-level-caching-enabled"],"configDoc":"The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.\n\nJust cherry-pick which entities should be using the cache.\n\nSet this to false to disable all 2nd level caches.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"second-level-caching-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SECOND_LEVEL_CACHING_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.validation.enabled","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".validation.enabled"],"configDoc":"Enables the Bean Validation integration.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_VALIDATION_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.multitenant","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".multitenant"],"configDoc":"Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the\nhttps://javadoc.io/doc/org.hibernate/hibernate-core/5.6.10.Final/org/hibernate/MultiTenancyStrategy.html[Hibernate ORM\nJavaDoc].\nThe type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multitenant","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_MULTITENANT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.validate-in-dev-mode","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".validate-in-dev-mode"],"configDoc":"If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"validate-in-dev-mode","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_VALIDATE_IN_DEV_MODE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.persistence-xml.ignore","additionalKeys":[],"configDoc":"If `true`, Quarkus will ignore any `persistence.xml` file in the classpath and rely exclusively on the Quarkus configuration.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_PERSISTENCE_XML_IGNORE","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.log","optional":false,"withinAMap":false,"sectionDetails":"= Logging configuration","sectionDetailsTitle":"Logging configuration","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.deployment.HibernateOrmConfig.HibernateOrmConfigLog","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.bind-parameters","additionalKeys":[],"configDoc":"Logs SQL bind parameters.\n\nSetting it to true is obviously not recommended in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"bind-parameters","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.statistics","additionalKeys":[],"configDoc":"Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"statistics","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_STATISTICS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.log-session-metrics","additionalKeys":[],"configDoc":"Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled (`quarkus.hibernate-orm.statistics`). The default is false (which means both `statistics` and `log-session-metrics` need to be enabled for the session metrics to appear in the log).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"log-session-metrics","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_SESSION_METRICS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published if a metrics extension is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_METRICS_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfig index 711969d2c2c..f5e0842b4aa 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.active","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".active"],"configDoc":"Whether this persistence unit should be active at runtime.\n\nSee xref:hibernate-orm.adoc#persistence-unit-active[this section of the documentation].\n\nIf the persistence unit is not active, it won't start with the application,\nand accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session\nwill not be possible.\n\nNote that if Hibernate ORM is disabled (i.e. `quarkus.hibernate-orm.enabled` is set to `false`),\nall persistence units are deactivated, and setting this property to `true` will fail.","withinAMap":true,"defaultValue":"'true' if Hibernate ORM is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_ACTIVE","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.database","optional":false,"withinAMap":true,"sectionDetails":"== Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.database.generation","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.generation"],"configDoc":"Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.database.generation.create-schemas","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.generation.create-schemas"],"configDoc":"If Hibernate ORM should create the schemas automatically (for databases supporting them).","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"create-schemas","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.database.generation.halt-on-error","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.generation.halt-on-error"],"configDoc":"Whether we should stop on the first error when applying the schema.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"halt-on-error","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.database.default-catalog","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.default-catalog"],"configDoc":"The default catalog to use for the database objects.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-catalog","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.database.default-schema","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.default-schema"],"configDoc":"The default schema to use for the database objects.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-schema","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.scripts","optional":false,"withinAMap":true,"sectionDetails":"== Database scripts related configuration","sectionDetailsTitle":"Database scripts related configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitScripts","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.scripts.generation","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".scripts.generation"],"configDoc":"Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.scripts.generation.create-target","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".scripts.generation.create-target"],"configDoc":"Filename or URL where the database create DDL file should be generated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-target","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.scripts.generation.drop-target","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".scripts.generation.drop-target"],"configDoc":"Filename or URL where the database drop DDL file should be generated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"drop-target","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.log","optional":false,"withinAMap":true,"sectionDetails":"== Logging configuration","sectionDetailsTitle":"Logging configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.sql","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.sql"],"configDoc":"Show SQL logs and format them nicely.\n\nSetting it to true is obviously not recommended in production.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.format-sql","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.format-sql"],"configDoc":"Format the SQL logs if SQL log is enabled","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"format-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.log.jdbc-warnings","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.jdbc-warnings"],"configDoc":"Whether JDBC warnings should be collected and logged.","withinAMap":true,"defaultValue":"depends on dialect","javaDocSiteLink":"","docMapKey":"jdbc-warnings","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.hibernate-orm.log.queries-slower-than-ms","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.queries-slower-than-ms"],"configDoc":"If set, Hibernate will log queries that took more than specified number of milliseconds to execute.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"queries-slower-than-ms","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.unsupported-properties.\"full-property-key\"","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".unsupported-properties.\"full-property-key\""],"configDoc":"Properties that should be passed on directly to Hibernate ORM.\nUse the full configuration property key here,\nfor instance `quarkus.hibernate-orm.unsupported-properties.\"hibernate.order_inserts\" = true`.\n\n[WARNING]\n====\nProperties set here are completely unsupported:\nas Quarkus doesn't generally know about these properties and their purpose,\nthere is absolutely no guarantee that they will work correctly,\nand even if they do, that may change when upgrading to a newer version of Quarkus\n(even just a micro/patch version).\n====\n\nConsider using a supported configuration property before falling back to unsupported ones.\nIf none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus,\nand more importantly so that the configuration property is tested regularly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"full-property-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.active","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".active"],"configDoc":"Whether this persistence unit should be active at runtime.\n\nSee xref:hibernate-orm.adoc#persistence-unit-active[this section of the documentation].\n\nIf the persistence unit is not active, it won't start with the application,\nand accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session\nwill not be possible.\n\nNote that if Hibernate ORM is disabled (i.e. `quarkus.hibernate-orm.enabled` is set to `false`),\nall persistence units are deactivated, and setting this property to `true` will fail.","withinAMap":true,"defaultValue":"'true' if Hibernate ORM is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_ACTIVE","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-orm.database","optional":false,"withinAMap":true,"sectionDetails":"== Database related configuration","sectionDetailsTitle":"Database related configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.database.generation","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.generation"],"configDoc":"Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.database.generation.create-schemas","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.generation.create-schemas"],"configDoc":"If Hibernate ORM should create the schemas automatically (for databases supporting them).","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"create-schemas","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.database.generation.halt-on-error","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.generation.halt-on-error"],"configDoc":"Whether we should stop on the first error when applying the schema.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"halt-on-error","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.database.default-catalog","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.default-catalog"],"configDoc":"The default catalog to use for the database objects.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-catalog","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.database.default-schema","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".database.default-schema"],"configDoc":"The default schema to use for the database objects.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"default-schema","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.scripts","optional":false,"withinAMap":true,"sectionDetails":"== Database scripts related configuration","sectionDetailsTitle":"Database scripts related configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitScripts","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.scripts.generation","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".scripts.generation"],"configDoc":"Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.","withinAMap":true,"defaultValue":"none","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"generation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.scripts.generation.create-target","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".scripts.generation.create-target"],"configDoc":"Filename or URL where the database create DDL file should be generated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-target","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-orm.scripts.generation.drop-target","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".scripts.generation.drop-target"],"configDoc":"Filename or URL where the database drop DDL file should be generated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"drop-target","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.hibernate-orm.log","optional":false,"withinAMap":true,"sectionDetails":"== Logging configuration","sectionDetailsTitle":"Logging configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-orm","configGroupType":"io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.sql","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.sql"],"configDoc":"Show SQL logs and format them nicely.\n\nSetting it to true is obviously not recommended in production.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.format-sql","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.format-sql"],"configDoc":"Format the SQL logs if SQL log is enabled","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"format-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-orm.log.highlight-sql","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.highlight-sql"],"configDoc":"Highlight the SQL logs if SQL log is enabled","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"highlight-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-orm.log.jdbc-warnings","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.jdbc-warnings"],"configDoc":"Whether JDBC warnings should be collected and logged.","withinAMap":true,"defaultValue":"depends on dialect","javaDocSiteLink":"","docMapKey":"jdbc-warnings","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.hibernate-orm.log.queries-slower-than-ms","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".log.queries-slower-than-ms"],"configDoc":"If set, Hibernate will log queries that took more than specified number of milliseconds to execute.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"queries-slower-than-ms","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.hibernate-orm.unsupported-properties.\"full-property-key\"","additionalKeys":["quarkus.hibernate-orm.\"persistence-unit-name\".unsupported-properties.\"full-property-key\""],"configDoc":"Properties that should be passed on directly to Hibernate ORM.\nUse the full configuration property key here,\nfor instance `quarkus.hibernate-orm.unsupported-properties.\"hibernate.order_inserts\" = true`.\n\n[WARNING]\n====\nProperties set here are completely unsupported:\nas Quarkus doesn't generally know about these properties and their purpose,\nthere is absolutely no guarantee that they will work correctly,\nand even if they do, that may change when upgrading to a newer version of Quarkus\n(even just a micro/patch version).\n====\n\nConsider using a supported configuration property before falling back to unsupported ones.\nIf none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus,\nand more importantly so that the configuration property is tested regularly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"full-property-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-orm","since":null,"environmentVariable":"QUARKUS_HIBERNATE_ORM_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientsBuildTimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientsBuildTimeConfig index d9c4ffeef62..93727d63a9a 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientsBuildTimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.infinispan.client.runtime.InfinispanClientsBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.marshaller-class","additionalKeys":[],"configDoc":"Sets the marshallerClass. Default is ProtoStreamMarshaller","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"marshaller-class","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_MARSHALLER_CLASS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.cache.\"cache\".configuration-resource","additionalKeys":[],"configDoc":"Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configuration-resource","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__CONFIGURATION_RESOURCE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.infinispan-client.devservices.tracing.enabled","additionalKeys":[],"configDoc":"Runs the Infinispan Server container with tracing enabled. Traces are disabled by default","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317","withinAMap":false,"defaultValue":"http://localhost:4317","javaDocSiteLink":"","docMapKey":"exporter-otlp-endpoint","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.infinispan-client.devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CONFIG_FILES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".marshaller-class","additionalKeys":[],"configDoc":"Sets the marshallerClass. Default is ProtoStreamMarshaller","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"marshaller-class","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__MARSHALLER_CLASS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".cache.\"cache\".configuration-resource","additionalKeys":[],"configDoc":"Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configuration-resource","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__CACHE__CACHE__CONFIGURATION_RESOURCE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":true,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.tracing.enabled","additionalKeys":[],"configDoc":"Runs the Infinispan Server container with tracing enabled. Traces are disabled by default","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.tracing.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317","withinAMap":true,"defaultValue":"http://localhost:4317","javaDocSiteLink":"","docMapKey":"exporter-otlp-endpoint","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_CONFIG_FILES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.health.enabled","additionalKeys":[],"configDoc":"Whether or not a health check is published in case the smallrye-health extension is present.\n\nThis is a global setting and is not specific to an Infinispan Client.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"health-enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_HEALTH_ENABLED","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.marshaller-class","additionalKeys":[],"configDoc":"Sets the marshallerClass. Default is ProtoStreamMarshaller","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"marshaller-class","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_MARSHALLER_CLASS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.cache.\"cache\".configuration-resource","additionalKeys":[],"configDoc":"Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configuration-resource","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__CONFIGURATION_RESOURCE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":false,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.infinispan-client.devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CONFIG_FILES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".marshaller-class","additionalKeys":[],"configDoc":"Sets the marshallerClass. Default is ProtoStreamMarshaller","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"marshaller-class","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__MARSHALLER_CLASS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".cache.\"cache\".configuration-resource","additionalKeys":[],"configDoc":"Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configuration-resource","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__CACHE__CACHE__CONFIGURATION_RESOURCE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.create-default-client","additionalKeys":[],"configDoc":"When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-default-client","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_CREATE_DEFAULT_CLIENT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.shared","additionalKeys":[],"configDoc":"Indicates if the Infinispan server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Infinispan starts a new container.\n\nThe discovery uses the `quarkus-dev-service-infinispan` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-infinispan` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Infinispan looks for a container with the `quarkus-dev-service-infinispan` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-infinispan` label set to the specified value.\n\nThis property is used when you need multiple shared Infinispan servers.","withinAMap":true,"defaultValue":"infinispan","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.image-name","additionalKeys":[],"configDoc":"The image to use. Note that only official Infinispan images are supported.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.artifacts","additionalKeys":[],"configDoc":"List of the artifacts to automatically download and add to the Infinispan server libraries.\n\nFor example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.\n\nIf an invalid value is passed, the Infinispan server will throw an error when trying to start.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifacts","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_ARTIFACTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.site","additionalKeys":[],"configDoc":"Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure `mcast-port` to avoid forming a cluster with any other running Infinispan Server container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"site","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_SITE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.mcast-port","additionalKeys":[],"configDoc":"If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mcast-port","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_MCAST_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.infinispan-client.\"named-infinispan-clients\".devservices.config-files","additionalKeys":[],"configDoc":"Infinispan Server configuration chunks to be passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"config-files","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_CONFIG_FILES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.infinispan-client.health.enabled","additionalKeys":[],"configDoc":"Whether or not a health check is published in case the smallrye-health extension is present.\n\nThis is a global setting and is not specific to an Infinispan Client.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"health-enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.infinispan-client","since":null,"environmentVariable":"QUARKUS_INFINISPAN_CLIENT_HEALTH_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.jfr.runtime.config.JfrRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.jfr.runtime.config.JfrRuntimeConfig new file mode 100644 index 00000000000..f68038285bf --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.jfr.runtime.config.JfrRuntimeConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":"quarkus.jfr.enabled","additionalKeys":[],"configDoc":"If false, only quarkus-jfr events are not recorded even if JFR is enabled. In this case, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true`","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jfr","since":null,"environmentVariable":"QUARKUS_JFR_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.jfr.rest.enabled","additionalKeys":[],"configDoc":"If false, only REST events in quarkus-jfr are not recorded even if JFR is enabled. In this case, other quarkus-jfr, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true`","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"rest-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jfr","since":null,"environmentVariable":"QUARKUS_JFR_REST_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig new file mode 100644 index 00000000000..7a149df433e --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":"quarkus.load-shedding.enabled","additionalKeys":[],"configDoc":"Whether load shedding should be enabled. Currently, this only applies to incoming HTTP requests.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.max-limit","additionalKeys":[],"configDoc":"The maximum number of concurrent requests allowed.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"max-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_MAX_LIMIT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.alpha-factor","additionalKeys":[],"configDoc":"The `alpha` factor of the Vegas overload detection algorithm.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"alpha-factor","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.beta-factor","additionalKeys":[],"configDoc":"The `beta` factor of the Vegas overload detection algorithm.","withinAMap":false,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"beta-factor","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_BETA_FACTOR","enum":false}},{"configDocKey":{"type":"double","key":"quarkus.load-shedding.probe-factor","additionalKeys":[],"configDoc":"The probe factor of the Vegas overload detection algorithm.","withinAMap":false,"defaultValue":"30.0","javaDocSiteLink":"","docMapKey":"probe-factor","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_PROBE_FACTOR","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.initial-limit","additionalKeys":[],"configDoc":"The initial limit of concurrent requests allowed.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"initial-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.load-shedding.priority.enabled","additionalKeys":[],"configDoc":"Whether priority load shedding should be enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mailer.runtime.MailersRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mailer.runtime.MailersRuntimeConfig index 09155f2b2aa..d5b416a9017 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mailer.runtime.MailersRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mailer.runtime.MailersRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.mailer.from","additionalKeys":[],"configDoc":"Sets the default `from` attribute when not specified in the `io.quarkus.mailer.Mail` instance. It's the sender email address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"from","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_FROM","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.mock","additionalKeys":[],"configDoc":"Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.\n\nDisabled by default on PROD, enabled by default on DEV and TEST modes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mock","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_MOCK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.bounce-address","additionalKeys":[],"configDoc":"Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bounce-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_BOUNCE_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.host","additionalKeys":[],"configDoc":"Sets the SMTP host name.","withinAMap":false,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_HOST","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.port","additionalKeys":[],"configDoc":"The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.username","additionalKeys":[],"configDoc":"Sets the username to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.password","additionalKeys":[],"configDoc":"Sets the password to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.ssl","additionalKeys":[],"configDoc":"Enables or disables the TLS/SSL.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ssl","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_SSL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.trust-all","additionalKeys":[],"configDoc":"Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_TRUST_ALL","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.mailer.max-pool-size","additionalKeys":[],"configDoc":"Sets the max number of open connections to the mail server.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.own-host-name","additionalKeys":[],"configDoc":"Sets the hostname to be used for HELO/EHLO and the Message-ID.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"own-host-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_OWN_HOST_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.keep-alive","additionalKeys":[],"configDoc":"Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.disable-esmtp","additionalKeys":[],"configDoc":"Disable ESMTP. 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.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-esmtp","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DISABLE_ESMTP","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.start-tls","additionalKeys":[],"configDoc":"Sets the TLS security mode for the connection. Either `DISABLED`, `OPTIONAL` or `REQUIRED`.","withinAMap":false,"defaultValue":"OPTIONAL","javaDocSiteLink":"","docMapKey":"start-tls","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_START_TLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.dkim.enabled","additionalKeys":[],"configDoc":"Enables DKIM signing.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.private-key","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key used to sign the email.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_PRIVATE_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.private-key-path","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key file path.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_PRIVATE_KEY_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.auid","additionalKeys":[],"configDoc":"Configures the Agent or User Identifier (AUID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_AUID","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.selector","additionalKeys":[],"configDoc":"Configures the selector used to query the public key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"selector","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SELECTOR","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.sdid","additionalKeys":[],"configDoc":"Configures the Signing Domain Identifier (SDID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sdid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SDID","enum":false}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.dkim.header-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for signed headers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_HEADER_CANON_ALGO","enum":true}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.dkim.body-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for mail body.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_BODY_CANON_ALGO","enum":true}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.dkim.body-limit","additionalKeys":[],"configDoc":"Configures the body limit to sign. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.dkim.signature-timestamp","additionalKeys":[],"configDoc":"Configures to enable or disable signature sign timestamp.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-timestamp","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SIGNATURE_TIMESTAMP","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.mailer.dkim.expire-time","additionalKeys":[],"configDoc":"Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"expire-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_EXPIRE_TIME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.signed-headers","additionalKeys":[],"configDoc":"Configures the signed headers in DKIM, separated by commas. The order in the list matters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signed-headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SIGNED_HEADERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.login","additionalKeys":[],"configDoc":"Sets the login mode for the connection. Either `NONE`, @++{++code DISABLED++}++, `OPTIONAL`, `REQUIRED` or `XOAUTH2`.\n\n - DISABLED means no login will be attempted\n - NONE means a login will be attempted if the server supports in and login credentials are set\n - REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise\n - XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"login","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_LOGIN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.auth-methods","additionalKeys":[],"configDoc":"Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_AUTH_METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.truststore.password","additionalKeys":[],"configDoc":"Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_TRUSTSTORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.truststore.paths","additionalKeys":[],"configDoc":"Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths.\n\nThe relative paths are relative to the application working directly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_TRUSTSTORE_PATHS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.truststore.type","additionalKeys":[],"configDoc":"Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_TRUSTSTORE_TYPE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.multi-part-only","additionalKeys":[],"configDoc":"Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"multi-part-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_MULTI_PART_ONLY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.allow-rcpt-errors","additionalKeys":[],"configDoc":"Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-rcpt-errors","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_ALLOW_RCPT_ERRORS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.pipelining","additionalKeys":[],"configDoc":"Enables or disables the pipelining capability if the SMTP server supports it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pipelining","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_PIPELINING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.pool-cleaner-period","additionalKeys":[],"configDoc":"Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_POOL_CLEANER_PERIOD","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.keep-alive-timeout","additionalKeys":[],"configDoc":"Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.","withinAMap":false,"defaultValue":"PT300S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.ntlm.workstation","additionalKeys":[],"configDoc":"Sets the workstation used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"workstation","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_NTLM_WORKSTATION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.ntlm.domain","additionalKeys":[],"configDoc":"Sets the domain used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_NTLM_DOMAIN","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.mailer.approved-recipients","additionalKeys":[],"configDoc":"Allows sending emails to these recipients only.\n\nApproved recipients are compiled to a `Pattern` and must be a valid regular expression. The created `Pattern` is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"approved-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_APPROVED_RECIPIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.log-rejected-recipients","additionalKeys":[],"configDoc":"Log rejected recipients as warnings.\n\nIf false, the rejected recipients will be logged at the DEBUG level.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-rejected-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_LOG_REJECTED_RECIPIENTS","enum":false}},{"configDocSection":{"name":"quarkus.mailer.named-mailers","optional":false,"withinAMap":false,"sectionDetails":"= Additional named mailers","sectionDetailsTitle":"Additional named mailers","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.mailer","configGroupType":"io.quarkus.mailer.runtime.MailerRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".from","additionalKeys":[],"configDoc":"Sets the default `from` attribute when not specified in the `io.quarkus.mailer.Mail` instance. It's the sender email address.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"from","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__FROM","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.\"mailer-name\".mock","additionalKeys":[],"configDoc":"Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.\n\nDisabled by default on PROD, enabled by default on DEV and TEST modes.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mock","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__MOCK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".bounce-address","additionalKeys":[],"configDoc":"Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bounce-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__BOUNCE_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".host","additionalKeys":[],"configDoc":"Sets the SMTP host name.","withinAMap":true,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__HOST","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.\"mailer-name\".port","additionalKeys":[],"configDoc":"The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".username","additionalKeys":[],"configDoc":"Sets the username to connect to the SMTP server.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".password","additionalKeys":[],"configDoc":"Sets the password to connect to the SMTP server.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".ssl","additionalKeys":[],"configDoc":"Enables or disables the TLS/SSL.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ssl","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__SSL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.\"mailer-name\".trust-all","additionalKeys":[],"configDoc":"Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__TRUST_ALL","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.mailer.\"mailer-name\".max-pool-size","additionalKeys":[],"configDoc":"Sets the max number of open connections to the mail server.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".own-host-name","additionalKeys":[],"configDoc":"Sets the hostname to be used for HELO/EHLO and the Message-ID.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"own-host-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__OWN_HOST_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".keep-alive","additionalKeys":[],"configDoc":"Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".disable-esmtp","additionalKeys":[],"configDoc":"Disable ESMTP. 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.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-esmtp","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".start-tls","additionalKeys":[],"configDoc":"Sets the TLS security mode for the connection. Either `DISABLED`, `OPTIONAL` or `REQUIRED`.","withinAMap":true,"defaultValue":"OPTIONAL","javaDocSiteLink":"","docMapKey":"start-tls","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__START_TLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".dkim.enabled","additionalKeys":[],"configDoc":"Enables DKIM signing.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.private-key","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key used to sign the email.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_PRIVATE_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.private-key-path","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key file path.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_PRIVATE_KEY_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.auid","additionalKeys":[],"configDoc":"Configures the Agent or User Identifier (AUID).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_AUID","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.selector","additionalKeys":[],"configDoc":"Configures the selector used to query the public key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"selector","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SELECTOR","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.sdid","additionalKeys":[],"configDoc":"Configures the Signing Domain Identifier (SDID).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sdid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SDID","enum":false}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.\"mailer-name\".dkim.header-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for signed headers.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_HEADER_CANON_ALGO","enum":true}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.\"mailer-name\".dkim.body-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for mail body.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_BODY_CANON_ALGO","enum":true}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.\"mailer-name\".dkim.body-limit","additionalKeys":[],"configDoc":"Configures the body limit to sign. Must be greater than zero.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.\"mailer-name\".dkim.signature-timestamp","additionalKeys":[],"configDoc":"Configures to enable or disable signature sign timestamp.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-timestamp","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SIGNATURE_TIMESTAMP","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.mailer.\"mailer-name\".dkim.expire-time","additionalKeys":[],"configDoc":"Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"expire-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_EXPIRE_TIME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.signed-headers","additionalKeys":[],"configDoc":"Configures the signed headers in DKIM, separated by commas. The order in the list matters.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signed-headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SIGNED_HEADERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".login","additionalKeys":[],"configDoc":"Sets the login mode for the connection. Either `NONE`, @++{++code DISABLED++}++, `OPTIONAL`, `REQUIRED` or `XOAUTH2`.\n\n - DISABLED means no login will be attempted\n - NONE means a login will be attempted if the server supports in and login credentials are set\n - REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise\n - XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens","withinAMap":true,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"login","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__LOGIN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".auth-methods","additionalKeys":[],"configDoc":"Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".truststore.password","additionalKeys":[],"configDoc":"Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".truststore.paths","additionalKeys":[],"configDoc":"Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths.\n\nThe relative paths are relative to the application working directly.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".truststore.type","additionalKeys":[],"configDoc":"Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".multi-part-only","additionalKeys":[],"configDoc":"Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"multi-part-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__MULTI_PART_ONLY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".allow-rcpt-errors","additionalKeys":[],"configDoc":"Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-rcpt-errors","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__ALLOW_RCPT_ERRORS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".pipelining","additionalKeys":[],"configDoc":"Enables or disables the pipelining capability if the SMTP server supports it.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pipelining","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__PIPELINING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.\"mailer-name\".pool-cleaner-period","additionalKeys":[],"configDoc":"Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.","withinAMap":true,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__POOL_CLEANER_PERIOD","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.\"mailer-name\".keep-alive-timeout","additionalKeys":[],"configDoc":"Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.","withinAMap":true,"defaultValue":"PT300S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".ntlm.workstation","additionalKeys":[],"configDoc":"Sets the workstation used on NTLM authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"workstation","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__NTLM_WORKSTATION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".ntlm.domain","additionalKeys":[],"configDoc":"Sets the domain used on NTLM authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__NTLM_DOMAIN","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.mailer.\"mailer-name\".approved-recipients","additionalKeys":[],"configDoc":"Allows sending emails to these recipients only.\n\nApproved recipients are compiled to a `Pattern` and must be a valid regular expression. The created `Pattern` is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"approved-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__APPROVED_RECIPIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".log-rejected-recipients","additionalKeys":[],"configDoc":"Log rejected recipients as warnings.\n\nIf false, the rejected recipients will be logged at the DEBUG level.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-rejected-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__LOG_REJECTED_RECIPIENTS","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.mailer.from","additionalKeys":[],"configDoc":"Sets the default `from` attribute when not specified in the `io.quarkus.mailer.Mail` instance. It's the sender email address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"from","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_FROM","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.mock","additionalKeys":[],"configDoc":"Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.\n\nDisabled by default on PROD, enabled by default on DEV and TEST modes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mock","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_MOCK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.bounce-address","additionalKeys":[],"configDoc":"Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bounce-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_BOUNCE_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.host","additionalKeys":[],"configDoc":"Sets the SMTP host name.","withinAMap":false,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_HOST","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.port","additionalKeys":[],"configDoc":"The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely.\n\nNote that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.username","additionalKeys":[],"configDoc":"Sets the username to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.password","additionalKeys":[],"configDoc":"Sets the password to connect to the SMTP server.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used.\n\nThe default TLS configuration is *not* used by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.tls","additionalKeys":[],"configDoc":"Whether the connection should be secured using TLS.\n\nSMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_TLS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.mailer.max-pool-size","additionalKeys":[],"configDoc":"Sets the max number of open connections to the mail server.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.own-host-name","additionalKeys":[],"configDoc":"Sets the hostname to be used for HELO/EHLO and the Message-ID.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"own-host-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_OWN_HOST_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.keep-alive","additionalKeys":[],"configDoc":"Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.disable-esmtp","additionalKeys":[],"configDoc":"Disable ESMTP.\n\nThe 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.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-esmtp","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DISABLE_ESMTP","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.start-tls","additionalKeys":[],"configDoc":"Sets the TLS security mode for the connection. Either `DISABLED`, `OPTIONAL` or `REQUIRED`.","withinAMap":false,"defaultValue":"OPTIONAL","javaDocSiteLink":"","docMapKey":"start-tls","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_START_TLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.dkim.enabled","additionalKeys":[],"configDoc":"Enables DKIM signing.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.private-key","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key used to sign the email.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_PRIVATE_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.private-key-path","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key file path.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_PRIVATE_KEY_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.auid","additionalKeys":[],"configDoc":"Configures the Agent or User Identifier (AUID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_AUID","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.selector","additionalKeys":[],"configDoc":"Configures the selector used to query the public key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"selector","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SELECTOR","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.sdid","additionalKeys":[],"configDoc":"Configures the Signing Domain Identifier (SDID).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sdid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SDID","enum":false}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.dkim.header-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for signed headers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_HEADER_CANON_ALGO","enum":true}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.dkim.body-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for mail body.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_BODY_CANON_ALGO","enum":true}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.dkim.body-limit","additionalKeys":[],"configDoc":"Configures the body limit to sign. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.dkim.signature-timestamp","additionalKeys":[],"configDoc":"Configures to enable or disable signature sign timestamp.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-timestamp","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SIGNATURE_TIMESTAMP","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.mailer.dkim.expire-time","additionalKeys":[],"configDoc":"Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"expire-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_EXPIRE_TIME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.dkim.signed-headers","additionalKeys":[],"configDoc":"Configures the signed headers in DKIM, separated by commas. The order in the list matters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signed-headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_DKIM_SIGNED_HEADERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.login","additionalKeys":[],"configDoc":"Sets the login mode for the connection. Either `NONE`, @++{++code DISABLED++}++, `OPTIONAL`, `REQUIRED` or `XOAUTH2`.\n\n - DISABLED means no login will be attempted\n - NONE means a login will be attempted if the server supports in and login credentials are set\n - REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise\n - XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"login","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_LOGIN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.auth-methods","additionalKeys":[],"configDoc":"Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used.\n\nThe list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_AUTH_METHODS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.multi-part-only","additionalKeys":[],"configDoc":"Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"multi-part-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_MULTI_PART_ONLY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.allow-rcpt-errors","additionalKeys":[],"configDoc":"Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-rcpt-errors","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_ALLOW_RCPT_ERRORS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.pipelining","additionalKeys":[],"configDoc":"Enables or disables the pipelining capability if the SMTP server supports it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pipelining","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_PIPELINING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.pool-cleaner-period","additionalKeys":[],"configDoc":"Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_POOL_CLEANER_PERIOD","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.keep-alive-timeout","additionalKeys":[],"configDoc":"Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.","withinAMap":false,"defaultValue":"PT300S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.ntlm.workstation","additionalKeys":[],"configDoc":"Sets the workstation used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"workstation","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_NTLM_WORKSTATION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.ntlm.domain","additionalKeys":[],"configDoc":"Sets the domain used on NTLM authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_NTLM_DOMAIN","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.mailer.approved-recipients","additionalKeys":[],"configDoc":"Allows sending emails to these recipients only.\n\nApproved recipients are compiled to a `Pattern` and must be a valid regular expression. The created `Pattern` is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"approved-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_APPROVED_RECIPIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.log-rejected-recipients","additionalKeys":[],"configDoc":"Log rejected recipients as warnings.\n\nIf false, the rejected recipients will be logged at the DEBUG level.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-rejected-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER_LOG_REJECTED_RECIPIENTS","enum":false}},{"configDocSection":{"name":"quarkus.mailer.named-mailers","optional":false,"withinAMap":false,"sectionDetails":"= Additional named mailers","sectionDetailsTitle":"Additional named mailers","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.mailer","configGroupType":"io.quarkus.mailer.runtime.MailerRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".from","additionalKeys":[],"configDoc":"Sets the default `from` attribute when not specified in the `io.quarkus.mailer.Mail` instance. It's the sender email address.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"from","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__FROM","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.\"mailer-name\".mock","additionalKeys":[],"configDoc":"Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.\n\nDisabled by default on PROD, enabled by default on DEV and TEST modes.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"mock","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__MOCK","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".bounce-address","additionalKeys":[],"configDoc":"Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bounce-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__BOUNCE_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".host","additionalKeys":[],"configDoc":"Sets the SMTP host name.","withinAMap":true,"defaultValue":"localhost","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__HOST","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.\"mailer-name\".port","additionalKeys":[],"configDoc":"The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely.\n\nNote that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".username","additionalKeys":[],"configDoc":"Sets the username to connect to the SMTP server.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".password","additionalKeys":[],"configDoc":"Sets the password to connect to the SMTP server.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used.\n\nThe default TLS configuration is *not* used by default.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.\"mailer-name\".tls","additionalKeys":[],"configDoc":"Whether the connection should be secured using TLS.\n\nSMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__TLS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.mailer.\"mailer-name\".max-pool-size","additionalKeys":[],"configDoc":"Sets the max number of open connections to the mail server.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".own-host-name","additionalKeys":[],"configDoc":"Sets the hostname to be used for HELO/EHLO and the Message-ID.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"own-host-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__OWN_HOST_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".keep-alive","additionalKeys":[],"configDoc":"Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".disable-esmtp","additionalKeys":[],"configDoc":"Disable ESMTP.\n\nThe 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.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-esmtp","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".start-tls","additionalKeys":[],"configDoc":"Sets the TLS security mode for the connection. Either `DISABLED`, `OPTIONAL` or `REQUIRED`.","withinAMap":true,"defaultValue":"OPTIONAL","javaDocSiteLink":"","docMapKey":"start-tls","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__START_TLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".dkim.enabled","additionalKeys":[],"configDoc":"Enables DKIM signing.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.private-key","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key used to sign the email.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_PRIVATE_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.private-key-path","additionalKeys":[],"configDoc":"Configures the PKCS++#++8 format private key file path.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"private-key-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_PRIVATE_KEY_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.auid","additionalKeys":[],"configDoc":"Configures the Agent or User Identifier (AUID).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_AUID","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.selector","additionalKeys":[],"configDoc":"Configures the selector used to query the public key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"selector","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SELECTOR","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.sdid","additionalKeys":[],"configDoc":"Configures the Signing Domain Identifier (SDID).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sdid","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SDID","enum":false}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.\"mailer-name\".dkim.header-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for signed headers.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_HEADER_CANON_ALGO","enum":true}},{"configDocKey":{"type":"io.quarkus.mailer.runtime.DkimSignOptionsConfig.CanonicalizationAlgorithmOption","key":"quarkus.mailer.\"mailer-name\".dkim.body-canon-algo","additionalKeys":[],"configDoc":"Configures the canonicalization algorithm for mail body.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-canon-algo","configPhase":"RUN_TIME","acceptedValues":["`simple`","`relaxed`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_BODY_CANON_ALGO","enum":true}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mailer.\"mailer-name\".dkim.body-limit","additionalKeys":[],"configDoc":"Configures the body limit to sign. Must be greater than zero.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mailer.\"mailer-name\".dkim.signature-timestamp","additionalKeys":[],"configDoc":"Configures to enable or disable signature sign timestamp.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-timestamp","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SIGNATURE_TIMESTAMP","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.mailer.\"mailer-name\".dkim.expire-time","additionalKeys":[],"configDoc":"Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"expire-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_EXPIRE_TIME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".dkim.signed-headers","additionalKeys":[],"configDoc":"Configures the signed headers in DKIM, separated by commas. The order in the list matters.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signed-headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__DKIM_SIGNED_HEADERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".login","additionalKeys":[],"configDoc":"Sets the login mode for the connection. Either `NONE`, @++{++code DISABLED++}++, `OPTIONAL`, `REQUIRED` or `XOAUTH2`.\n\n - DISABLED means no login will be attempted\n - NONE means a login will be attempted if the server supports in and login credentials are set\n - REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise\n - XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens","withinAMap":true,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"login","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__LOGIN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".auth-methods","additionalKeys":[],"configDoc":"Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used.\n\nThe list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".multi-part-only","additionalKeys":[],"configDoc":"Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"multi-part-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__MULTI_PART_ONLY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".allow-rcpt-errors","additionalKeys":[],"configDoc":"Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-rcpt-errors","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__ALLOW_RCPT_ERRORS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".pipelining","additionalKeys":[],"configDoc":"Enables or disables the pipelining capability if the SMTP server supports it.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pipelining","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__PIPELINING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.\"mailer-name\".pool-cleaner-period","additionalKeys":[],"configDoc":"Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.","withinAMap":true,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__POOL_CLEANER_PERIOD","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.mailer.\"mailer-name\".keep-alive-timeout","additionalKeys":[],"configDoc":"Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.","withinAMap":true,"defaultValue":"PT300S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"keep-alive-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".ntlm.workstation","additionalKeys":[],"configDoc":"Sets the workstation used on NTLM authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"workstation","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__NTLM_WORKSTATION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mailer.\"mailer-name\".ntlm.domain","additionalKeys":[],"configDoc":"Sets the domain used on NTLM authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__NTLM_DOMAIN","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.mailer.\"mailer-name\".approved-recipients","additionalKeys":[],"configDoc":"Allows sending emails to these recipients only.\n\nApproved recipients are compiled to a `Pattern` and must be a valid regular expression. The created `Pattern` is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"approved-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__APPROVED_RECIPIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mailer.\"mailer-name\".log-rejected-recipients","additionalKeys":[],"configDoc":"Log rejected recipients as warnings.\n\nIf false, the rejected recipients will be logged at the DEBUG level.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-rejected-recipients","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mailer","since":null,"environmentVariable":"QUARKUS_MAILER__MAILER_NAME__LOG_REJECTED_RECIPIENTS","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig index 82eadaf6758..2cbbbeee507 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.health.enabled","additionalKeys":[],"configDoc":"Whether a health check is published in case the smallrye-health extension is present.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"health-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_HEALTH_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published in case a metrics extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_METRICS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.force-default-clients","additionalKeys":[],"configDoc":"If set to true, the default clients will always be created even if there are no injection points that use them","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-default-clients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_FORCE_DEFAULT_CLIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.tracing.enabled","additionalKeys":[],"configDoc":"Whether or not tracing spans of driver commands are sent in case the quarkus-opentelemetry extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mongodb.devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mongodb.devservices.image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mongodb.devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.mongodb.devservices.properties.\"property-key\"","additionalKeys":[],"configDoc":"Generic properties that are added to the connection URL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"property-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_PROPERTIES__PROPERTY_KEY_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.mongodb.devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.health.enabled","additionalKeys":[],"configDoc":"Whether a health check is published in case the smallrye-health extension is present.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"health-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_HEALTH_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published in case a metrics extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_METRICS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.force-default-clients","additionalKeys":[],"configDoc":"If set to true, the default clients will always be created even if there are no injection points that use them","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-default-clients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_FORCE_DEFAULT_CLIENTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.tracing.enabled","additionalKeys":[],"configDoc":"Whether or not tracing spans of driver commands are sent in case the quarkus-opentelemetry extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mongodb.devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mongodb.devservices.image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mongodb.devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.mongodb.devservices.properties.\"property-key\"","additionalKeys":[],"configDoc":"Generic properties that are added to the connection URL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"property-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_PROPERTIES__PROPERTY_KEY_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.mongodb.devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.devservices.shared","additionalKeys":[],"configDoc":"Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container.\n\nThe discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mongodb.devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value.","withinAMap":false,"defaultValue":"mongodb","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","since":null,"environmentVariable":"QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration new file mode 100644 index 00000000000..656be619e14 --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":"quarkus.lra.openapi.included","additionalKeys":[],"configDoc":"Whether to include LRA proxy endpoints in the generated OpenAPI document","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"openapi-included","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.lra","since":null,"environmentVariable":"QUARKUS_LRA_OPENAPI_INCLUDED","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.KeycloakBuildTimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.KeycloakBuildTimeConfig index a66c4866f35..3c9b8dd01c7 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.KeycloakBuildTimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.deployment.devservices.keycloak.KeycloakBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.enabled","additionalKeys":[],"configDoc":"Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.image-name","additionalKeys":[],"configDoc":"The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`.","withinAMap":false,"defaultValue":"quay.io/keycloak/keycloak:23.0.7","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.keycloak.devservices.keycloak-x-image","additionalKeys":[],"configDoc":"Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keycloak-x-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.shared","additionalKeys":[],"configDoc":"Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.realm-path","additionalKeys":[],"configDoc":"A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.resource-aliases.\"alias-name\"","additionalKeys":[],"configDoc":"Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"alias-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.resource-mappings.\"resource-name\"","additionalKeys":[],"configDoc":"Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"resource-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.java-opts","additionalKeys":[],"configDoc":"The `JAVA_OPTS` passed to the keycloak JVM","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"java-opts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.show-logs","additionalKeys":[],"configDoc":"Show Keycloak log messages with a \"Keycloak:\" prefix.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"show-logs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.start-command","additionalKeys":[],"configDoc":"Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"start-command","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.realm-name","additionalKeys":[],"configDoc":"The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.create-realm","additionalKeys":[],"configDoc":"Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.users.\"users\"","additionalKeys":[],"configDoc":"A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"users","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.keycloak.devservices.roles.\"role-name\"","additionalKeys":[],"configDoc":"A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.keycloak.devservices.port","additionalKeys":[],"configDoc":"The specific port for the dev service to listen on.\n\nIf not specified, a random port is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables to be passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.enabled","additionalKeys":[],"configDoc":"Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.image-name","additionalKeys":[],"configDoc":"The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`.","withinAMap":false,"defaultValue":"quay.io/keycloak/keycloak:24.0.4","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.keycloak.devservices.keycloak-x-image","additionalKeys":[],"configDoc":"Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keycloak-x-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.shared","additionalKeys":[],"configDoc":"Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.realm-path","additionalKeys":[],"configDoc":"A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.resource-aliases.\"alias-name\"","additionalKeys":[],"configDoc":"Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"alias-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.resource-mappings.\"resource-name\"","additionalKeys":[],"configDoc":"Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"resource-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.java-opts","additionalKeys":[],"configDoc":"The `JAVA_OPTS` passed to the keycloak JVM","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"java-opts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.show-logs","additionalKeys":[],"configDoc":"Show Keycloak log messages with a \"Keycloak:\" prefix.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"show-logs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.start-command","additionalKeys":[],"configDoc":"Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"start-command","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.keycloak.devservices.realm-name","additionalKeys":[],"configDoc":"The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.keycloak.devservices.create-realm","additionalKeys":[],"configDoc":"Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"create-realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.users.\"users\"","additionalKeys":[],"configDoc":"A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"users","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.keycloak.devservices.roles.\"role-name\"","additionalKeys":[],"configDoc":"A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.keycloak.devservices.port","additionalKeys":[],"configDoc":"The specific port for the dev service to listen on.\n\nIf not specified, a random port is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_PORT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.keycloak.devservices.container-env.\"environment-variable-name\"","additionalKeys":[],"configDoc":"Environment variables to be passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"environment-variable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.keycloak","since":null,"environmentVariable":"QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.build.OTelBuildConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.build.OTelBuildConfig index 16f51fcf04d..346d0c34d19 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.build.OTelBuildConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.build.OTelBuildConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.otel.traces.exporter","additionalKeys":[],"configDoc":"List of exporters supported by Quarkus.\n\nList of exporters to be used for tracing, separated by commas. Has one of the values on `ExporterType` `otlp`, `cdi`, `none` or the full qualified name of a class implementing `io.opentelemetry.sdk.trace.export.SpanExporter`\n\nDefault on Quarkus is `ExporterType.Constants++#++CDI_VALUE`.","withinAMap":false,"defaultValue":"cdi","javaDocSiteLink":"","docMapKey":"exporter","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_TRACES_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.traces.sampler","additionalKeys":[],"configDoc":"The sampler to use for tracing.\n\nHas one of the values on `SamplerType` `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the `io.opentelemetry.sdk.trace.samplers.Sampler` implementation set in the provider: `io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider`.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.sampler.name` or defaults to `SamplerType.Constants++#++PARENT_BASED_ALWAYS_ON`.","withinAMap":false,"defaultValue":"parentbased_always_on","javaDocSiteLink":"","docMapKey":"sampler","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_TRACES_SAMPLER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.metrics.exporter","additionalKeys":[],"configDoc":"No Metrics exporter for now","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"metrics-exporter","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_METRICS_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.logs.exporter","additionalKeys":[],"configDoc":"No Log exporter for now.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"logs-exporter","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_LOGS_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.propagators","additionalKeys":[],"configDoc":"The propagators to be used. Use a comma-separated list for multiple propagators.\n\nHas values from `PropagatorType` or the full qualified name of a class implementing `io.opentelemetry.context.propagation.TextMapPropagator`.\n\nDefault is `PropagatorType.Constants++#++TRACE_CONTEXT`,`PropagatorType.Constants++#++BAGGAGE` (W3C).","withinAMap":false,"defaultValue":"tracecontext,baggage","javaDocSiteLink":"","docMapKey":"propagators","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_PROPAGATORS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.grpc","additionalKeys":[],"configDoc":"Enables instrumentation for gRPC.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"grpc","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_GRPC","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.messaging","additionalKeys":[],"configDoc":"Enables instrumentation for Messaging.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"messaging","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_MESSAGING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.resteasy-client","additionalKeys":[],"configDoc":"Enables instrumentation for REST Client backed by RESTEasy Classic.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resteasy-client","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.rest","additionalKeys":[],"configDoc":"Enables instrumentation for Quarkus REST.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"rest","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_REST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.resteasy","additionalKeys":[],"configDoc":"Enables instrumentation for RESTEasy Classic.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resteasy","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_RESTEASY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.security-events.enabled","additionalKeys":[],"configDoc":"Whether exporting of the security events is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_SECURITY_EVENTS_ENABLED","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.build.OTelBuildConfig.SecurityEvents.SecurityEventType","key":"quarkus.otel.security-events.event-types","additionalKeys":[],"configDoc":"Selects security event types.","withinAMap":false,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"event-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`all`","`authentication-success`","`authentication-failure`","`authorization-success`","`authorization-failure`","`other`"],"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES","enum":true}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.otel.traces.exporter","additionalKeys":[],"configDoc":"List of exporters supported by Quarkus.\n\nList of exporters to be used for tracing, separated by commas. Has one of the values on `ExporterType` `otlp`, `cdi`, `none` or the full qualified name of a class implementing `io.opentelemetry.sdk.trace.export.SpanExporter`\n\nDefault on Quarkus is `ExporterType.Constants++#++CDI_VALUE`.","withinAMap":false,"defaultValue":"cdi","javaDocSiteLink":"","docMapKey":"exporter","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_TRACES_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.traces.sampler","additionalKeys":[],"configDoc":"The sampler to use for tracing.\n\nHas one of the values on `SamplerType` `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the `io.opentelemetry.sdk.trace.samplers.Sampler` implementation set in the provider: `io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider`.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.sampler.name` or defaults to `SamplerType.Constants++#++PARENT_BASED_ALWAYS_ON`.","withinAMap":false,"defaultValue":"parentbased_always_on","javaDocSiteLink":"","docMapKey":"sampler","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_TRACES_SAMPLER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.traces.eusp.enabled","additionalKeys":[],"configDoc":"If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"add-end-user-attributes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_TRACES_EUSP_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.metrics.exporter","additionalKeys":[],"configDoc":"No Metrics exporter for now","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"metrics-exporter","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_METRICS_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.logs.exporter","additionalKeys":[],"configDoc":"No Log exporter for now.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"","docMapKey":"logs-exporter","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_LOGS_EXPORTER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.propagators","additionalKeys":[],"configDoc":"The propagators to be used. Use a comma-separated list for multiple propagators.\n\nHas values from `PropagatorType` or the full qualified name of a class implementing `io.opentelemetry.context.propagation.TextMapPropagator`.\n\nDefault is `PropagatorType.Constants++#++TRACE_CONTEXT`,`PropagatorType.Constants++#++BAGGAGE` (W3C).","withinAMap":false,"defaultValue":"tracecontext,baggage","javaDocSiteLink":"","docMapKey":"propagators","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_PROPAGATORS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.grpc","additionalKeys":[],"configDoc":"Enables instrumentation for gRPC.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"grpc","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_GRPC","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.messaging","additionalKeys":[],"configDoc":"Enables instrumentation for Messaging.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"messaging","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_MESSAGING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.resteasy-client","additionalKeys":[],"configDoc":"Enables instrumentation for REST Client backed by RESTEasy Classic.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resteasy-client","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.rest","additionalKeys":[],"configDoc":"Enables instrumentation for Quarkus REST.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"rest","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_REST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.instrument.resteasy","additionalKeys":[],"configDoc":"Enables instrumentation for RESTEasy Classic.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resteasy","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_INSTRUMENT_RESTEASY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.security-events.enabled","additionalKeys":[],"configDoc":"Whether exporting of the security events is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_SECURITY_EVENTS_ENABLED","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.build.OTelBuildConfig.SecurityEvents.SecurityEventType","key":"quarkus.otel.security-events.event-types","additionalKeys":[],"configDoc":"Selects security event types.","withinAMap":false,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"event-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`all`","`authentication-success`","`authentication-failure`","`authorization-success`","`authorization-failure`","`other`"],"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","since":null,"environmentVariable":"QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES","enum":true}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterRuntimeConfig index 3e952850cc6..1e02a4176bb 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets the OTLP endpoint to connect to. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. We are currently using just the traces, therefore `quarkus.otel.exporter.otlp.traces.endpoint` is recommended.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_HEADERS","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":"quarkus.otel.exporter.otlp.traces.compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"RUN_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_COMPRESSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.exporter.otlp.traces.timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.\n\nCurrently, only `grpc` and `http/protobuf` are allowed.","withinAMap":false,"defaultValue":"grpc","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROTOCOL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TRUST_CERT_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.exporter.otlp.traces.proxy-options.enabled","additionalKeys":[],"configDoc":"If proxy connection must be used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.exporter.otlp.traces.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_HOST","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.endpoint","additionalKeys":[],"configDoc":"Sets the OTLP endpoint to connect to. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. We are currently using just the traces, therefore `quarkus.otel.exporter.otlp.traces.endpoint` is recommended.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_HEADERS","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":"quarkus.otel.exporter.otlp.traces.compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"RUN_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_COMPRESSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.exporter.otlp.traces.timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.\n\nCurrently, only `grpc` and `http/protobuf` are allowed.","withinAMap":false,"defaultValue":"grpc","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROTOCOL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TRUST_CERT_CERTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.otel.exporter.otlp.traces.proxy-options.enabled","additionalKeys":[],"configDoc":"If proxy connection must be used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.exporter.otlp.traces.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.exporter.otlp.traces.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel.exporter.otlp","since":null,"environmentVariable":"QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_HOST","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.redis.runtime.client.config.RedisConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.redis.runtime.client.config.RedisConfig index 15e34dcd1f4..1ba9fdafb65 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.redis.runtime.client.config.RedisConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.redis.runtime.client.config.RedisConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"java.net.URI","key":"quarkus.redis.hosts","additionalKeys":[],"configDoc":"The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.\n\nThe URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.hosts-provider-name","additionalKeys":[],"configDoc":"The hosts provider bean name.\n\nIt is the `&++#++64;Named` value of the hosts provider bean. It is used to discriminate if multiple `io.quarkus.redis.client.RedisHostsProvider` beans are available.\n\nUsed when `quarkus.redis.hosts` is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_HOSTS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.timeout","additionalKeys":[],"configDoc":"The maximum delay to wait before a blocking command to redis server times out","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TIMEOUT","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisClientType","key":"quarkus.redis.client-type","additionalKeys":[],"configDoc":"The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.","withinAMap":false,"defaultValue":"standalone","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisClientType.html","docMapKey":"client-type","configPhase":"RUN_TIME","acceptedValues":["`standalone`","`sentinel`","`cluster`","`replication`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_CLIENT_TYPE","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.master-name","additionalKeys":[],"configDoc":"The master name (only considered in HA mode).","withinAMap":false,"defaultValue":"mymaster","javaDocSiteLink":"","docMapKey":"master-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MASTER_NAME","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisRole","key":"quarkus.redis.role","additionalKeys":[],"configDoc":"The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.","withinAMap":false,"defaultValue":"master","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisRole.html","docMapKey":"role","configPhase":"RUN_TIME","acceptedValues":["`master`","`replica`","`sentinel`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_ROLE","enum":true}},{"configDocKey":{"type":"io.vertx.redis.client.RedisReplicas","key":"quarkus.redis.replicas","additionalKeys":[],"configDoc":"Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.","withinAMap":false,"defaultValue":"never","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisReplicas.html","docMapKey":"replicas","configPhase":"RUN_TIME","acceptedValues":["`never`","`share`","`always`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_REPLICAS","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.password","additionalKeys":[],"configDoc":"The default password for cluster/sentinel connections.\n\nIf not set it will try to extract the value from the current default `++#++hosts`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool. When working with cluster or sentinel.\n\nThis value should be at least the total number of cluster member (or number of sentinels {plus} 1)","withinAMap":false,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-pool-waiting","additionalKeys":[],"configDoc":"The maximum waiting requests for a connection from the pool.","withinAMap":false,"defaultValue":"24","javaDocSiteLink":"","docMapKey":"max-pool-waiting","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_POOL_WAITING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.pool-cleaner-interval","additionalKeys":[],"configDoc":"The duration indicating how often should the connection pool cleaner executes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_POOL_CLEANER_INTERVAL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.pool-recycle-timeout","additionalKeys":[],"configDoc":"The timeout for a connection recycling.","withinAMap":false,"defaultValue":"15S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-recycle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-waiting-handlers","additionalKeys":[],"configDoc":"Sets how many handlers is the client willing to queue.\n\nThe client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you're willing to accept.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-waiting-handlers","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_WAITING_HANDLERS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-nested-arrays","additionalKeys":[],"configDoc":"Tune how much nested arrays are allowed on a redis response. This affects the parser performance.","withinAMap":false,"defaultValue":"32","javaDocSiteLink":"","docMapKey":"max-nested-arrays","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_NESTED_ARRAYS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.protocol-negotiation","additionalKeys":[],"configDoc":"Should the client perform `RESP` protocol negotiation during the connection handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"protocol-negotiation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_PROTOCOL_NEGOTIATION","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.ProtocolVersion","key":"quarkus.redis.preferred-protocol-version","additionalKeys":[],"configDoc":"The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.","withinAMap":false,"defaultValue":"resp3","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/ProtocolVersion.html","docMapKey":"preferred-protocol-version","configPhase":"RUN_TIME","acceptedValues":["`resp2`","`resp3`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_PREFERRED_PROTOCOL_VERSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.hash-slot-cache-ttl","additionalKeys":[],"configDoc":"The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending `CLUSTER SLOTS` commands to the first statically configured cluster node.\n\nThis setting is only meaningful in case of a clustered Redis client and has no effect otherwise.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"hash-slot-cache-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_HASH_SLOT_CACHE_TTL","enum":false}},{"configDocSection":{"name":"quarkus.redis.tcp","optional":false,"withinAMap":false,"sectionDetails":"== TCP config","sectionDetailsTitle":"TCP config","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.redis","configGroupType":"io.quarkus.redis.runtime.client.config.NetConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.alpn","additionalKeys":[],"configDoc":"Set the ALPN usage.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_ALPN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.application-layer-protocols","additionalKeys":[],"configDoc":"Sets the list of application-layer protocols to provide to the server during the `Application-Layer Protocol Negotiation`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"application-layer-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_APPLICATION_LAYER_PROTOCOLS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.secure-transport-protocols","additionalKeys":[],"configDoc":"Sets the list of enabled SSL/TLS protocols.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secure-transport-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_SECURE_TRANSPORT_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.idle-timeout","additionalKeys":[],"configDoc":"Set the idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.connection-timeout","additionalKeys":[],"configDoc":"Set the connect timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.non-proxy-hosts","additionalKeys":[],"configDoc":"Set a list of remote hosts that are not proxied when the client is configured to use a proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.tcp.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port. Defaults to 3128.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_HOST","enum":false}},{"configDocKey":{"type":"io.vertx.core.net.ProxyType","key":"quarkus.redis.tcp.proxy-options.type","additionalKeys":[],"configDoc":"Set proxy type. Accepted values are: `HTTP` (default), `SOCKS4` and `SOCKS5`.","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/net/ProxyType.html","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":["`http`","`socks4`","`socks5`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_TYPE","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.read-idle-timeout","additionalKeys":[],"configDoc":"Set the read idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_READ_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.receive-buffer-size","additionalKeys":[],"configDoc":"Set the TCP receive buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"receive-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_RECEIVE_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.reconnect-attempts","additionalKeys":[],"configDoc":"Set the value of reconnect attempts.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.reconnect-interval","additionalKeys":[],"configDoc":"Set the reconnect interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.reuse-address","additionalKeys":[],"configDoc":"Whether to reuse the address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_REUSE_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.reuse-port","additionalKeys":[],"configDoc":"Whether to reuse the port.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_REUSE_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.send-buffer-size","additionalKeys":[],"configDoc":"Set the TCP send buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"send-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_SEND_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.so-linger","additionalKeys":[],"configDoc":"Set the `SO_linger` keep alive duration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"so-linger","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_SO_LINGER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.cork","additionalKeys":[],"configDoc":"Enable the `TCP_CORK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cork","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_CORK","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.fast-open","additionalKeys":[],"configDoc":"Enable the `TCP_FASTOPEN` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"fast-open","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.keep-alive","additionalKeys":[],"configDoc":"Set whether keep alive is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.no-delay","additionalKeys":[],"configDoc":"Set whether no delay is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"no-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_NO_DELAY","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.quick-ack","additionalKeys":[],"configDoc":"Enable the `TCP_QUICKACK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"quick-ack","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.traffic-class","additionalKeys":[],"configDoc":"Set the value of traffic class.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"traffic-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_TRAFFIC_CLASS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.write-idle-timeout","additionalKeys":[],"configDoc":"Set the write idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"write-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_WRITE_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.local-address","additionalKeys":[],"configDoc":"Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_LOCAL_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.alpn","additionalKeys":[],"configDoc":"Set the ALPN usage.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_ALPN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.application-layer-protocols","additionalKeys":[],"configDoc":"Sets the list of application-layer protocols to provide to the server during the `Application-Layer Protocol Negotiation`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"application-layer-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_APPLICATION_LAYER_PROTOCOLS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.secure-transport-protocols","additionalKeys":[],"configDoc":"Sets the list of enabled SSL/TLS protocols.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secure-transport-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SECURE_TRANSPORT_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.idle-timeout","additionalKeys":[],"configDoc":"Set the idle timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.connection-timeout","additionalKeys":[],"configDoc":"Set the connect timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.non-proxy-hosts","additionalKeys":[],"configDoc":"Set a list of remote hosts that are not proxied when the client is configured to use a proxy.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port. Defaults to 3128.","withinAMap":true,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_HOST","enum":false}},{"configDocKey":{"type":"io.vertx.core.net.ProxyType","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.type","additionalKeys":[],"configDoc":"Set proxy type. Accepted values are: `HTTP` (default), `SOCKS4` and `SOCKS5`.","withinAMap":true,"defaultValue":"http","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/net/ProxyType.html","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":["`http`","`socks4`","`socks5`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_TYPE","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.read-idle-timeout","additionalKeys":[],"configDoc":"Set the read idle timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_READ_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.receive-buffer-size","additionalKeys":[],"configDoc":"Set the TCP receive buffer size.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"receive-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECEIVE_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.reconnect-attempts","additionalKeys":[],"configDoc":"Set the value of reconnect attempts.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.reconnect-interval","additionalKeys":[],"configDoc":"Set the reconnect interval.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.reuse-address","additionalKeys":[],"configDoc":"Whether to reuse the address.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_REUSE_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.reuse-port","additionalKeys":[],"configDoc":"Whether to reuse the port.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_REUSE_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.send-buffer-size","additionalKeys":[],"configDoc":"Set the TCP send buffer size.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"send-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SEND_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.so-linger","additionalKeys":[],"configDoc":"Set the `SO_linger` keep alive duration.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"so-linger","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SO_LINGER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.cork","additionalKeys":[],"configDoc":"Enable the `TCP_CORK` option - only with linux native transport.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cork","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CORK","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.fast-open","additionalKeys":[],"configDoc":"Enable the `TCP_FASTOPEN` option - only with linux native transport.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"fast-open","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.keep-alive","additionalKeys":[],"configDoc":"Set whether keep alive is enabled","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.no-delay","additionalKeys":[],"configDoc":"Set whether no delay is enabled","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"no-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_NO_DELAY","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.quick-ack","additionalKeys":[],"configDoc":"Enable the `TCP_QUICKACK` option - only with linux native transport.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"quick-ack","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.traffic-class","additionalKeys":[],"configDoc":"Set the value of traffic class.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"traffic-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_TRAFFIC_CLASS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.write-idle-timeout","additionalKeys":[],"configDoc":"Set the write idle timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"write-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_WRITE_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.local-address","additionalKeys":[],"configDoc":"Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_LOCAL_ADDRESS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.redis.tls","optional":false,"withinAMap":false,"sectionDetails":"== SSL/TLS config","sectionDetailsTitle":"SSL/TLS config","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.redis","configGroupType":"io.quarkus.redis.runtime.client.config.TlsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).\n\nIf set to `NONE`, it does not verify the hostname.","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).\n\nIf set to `NONE`, it does not verify the hostname.","withinAMap":true,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.net.URI","key":"quarkus.redis.\"redis-client-name\".hosts","additionalKeys":[],"configDoc":"The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.\n\nThe URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".hosts-provider-name","additionalKeys":[],"configDoc":"The hosts provider bean name.\n\nIt is the `&++#++64;Named` value of the hosts provider bean. It is used to discriminate if multiple `io.quarkus.redis.client.RedisHostsProvider` beans are available.\n\nUsed when `quarkus.redis.hosts` is not set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__HOSTS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".timeout","additionalKeys":[],"configDoc":"The maximum delay to wait before a blocking command to redis server times out","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TIMEOUT","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisClientType","key":"quarkus.redis.\"redis-client-name\".client-type","additionalKeys":[],"configDoc":"The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.","withinAMap":true,"defaultValue":"standalone","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisClientType.html","docMapKey":"client-type","configPhase":"RUN_TIME","acceptedValues":["`standalone`","`sentinel`","`cluster`","`replication`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_TYPE","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".master-name","additionalKeys":[],"configDoc":"The master name (only considered in HA mode).","withinAMap":true,"defaultValue":"mymaster","javaDocSiteLink":"","docMapKey":"master-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MASTER_NAME","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisRole","key":"quarkus.redis.\"redis-client-name\".role","additionalKeys":[],"configDoc":"The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.","withinAMap":true,"defaultValue":"master","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisRole.html","docMapKey":"role","configPhase":"RUN_TIME","acceptedValues":["`master`","`replica`","`sentinel`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__ROLE","enum":true}},{"configDocKey":{"type":"io.vertx.redis.client.RedisReplicas","key":"quarkus.redis.\"redis-client-name\".replicas","additionalKeys":[],"configDoc":"Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.","withinAMap":true,"defaultValue":"never","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisReplicas.html","docMapKey":"replicas","configPhase":"RUN_TIME","acceptedValues":["`never`","`share`","`always`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__REPLICAS","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".password","additionalKeys":[],"configDoc":"The default password for cluster/sentinel connections.\n\nIf not set it will try to extract the value from the current default `++#++hosts`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool. When working with cluster or sentinel.\n\nThis value should be at least the total number of cluster member (or number of sentinels {plus} 1)","withinAMap":true,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-pool-waiting","additionalKeys":[],"configDoc":"The maximum waiting requests for a connection from the pool.","withinAMap":true,"defaultValue":"24","javaDocSiteLink":"","docMapKey":"max-pool-waiting","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_POOL_WAITING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".pool-cleaner-interval","additionalKeys":[],"configDoc":"The duration indicating how often should the connection pool cleaner executes.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVAL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".pool-recycle-timeout","additionalKeys":[],"configDoc":"The timeout for a connection recycling.","withinAMap":true,"defaultValue":"15S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-recycle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-waiting-handlers","additionalKeys":[],"configDoc":"Sets how many handlers is the client willing to queue.\n\nThe client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you're willing to accept.","withinAMap":true,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-waiting-handlers","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_WAITING_HANDLERS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-nested-arrays","additionalKeys":[],"configDoc":"Tune how much nested arrays are allowed on a redis response. This affects the parser performance.","withinAMap":true,"defaultValue":"32","javaDocSiteLink":"","docMapKey":"max-nested-arrays","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_NESTED_ARRAYS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".protocol-negotiation","additionalKeys":[],"configDoc":"Should the client perform `RESP` protocol negotiation during the connection handshake.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"protocol-negotiation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.ProtocolVersion","key":"quarkus.redis.\"redis-client-name\".preferred-protocol-version","additionalKeys":[],"configDoc":"The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.","withinAMap":true,"defaultValue":"resp3","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/ProtocolVersion.html","docMapKey":"preferred-protocol-version","configPhase":"RUN_TIME","acceptedValues":["`resp2`","`resp3`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__PREFERRED_PROTOCOL_VERSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".hash-slot-cache-ttl","additionalKeys":[],"configDoc":"The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending `CLUSTER SLOTS` commands to the first statically configured cluster node.\n\nThis setting is only meaningful in case of a clustered Redis client and has no effect otherwise.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"hash-slot-cache-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__HASH_SLOT_CACHE_TTL","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.net.URI","key":"quarkus.redis.hosts","additionalKeys":[],"configDoc":"The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.\n\nThe URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.hosts-provider-name","additionalKeys":[],"configDoc":"The hosts provider bean name.\n\nIt is the `&++#++64;Named` value of the hosts provider bean. It is used to discriminate if multiple `io.quarkus.redis.client.RedisHostsProvider` beans are available.\n\nUsed when `quarkus.redis.hosts` is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_HOSTS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.timeout","additionalKeys":[],"configDoc":"The maximum delay to wait before a blocking command to redis server times out","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TIMEOUT","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisClientType","key":"quarkus.redis.client-type","additionalKeys":[],"configDoc":"The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.","withinAMap":false,"defaultValue":"standalone","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisClientType.html","docMapKey":"client-type","configPhase":"RUN_TIME","acceptedValues":["`standalone`","`sentinel`","`cluster`","`replication`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_CLIENT_TYPE","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.master-name","additionalKeys":[],"configDoc":"The master name (only considered in HA mode).","withinAMap":false,"defaultValue":"mymaster","javaDocSiteLink":"","docMapKey":"master-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MASTER_NAME","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisRole","key":"quarkus.redis.role","additionalKeys":[],"configDoc":"The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.","withinAMap":false,"defaultValue":"master","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisRole.html","docMapKey":"role","configPhase":"RUN_TIME","acceptedValues":["`master`","`replica`","`sentinel`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_ROLE","enum":true}},{"configDocKey":{"type":"io.vertx.redis.client.RedisReplicas","key":"quarkus.redis.replicas","additionalKeys":[],"configDoc":"Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.","withinAMap":false,"defaultValue":"never","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisReplicas.html","docMapKey":"replicas","configPhase":"RUN_TIME","acceptedValues":["`never`","`share`","`always`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_REPLICAS","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.password","additionalKeys":[],"configDoc":"The default password for cluster/sentinel connections.\n\nIf not set it will try to extract the value from the current default `++#++hosts`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool. When working with cluster or sentinel.\n\nThis value should be at least the total number of cluster member (or number of sentinels {plus} 1)","withinAMap":false,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-pool-waiting","additionalKeys":[],"configDoc":"The maximum waiting requests for a connection from the pool.","withinAMap":false,"defaultValue":"24","javaDocSiteLink":"","docMapKey":"max-pool-waiting","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_POOL_WAITING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.pool-cleaner-interval","additionalKeys":[],"configDoc":"The duration indicating how often should the connection pool cleaner executes.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_POOL_CLEANER_INTERVAL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.pool-recycle-timeout","additionalKeys":[],"configDoc":"The timeout for a connection recycling.","withinAMap":false,"defaultValue":"15S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-recycle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-waiting-handlers","additionalKeys":[],"configDoc":"Sets how many handlers is the client willing to queue.\n\nThe client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you're willing to accept.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-waiting-handlers","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_WAITING_HANDLERS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.max-nested-arrays","additionalKeys":[],"configDoc":"Tune how much nested arrays are allowed on a redis response. This affects the parser performance.","withinAMap":false,"defaultValue":"32","javaDocSiteLink":"","docMapKey":"max-nested-arrays","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_MAX_NESTED_ARRAYS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.protocol-negotiation","additionalKeys":[],"configDoc":"Should the client perform `RESP` protocol negotiation during the connection handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"protocol-negotiation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_PROTOCOL_NEGOTIATION","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.ProtocolVersion","key":"quarkus.redis.preferred-protocol-version","additionalKeys":[],"configDoc":"The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.","withinAMap":false,"defaultValue":"resp3","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/ProtocolVersion.html","docMapKey":"preferred-protocol-version","configPhase":"RUN_TIME","acceptedValues":["`resp2`","`resp3`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_PREFERRED_PROTOCOL_VERSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.hash-slot-cache-ttl","additionalKeys":[],"configDoc":"The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending `CLUSTER SLOTS` commands to the first statically configured cluster node.\n\nThis setting is only meaningful in case of a clustered Redis client and has no effect otherwise.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"hash-slot-cache-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_HASH_SLOT_CACHE_TTL","enum":false}},{"configDocSection":{"name":"quarkus.redis.tcp","optional":false,"withinAMap":false,"sectionDetails":"== TCP config","sectionDetailsTitle":"TCP config","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.redis","configGroupType":"io.quarkus.redis.runtime.client.config.NetConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.alpn","additionalKeys":[],"configDoc":"Set the ALPN usage.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_ALPN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.application-layer-protocols","additionalKeys":[],"configDoc":"Sets the list of application-layer protocols to provide to the server during the `Application-Layer Protocol Negotiation`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"application-layer-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_APPLICATION_LAYER_PROTOCOLS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.secure-transport-protocols","additionalKeys":[],"configDoc":"Sets the list of enabled SSL/TLS protocols.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secure-transport-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_SECURE_TRANSPORT_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.idle-timeout","additionalKeys":[],"configDoc":"Set the idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.connection-timeout","additionalKeys":[],"configDoc":"Set the connect timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.non-proxy-hosts","additionalKeys":[],"configDoc":"Set a list of remote hosts that are not proxied when the client is configured to use a proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.tcp.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port. Defaults to 3128.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_HOST","enum":false}},{"configDocKey":{"type":"io.vertx.core.net.ProxyType","key":"quarkus.redis.tcp.proxy-options.type","additionalKeys":[],"configDoc":"Set proxy type. Accepted values are: `HTTP` (default), `SOCKS4` and `SOCKS5`.","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/net/ProxyType.html","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":["`http`","`socks4`","`socks5`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_PROXY_OPTIONS_TYPE","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.read-idle-timeout","additionalKeys":[],"configDoc":"Set the read idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_READ_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.receive-buffer-size","additionalKeys":[],"configDoc":"Set the TCP receive buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"receive-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_RECEIVE_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.reconnect-attempts","additionalKeys":[],"configDoc":"Set the value of reconnect attempts.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.reconnect-interval","additionalKeys":[],"configDoc":"Set the reconnect interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.reuse-address","additionalKeys":[],"configDoc":"Whether to reuse the address.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_REUSE_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.reuse-port","additionalKeys":[],"configDoc":"Whether to reuse the port.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_REUSE_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.send-buffer-size","additionalKeys":[],"configDoc":"Set the TCP send buffer size.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"send-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_SEND_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.so-linger","additionalKeys":[],"configDoc":"Set the `SO_linger` keep alive duration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"so-linger","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_SO_LINGER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.cork","additionalKeys":[],"configDoc":"Enable the `TCP_CORK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cork","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_CORK","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.fast-open","additionalKeys":[],"configDoc":"Enable the `TCP_FASTOPEN` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"fast-open","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.keep-alive","additionalKeys":[],"configDoc":"Set whether keep alive is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.no-delay","additionalKeys":[],"configDoc":"Set whether no delay is enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"no-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_NO_DELAY","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.tcp.quick-ack","additionalKeys":[],"configDoc":"Enable the `TCP_QUICKACK` option - only with linux native transport.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"quick-ack","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.tcp.traffic-class","additionalKeys":[],"configDoc":"Set the value of traffic class.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"traffic-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_TRAFFIC_CLASS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.tcp.write-idle-timeout","additionalKeys":[],"configDoc":"Set the write idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"write-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_WRITE_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tcp.local-address","additionalKeys":[],"configDoc":"Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TCP_LOCAL_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.alpn","additionalKeys":[],"configDoc":"Set the ALPN usage.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_ALPN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.application-layer-protocols","additionalKeys":[],"configDoc":"Sets the list of application-layer protocols to provide to the server during the `Application-Layer Protocol Negotiation`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"application-layer-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_APPLICATION_LAYER_PROTOCOLS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.secure-transport-protocols","additionalKeys":[],"configDoc":"Sets the list of enabled SSL/TLS protocols.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secure-transport-protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SECURE_TRANSPORT_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.idle-timeout","additionalKeys":[],"configDoc":"Set the idle timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.connection-timeout","additionalKeys":[],"configDoc":"Set the connect timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.non-proxy-hosts","additionalKeys":[],"configDoc":"Set a list of remote hosts that are not proxied when the client is configured to use a proxy.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port. Defaults to 3128.","withinAMap":true,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_HOST","enum":false}},{"configDocKey":{"type":"io.vertx.core.net.ProxyType","key":"quarkus.redis.\"redis-client-name\".tcp.proxy-options.type","additionalKeys":[],"configDoc":"Set proxy type. Accepted values are: `HTTP` (default), `SOCKS4` and `SOCKS5`.","withinAMap":true,"defaultValue":"http","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/net/ProxyType.html","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":["`http`","`socks4`","`socks5`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_TYPE","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.read-idle-timeout","additionalKeys":[],"configDoc":"Set the read idle timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_READ_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.receive-buffer-size","additionalKeys":[],"configDoc":"Set the TCP receive buffer size.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"receive-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECEIVE_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.reconnect-attempts","additionalKeys":[],"configDoc":"Set the value of reconnect attempts.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.reconnect-interval","additionalKeys":[],"configDoc":"Set the reconnect interval.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.reuse-address","additionalKeys":[],"configDoc":"Whether to reuse the address.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_REUSE_ADDRESS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.reuse-port","additionalKeys":[],"configDoc":"Whether to reuse the port.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reuse-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_REUSE_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.send-buffer-size","additionalKeys":[],"configDoc":"Set the TCP send buffer size.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"send-buffer-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SEND_BUFFER_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.so-linger","additionalKeys":[],"configDoc":"Set the `SO_linger` keep alive duration.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"so-linger","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SO_LINGER","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.cork","additionalKeys":[],"configDoc":"Enable the `TCP_CORK` option - only with linux native transport.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cork","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CORK","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.fast-open","additionalKeys":[],"configDoc":"Enable the `TCP_FASTOPEN` option - only with linux native transport.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"fast-open","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.keep-alive","additionalKeys":[],"configDoc":"Set whether keep alive is enabled","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_KEEP_ALIVE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.no-delay","additionalKeys":[],"configDoc":"Set whether no delay is enabled","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"no-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_NO_DELAY","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.redis.\"redis-client-name\".tcp.quick-ack","additionalKeys":[],"configDoc":"Enable the `TCP_QUICKACK` option - only with linux native transport.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"quick-ack","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.redis.\"redis-client-name\".tcp.traffic-class","additionalKeys":[],"configDoc":"Set the value of traffic class.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"traffic-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_TRAFFIC_CLASS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".tcp.write-idle-timeout","additionalKeys":[],"configDoc":"Set the write idle timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"write-idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_WRITE_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tcp.local-address","additionalKeys":[],"configDoc":"Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_LOCAL_ADDRESS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.redis.tls","optional":false,"withinAMap":false,"sectionDetails":"== SSL/TLS config","sectionDetailsTitle":"SSL/TLS config","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.redis","configGroupType":"io.quarkus.redis.runtime.client.config.TlsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.tls.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).\n\nIf set to `NONE`, it does not verify the hostname.","withinAMap":false,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).\n\nIf set to `NONE`, it does not verify the hostname.","withinAMap":true,"defaultValue":"NONE","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":"quarkus.redis.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used.\n\nThe default TLS configuration is *not* used by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"java.net.URI","key":"quarkus.redis.\"redis-client-name\".hosts","additionalKeys":[],"configDoc":"The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.\n\nThe URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".hosts-provider-name","additionalKeys":[],"configDoc":"The hosts provider bean name.\n\nIt is the `&++#++64;Named` value of the hosts provider bean. It is used to discriminate if multiple `io.quarkus.redis.client.RedisHostsProvider` beans are available.\n\nUsed when `quarkus.redis.hosts` is not set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hosts-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__HOSTS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".timeout","additionalKeys":[],"configDoc":"The maximum delay to wait before a blocking command to redis server times out","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TIMEOUT","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisClientType","key":"quarkus.redis.\"redis-client-name\".client-type","additionalKeys":[],"configDoc":"The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`.","withinAMap":true,"defaultValue":"standalone","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisClientType.html","docMapKey":"client-type","configPhase":"RUN_TIME","acceptedValues":["`standalone`","`sentinel`","`cluster`","`replication`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_TYPE","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".master-name","additionalKeys":[],"configDoc":"The master name (only considered in HA mode).","withinAMap":true,"defaultValue":"mymaster","javaDocSiteLink":"","docMapKey":"master-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MASTER_NAME","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.RedisRole","key":"quarkus.redis.\"redis-client-name\".role","additionalKeys":[],"configDoc":"The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`.","withinAMap":true,"defaultValue":"master","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisRole.html","docMapKey":"role","configPhase":"RUN_TIME","acceptedValues":["`master`","`replica`","`sentinel`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__ROLE","enum":true}},{"configDocKey":{"type":"io.vertx.redis.client.RedisReplicas","key":"quarkus.redis.\"redis-client-name\".replicas","additionalKeys":[],"configDoc":"Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`.","withinAMap":true,"defaultValue":"never","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/RedisReplicas.html","docMapKey":"replicas","configPhase":"RUN_TIME","acceptedValues":["`never`","`share`","`always`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__REPLICAS","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".password","additionalKeys":[],"configDoc":"The default password for cluster/sentinel connections.\n\nIf not set it will try to extract the value from the current default `++#++hosts`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__PASSWORD","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool. When working with cluster or sentinel.\n\nThis value should be at least the total number of cluster member (or number of sentinels {plus} 1)","withinAMap":true,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_POOL_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-pool-waiting","additionalKeys":[],"configDoc":"The maximum waiting requests for a connection from the pool.","withinAMap":true,"defaultValue":"24","javaDocSiteLink":"","docMapKey":"max-pool-waiting","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_POOL_WAITING","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".pool-cleaner-interval","additionalKeys":[],"configDoc":"The duration indicating how often should the connection pool cleaner executes.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-cleaner-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVAL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".pool-recycle-timeout","additionalKeys":[],"configDoc":"The timeout for a connection recycling.","withinAMap":true,"defaultValue":"15S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"pool-recycle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-waiting-handlers","additionalKeys":[],"configDoc":"Sets how many handlers is the client willing to queue.\n\nThe client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you're willing to accept.","withinAMap":true,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-waiting-handlers","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_WAITING_HANDLERS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".max-nested-arrays","additionalKeys":[],"configDoc":"Tune how much nested arrays are allowed on a redis response. This affects the parser performance.","withinAMap":true,"defaultValue":"32","javaDocSiteLink":"","docMapKey":"max-nested-arrays","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_NESTED_ARRAYS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.redis.\"redis-client-name\".reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_ATTEMPTS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_INTERVAL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.redis.\"redis-client-name\".protocol-negotiation","additionalKeys":[],"configDoc":"Should the client perform `RESP` protocol negotiation during the connection handshake.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"protocol-negotiation","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION","enum":false}},{"configDocKey":{"type":"io.vertx.redis.client.ProtocolVersion","key":"quarkus.redis.\"redis-client-name\".preferred-protocol-version","additionalKeys":[],"configDoc":"The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.","withinAMap":true,"defaultValue":"resp3","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/redis/client/ProtocolVersion.html","docMapKey":"preferred-protocol-version","configPhase":"RUN_TIME","acceptedValues":["`resp2`","`resp3`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__PREFERRED_PROTOCOL_VERSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.redis.\"redis-client-name\".hash-slot-cache-ttl","additionalKeys":[],"configDoc":"The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending `CLUSTER SLOTS` commands to the first statically configured cluster node.\n\nThis setting is only meaningful in case of a clustered Redis client and has no effect otherwise.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"hash-slot-cache-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__HASH_SLOT_CACHE_TTL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.redis.\"redis-client-name\".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used.\n\nThe default TLS configuration is *not* used by default.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.redis","since":null,"environmentVariable":"QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.restclient.config.RestClientsConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.restclient.config.RestClientsConfig index fd647cd983e..e1625fb3e65 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.restclient.config.RestClientsConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.restclient.config.RestClientsConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".url","additionalKeys":[],"configDoc":"The base URL to use for this service. This property or the `uri` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__URL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".uri","additionalKeys":[],"configDoc":"The base URI to use for this service. This property or the `url` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"uri","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__URI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".providers","additionalKeys":[],"configDoc":"Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"providers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROVIDERS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.\"config-key\".connect-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait to connect to the remote endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connect-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CONNECT_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.\"config-key\".read-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait for a response from the remote endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".follow-redirects","additionalKeys":[],"configDoc":"A boolean value used to determine whether the client should follow HTTP redirect responses.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"follow-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__FOLLOW_REDIRECTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".multipart-post-encoder-mode","additionalKeys":[],"configDoc":"Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the link:https://netty.io/4.1/api/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.EncoderMode.html[Netty documentation]\n\nBy default, Rest Client Reactive uses RFC1738.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multipart-post-encoder-mode","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__MULTIPART_POST_ENCODER_MODE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".proxy-address","additionalKeys":[],"configDoc":"A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use. Use `none` to disable proxy","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROXY_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".proxy-user","additionalKeys":[],"configDoc":"Proxy username.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-user","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROXY_USER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".proxy-password","additionalKeys":[],"configDoc":"Proxy password.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROXY_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".non-proxy-hosts","additionalKeys":[],"configDoc":"Hosts to access without proxy\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"org.eclipse.microprofile.rest.client.ext.QueryParamStyle","key":"quarkus.rest-client.\"config-key\".query-param-style","additionalKeys":[],"configDoc":"An enumerated type string value with possible values of \"MULTI_PAIRS\" (default), \"COMMA_SEPARATED\", or \"ARRAY_PAIRS\" that specifies the format in which multiple values for the same query parameter is used.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"query-param-style","configPhase":"RUN_TIME","acceptedValues":["`multi-pairs`","`comma-separated`","`array-pairs`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__QUERY_PARAM_STYLE","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".verify-host","additionalKeys":[],"configDoc":"Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verify-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__VERIFY_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".trust-store","additionalKeys":[],"configDoc":"The trust store location. Can point to either a classpath resource or a file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".trust-store-password","additionalKeys":[],"configDoc":"The trust store password.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".trust-store-type","additionalKeys":[],"configDoc":"The type of the trust store. Defaults to \"JKS\".","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".key-store","additionalKeys":[],"configDoc":"The key store location. Can point to either a classpath resource or a file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".key-store-password","additionalKeys":[],"configDoc":"The key store password.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".key-store-type","additionalKeys":[],"configDoc":"The type of the key store. Defaults to \"JKS\".","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".hostname-verifier","additionalKeys":[],"configDoc":"The class name of the host name verifier. The class must have a public no-argument constructor.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verifier","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__HOSTNAME_VERIFIER","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.\"config-key\".connection-ttl","additionalKeys":[],"configDoc":"The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of `0` means there is no timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CONNECTION_TTL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.\"config-key\".connection-pool-size","additionalKeys":[],"configDoc":"The size of the connection pool for this client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CONNECTION_POOL_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".keep-alive-enabled","additionalKeys":[],"configDoc":"If set to false disables the keep alive completely.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEEP_ALIVE_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.\"config-key\".max-redirects","additionalKeys":[],"configDoc":"The maximum number of redirection a request can follow.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__MAX_REDIRECTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.rest-client.\"config-key\".headers.\"header-name\"","additionalKeys":[],"configDoc":"The HTTP headers that should be applied to all requests of the rest client.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".shared","additionalKeys":[],"configDoc":"Set to true to share the HTTP client between REST clients. There can be multiple shared clients distinguished by _name_, when no specific name is set, the name `__vertx.DEFAULT` is used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".name","additionalKeys":[],"configDoc":"Set the HTTP client name, used when the client is shared, otherwise ignored.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".user-agent","additionalKeys":[],"configDoc":"Configure the HTTP user-agent header to use.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__USER_AGENT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".http2","additionalKeys":[],"configDoc":"If this is true then HTTP/2 will be enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http2","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__HTTP2","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.rest-client.\"config-key\".max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size (8096 bytes by default).\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"8K","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".alpn","additionalKeys":[],"configDoc":"If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__ALPN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".capture-stacktrace","additionalKeys":[],"configDoc":"If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"capture-stacktrace","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.multipart-post-encoder-mode","additionalKeys":[],"configDoc":"Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the link:https://netty.io/4.1/api/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.EncoderMode.html[Netty documentation]\n\nBy default, Rest Client Reactive uses RFC1738.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multipart-post-encoder-mode","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_MULTIPART_POST_ENCODER_MODE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.proxy-address","additionalKeys":[],"configDoc":"A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of clients to use.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROXY_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.proxy-user","additionalKeys":[],"configDoc":"Proxy username, equivalent to the http.proxy or https.proxy JVM settings.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-user","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROXY_USER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.proxy-password","additionalKeys":[],"configDoc":"Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROXY_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.non-proxy-hosts","additionalKeys":[],"configDoc":"Hosts to access without proxy, similar to the http.nonProxyHosts or https.nonProxyHosts JVM settings. Please note that unlike the JVM settings, this property is empty by default.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.logging.scope","additionalKeys":[],"configDoc":"Scope of logging for the client. +\nWARNING: beware of logging sensitive data +\nThe possible values are:\n\n - `request-response` - enables logging request and responses, including redirect responses\n - `all` - enables logging requests and responses and lower-level logging\n - `none` - no additional logging This property is applicable to reactive REST clients only.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_LOGGING_SCOPE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.logging.body-limit","additionalKeys":[],"configDoc":"How many characters of the body should be logged. Message body can be large and can easily pollute the logs.\n\nBy default, set to 100.\n\nThis property is applicable to reactive REST clients only.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_LOGGING_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.connect-timeout","additionalKeys":[],"configDoc":"A timeout in milliseconds that REST clients should wait to connect to the remote endpoint.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"15000 ms","javaDocSiteLink":"","docMapKey":"connect-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CONNECT_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.read-timeout","additionalKeys":[],"configDoc":"A timeout in milliseconds that REST clients should wait for a response from the remote endpoint.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"30000 ms","javaDocSiteLink":"","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.disable-contextual-error-messages","additionalKeys":[],"configDoc":"If true, the REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-contextual-error-messages","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_DISABLE_CONTEXTUAL_ERROR_MESSAGES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.user-agent","additionalKeys":[],"configDoc":"Default configuration for the HTTP user-agent header to use in all REST clients.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_USER_AGENT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.rest-client.headers.\"header-name\"","additionalKeys":[],"configDoc":"The HTTP headers that should be applied to all requests of the rest client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.hostname-verifier","additionalKeys":[],"configDoc":"The class name of the host name verifier. The class must have a public no-argument constructor.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verifier","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_HOSTNAME_VERIFIER","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.connection-ttl","additionalKeys":[],"configDoc":"The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of `0` means there is no timeout.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CONNECTION_TTL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.connection-pool-size","additionalKeys":[],"configDoc":"The size of the connection pool for this client.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CONNECTION_POOL_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.keep-alive-enabled","additionalKeys":[],"configDoc":"If set to false disables the keep alive completely.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEEP_ALIVE_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.max-redirects","additionalKeys":[],"configDoc":"The maximum number of redirection a request can follow.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_MAX_REDIRECTS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.follow-redirects","additionalKeys":[],"configDoc":"A boolean value used to determine whether the client should follow HTTP redirect responses.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"follow-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_FOLLOW_REDIRECTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.providers","additionalKeys":[],"configDoc":"Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"providers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROVIDERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.scope","additionalKeys":[],"configDoc":"The CDI scope to use for injections of REST client instances. Value can be either a fully qualified class name of a CDI scope annotation (such as \"jakarta.enterprise.context.ApplicationScoped\") or its simple name (such as\"ApplicationScoped\").\n\nDefault scope for the rest-client extension is \"Dependent\" (which is the spec-compliant behavior).\n\nDefault scope for the rest-client-reactive extension is \"ApplicationScoped\".\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_SCOPE","enum":false}},{"configDocKey":{"type":"org.eclipse.microprofile.rest.client.ext.QueryParamStyle","key":"quarkus.rest-client.query-param-style","additionalKeys":[],"configDoc":"An enumerated type string value with possible values of \"MULTI_PAIRS\" (default), \"COMMA_SEPARATED\", or \"ARRAY_PAIRS\" that specifies the format in which multiple values for the same query parameter is used.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"query-param-style","configPhase":"RUN_TIME","acceptedValues":["`multi-pairs`","`comma-separated`","`array-pairs`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_QUERY_PARAM_STYLE","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.verify-host","additionalKeys":[],"configDoc":"Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verify-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_VERIFY_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.trust-store","additionalKeys":[],"configDoc":"The trust store location. Can point to either a classpath resource or a file.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.trust-store-password","additionalKeys":[],"configDoc":"The trust store password.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.trust-store-type","additionalKeys":[],"configDoc":"The type of the trust store. Defaults to \"JKS\".\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.key-store","additionalKeys":[],"configDoc":"The key store location. Can point to either a classpath resource or a file.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.key-store-password","additionalKeys":[],"configDoc":"The key store password.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.key-store-type","additionalKeys":[],"configDoc":"The type of the key store. Defaults to \"JKS\".\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.http2","additionalKeys":[],"configDoc":"If this is true then HTTP/2 will be enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http2","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_HTTP2","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.rest-client.max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size (8096 bytes by default).\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"8k","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.alpn","additionalKeys":[],"configDoc":"If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_ALPN","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.capture-stacktrace","additionalKeys":[],"configDoc":"If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"capture-stacktrace","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".url","additionalKeys":[],"configDoc":"The base URL to use for this service. This property or the `uri` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__URL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".uri","additionalKeys":[],"configDoc":"The base URI to use for this service. This property or the `url` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"uri","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__URI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".providers","additionalKeys":[],"configDoc":"Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"providers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROVIDERS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.\"config-key\".connect-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait to connect to the remote endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connect-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CONNECT_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.\"config-key\".read-timeout","additionalKeys":[],"configDoc":"Timeout specified in milliseconds to wait for a response from the remote endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".follow-redirects","additionalKeys":[],"configDoc":"A boolean value used to determine whether the client should follow HTTP redirect responses.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"follow-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__FOLLOW_REDIRECTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".multipart-post-encoder-mode","additionalKeys":[],"configDoc":"Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the link:https://netty.io/4.1/api/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.EncoderMode.html[Netty documentation]\n\nBy default, Rest Client Reactive uses RFC1738.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multipart-post-encoder-mode","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__MULTIPART_POST_ENCODER_MODE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".proxy-address","additionalKeys":[],"configDoc":"A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use. Use `none` to disable proxy","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROXY_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".proxy-user","additionalKeys":[],"configDoc":"Proxy username.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-user","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROXY_USER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".proxy-password","additionalKeys":[],"configDoc":"Proxy password.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__PROXY_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".non-proxy-hosts","additionalKeys":[],"configDoc":"Hosts to access without proxy\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"org.eclipse.microprofile.rest.client.ext.QueryParamStyle","key":"quarkus.rest-client.\"config-key\".query-param-style","additionalKeys":[],"configDoc":"An enumerated type string value with possible values of \"MULTI_PAIRS\" (default), \"COMMA_SEPARATED\", or \"ARRAY_PAIRS\" that specifies the format in which multiple values for the same query parameter is used.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"query-param-style","configPhase":"RUN_TIME","acceptedValues":["`multi-pairs`","`comma-separated`","`array-pairs`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__QUERY_PARAM_STYLE","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".verify-host","additionalKeys":[],"configDoc":"Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verify-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__VERIFY_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".trust-store","additionalKeys":[],"configDoc":"The trust store location. Can point to either a classpath resource or a file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".trust-store-password","additionalKeys":[],"configDoc":"The trust store password.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".trust-store-type","additionalKeys":[],"configDoc":"The type of the trust store. Defaults to \"JKS\".","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".key-store","additionalKeys":[],"configDoc":"The key store location. Can point to either a classpath resource or a file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".key-store-password","additionalKeys":[],"configDoc":"The key store password.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".key-store-type","additionalKeys":[],"configDoc":"The type of the key store. Defaults to \"JKS\".","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".hostname-verifier","additionalKeys":[],"configDoc":"The class name of the host name verifier. The class must have a public no-argument constructor.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verifier","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__HOSTNAME_VERIFIER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.\"config-key\".connection-ttl","additionalKeys":[],"configDoc":"The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of `0` means there is no timeout.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CONNECTION_TTL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.\"config-key\".connection-pool-size","additionalKeys":[],"configDoc":"The size of the connection pool for this client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CONNECTION_POOL_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".keep-alive-enabled","additionalKeys":[],"configDoc":"If set to false disables the keep alive completely.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keep-alive-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__KEEP_ALIVE_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.\"config-key\".max-redirects","additionalKeys":[],"configDoc":"The maximum number of redirection a request can follow.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__MAX_REDIRECTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.rest-client.\"config-key\".headers.\"header-name\"","additionalKeys":[],"configDoc":"The HTTP headers that should be applied to all requests of the rest client.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".shared","additionalKeys":[],"configDoc":"Set to true to share the HTTP client between REST clients. There can be multiple shared clients distinguished by _name_, when no specific name is set, the name `__vertx.DEFAULT` is used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__SHARED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".name","additionalKeys":[],"configDoc":"Set the HTTP client name, used when the client is shared, otherwise ignored.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"config-key\".user-agent","additionalKeys":[],"configDoc":"Configure the HTTP user-agent header to use.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__USER_AGENT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".http2","additionalKeys":[],"configDoc":"If this is true then HTTP/2 will be enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http2","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__HTTP2","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.rest-client.\"config-key\".max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size (8096 bytes by default).\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":true,"defaultValue":"8K","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".alpn","additionalKeys":[],"configDoc":"If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__ALPN","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.\"config-key\".capture-stacktrace","additionalKeys":[],"configDoc":"If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"capture-stacktrace","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.multipart-post-encoder-mode","additionalKeys":[],"configDoc":"Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the link:https://netty.io/4.1/api/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.EncoderMode.html[Netty documentation]\n\nBy default, Rest Client Reactive uses RFC1738.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"multipart-post-encoder-mode","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_MULTIPART_POST_ENCODER_MODE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.proxy-address","additionalKeys":[],"configDoc":"A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of clients to use.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-address","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROXY_ADDRESS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.proxy-user","additionalKeys":[],"configDoc":"Proxy username, equivalent to the http.proxy or https.proxy JVM settings.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-user","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROXY_USER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.proxy-password","additionalKeys":[],"configDoc":"Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"proxy-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROXY_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.non-proxy-hosts","additionalKeys":[],"configDoc":"Hosts to access without proxy, similar to the http.nonProxyHosts or https.nonProxyHosts JVM settings. Please note that unlike the JVM settings, this property is empty by default.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"non-proxy-hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_NON_PROXY_HOSTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.logging.scope","additionalKeys":[],"configDoc":"Scope of logging for the client. +\nWARNING: beware of logging sensitive data +\nThe possible values are:\n\n - `request-response` - enables logging request and responses, including redirect responses\n - `all` - enables logging requests and responses and lower-level logging\n - `none` - no additional logging This property is applicable to reactive REST clients only.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_LOGGING_SCOPE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.logging.body-limit","additionalKeys":[],"configDoc":"How many characters of the body should be logged. Message body can be large and can easily pollute the logs.\n\nBy default, set to 100.\n\nThis property is applicable to reactive REST clients only.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"body-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_LOGGING_BODY_LIMIT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.connect-timeout","additionalKeys":[],"configDoc":"A timeout in milliseconds that REST clients should wait to connect to the remote endpoint.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"15000 ms","javaDocSiteLink":"","docMapKey":"connect-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CONNECT_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.rest-client.read-timeout","additionalKeys":[],"configDoc":"A timeout in milliseconds that REST clients should wait for a response from the remote endpoint.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"30000 ms","javaDocSiteLink":"","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.disable-contextual-error-messages","additionalKeys":[],"configDoc":"If true, the REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-contextual-error-messages","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_DISABLE_CONTEXTUAL_ERROR_MESSAGES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.user-agent","additionalKeys":[],"configDoc":"Default configuration for the HTTP user-agent header to use in all REST clients.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-agent","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_USER_AGENT","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.rest-client.headers.\"header-name\"","additionalKeys":[],"configDoc":"The HTTP headers that should be applied to all requests of the rest client.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.hostname-verifier","additionalKeys":[],"configDoc":"The class name of the host name verifier. The class must have a public no-argument constructor.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verifier","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_HOSTNAME_VERIFIER","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.connection-ttl","additionalKeys":[],"configDoc":"The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of `0` means there is no timeout.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-ttl","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CONNECTION_TTL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.connection-pool-size","additionalKeys":[],"configDoc":"The size of the connection pool for this client.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"connection-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CONNECTION_POOL_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.keep-alive-enabled","additionalKeys":[],"configDoc":"If set to false disables the keep alive completely.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"keep-alive-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEEP_ALIVE_ENABLED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.rest-client.max-redirects","additionalKeys":[],"configDoc":"The maximum number of redirection a request can follow.\n\nCan be overwritten by client-specific settings.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_MAX_REDIRECTS","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.follow-redirects","additionalKeys":[],"configDoc":"A boolean value used to determine whether the client should follow HTTP redirect responses.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"follow-redirects","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_FOLLOW_REDIRECTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.providers","additionalKeys":[],"configDoc":"Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"providers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_PROVIDERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.scope","additionalKeys":[],"configDoc":"The CDI scope to use for injections of REST client instances. Value can be either a fully qualified class name of a CDI scope annotation (such as \"jakarta.enterprise.context.ApplicationScoped\") or its simple name (such as\"ApplicationScoped\").\n\nDefault scope for the rest-client extension is \"Dependent\" (which is the spec-compliant behavior).\n\nDefault scope for the rest-client-reactive extension is \"ApplicationScoped\".\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_SCOPE","enum":false}},{"configDocKey":{"type":"org.eclipse.microprofile.rest.client.ext.QueryParamStyle","key":"quarkus.rest-client.query-param-style","additionalKeys":[],"configDoc":"An enumerated type string value with possible values of \"MULTI_PAIRS\" (default), \"COMMA_SEPARATED\", or \"ARRAY_PAIRS\" that specifies the format in which multiple values for the same query parameter is used.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"query-param-style","configPhase":"RUN_TIME","acceptedValues":["`multi-pairs`","`comma-separated`","`array-pairs`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_QUERY_PARAM_STYLE","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.verify-host","additionalKeys":[],"configDoc":"Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verify-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_VERIFY_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.trust-store","additionalKeys":[],"configDoc":"The trust store location. Can point to either a classpath resource or a file.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.trust-store-password","additionalKeys":[],"configDoc":"The trust store password.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.trust-store-type","additionalKeys":[],"configDoc":"The type of the trust store. Defaults to \"JKS\".\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TRUST_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.key-store","additionalKeys":[],"configDoc":"The key store location. Can point to either a classpath resource or a file.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.key-store-password","additionalKeys":[],"configDoc":"The key store password.\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.key-store-type","additionalKeys":[],"configDoc":"The type of the key store. Defaults to \"JKS\".\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_KEY_STORE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.\n\nThis property is not applicable to the RESTEasy Client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.http2","additionalKeys":[],"configDoc":"If this is true then HTTP/2 will be enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http2","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_HTTP2","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.rest-client.max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size (8096 bytes by default).\n\nCan be overwritten by client-specific settings.","withinAMap":false,"defaultValue":"8k","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.rest-client.alpn","additionalKeys":[],"configDoc":"If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_ALPN","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.capture-stacktrace","additionalKeys":[],"configDoc":"If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"capture-stacktrace","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.KotlinSerializationConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.KotlinSerializationConfig index 5f1dd536ec1..bf3498d8d73 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.KotlinSerializationConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.kotlin.serialization.common.runtime.KotlinSerializationConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-special-floating-point-values","additionalKeys":[],"configDoc":"Removes JSON specification restriction on special floating-point values such as `NaN` and `Infinity` and enables their serialization and deserialization. When enabling it, please ensure that the receiving party will be able to encode and decode these special values.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-special-floating-point-values","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_SPECIAL_FLOATING_POINT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-structured-map-keys","additionalKeys":[],"configDoc":"Enables structured objects to be serialized as map keys by changing serialized form of the map from JSON object (key-value pairs) to flat array like `++[++k1, v1, k2, v2++]++`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-structured-map-keys","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_STRUCTURED_MAP_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.kotlin-serialization.json.class-discriminator","additionalKeys":[],"configDoc":"Name of the class descriptor property for polymorphic serialization.","withinAMap":false,"defaultValue":"type","javaDocSiteLink":"","docMapKey":"class-discriminator","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_CLASS_DISCRIMINATOR","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.coerce-input-values","additionalKeys":[],"configDoc":"Enables coercing incorrect JSON values to the default property value in the following cases: 1. JSON value is `null` but property type is non-nullable. 2. Property type is an enum type, but JSON value contains unknown enum member.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"coerce-input-values","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_COERCE_INPUT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.encode-defaults","additionalKeys":[],"configDoc":"Specifies whether default values of Kotlin properties should be encoded.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encode-defaults","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ENCODE_DEFAULTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.explicit-nulls","additionalKeys":[],"configDoc":"Specifies whether `null` values should be encoded for nullable properties and must be present in JSON object during decoding.\n\nWhen this flag is disabled properties with `null` values without default are not encoded; during decoding, the absence of a field value is treated as `null` for nullable properties without a default value.\n\n`true` by default.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"explicit-nulls","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_EXPLICIT_NULLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.ignore-unknown-keys","additionalKeys":[],"configDoc":"Specifies whether encounters of unknown properties in the input JSON should be ignored instead of throwing ++[++SerializationException++]++.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-unknown-keys","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_IGNORE_UNKNOWN_KEYS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.is-lenient","additionalKeys":[],"configDoc":"Removes JSON specification restriction (RFC-4627) and makes parser more liberal to the malformed input. In lenient mode quoted boolean literals, and unquoted string literals are allowed.\n\nIts relaxations can be expanded in the future, so that lenient parser becomes even more permissive to invalid value in the input, replacing them with defaults.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"is-lenient","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_IS_LENIENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.pretty-print","additionalKeys":[],"configDoc":"Specifies whether resulting JSON should be pretty-printed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pretty-print","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_PRETTY_PRINT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.kotlin-serialization.json.pretty-print-indent","additionalKeys":[],"configDoc":"Specifies indent string to use with ++[++prettyPrint++]++ mode","withinAMap":false,"defaultValue":" ","javaDocSiteLink":"","docMapKey":"pretty-print-indent","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_PRETTY_PRINT_INDENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.use-alternative-names","additionalKeys":[],"configDoc":"Specifies whether Json instance makes use of ++[++JsonNames++]++ annotation.\n\nDisabling this flag when one does not use ++[++JsonNames++]++ at all may sometimes result in better performance, particularly when a large count of fields is skipped with ++[++ignoreUnknownKeys++]++.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"use-alternative-names","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_USE_ALTERNATIVE_NAMES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.use-array-polymorphism","additionalKeys":[],"configDoc":"Switches polymorphic serialization to the default array format. This is an option for legacy JSON format and should not be generally used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-array-polymorphism","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_USE_ARRAY_POLYMORPHISM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.kotlin-serialization.json.naming-strategy","additionalKeys":[],"configDoc":"Specifies the `JsonNamingStrategy` that should be used for all properties in classes for serialization and deserialization. This strategy is applied for all entities that have `StructureKind.CLASS`.\n\n\n\n`null` by default.\n\n\n\nThis element can be one of two things:\n\n . the fully qualified class name of a type implements the `NamingStrategy` interface and has a no-arg constructor\n - a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"naming-strategy","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.decode-enums-case-insensitive","additionalKeys":[],"configDoc":"Specifies if the enum values should be decoded case insensitively.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"decode-enums-case-insensitive","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_DECODE_ENUMS_CASE_INSENSITIVE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-trailing-comma","additionalKeys":[],"configDoc":"Specifies if trailing comma is allowed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-trailing-comma","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_TRAILING_COMMA","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-special-floating-point-values","additionalKeys":[],"configDoc":"Removes JSON specification restriction on special floating-point values such as `NaN` and `Infinity` and enables their serialization and deserialization. When enabling it, please ensure that the receiving party will be able to encode and decode these special values.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-special-floating-point-values","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_SPECIAL_FLOATING_POINT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-structured-map-keys","additionalKeys":[],"configDoc":"Enables structured objects to be serialized as map keys by changing serialized form of the map from JSON object (key-value pairs) to flat array like `++[++k1, v1, k2, v2++]++`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-structured-map-keys","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_STRUCTURED_MAP_KEYS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.kotlin-serialization.json.class-discriminator","additionalKeys":[],"configDoc":"Name of the class descriptor property for polymorphic serialization.","withinAMap":false,"defaultValue":"type","javaDocSiteLink":"","docMapKey":"class-discriminator","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_CLASS_DISCRIMINATOR","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.coerce-input-values","additionalKeys":[],"configDoc":"Enables coercing incorrect JSON values to the default property value in the following cases: 1. JSON value is `null` but property type is non-nullable. 2. Property type is an enum type, but JSON value contains unknown enum member.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"coerce-input-values","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_COERCE_INPUT_VALUES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.encode-defaults","additionalKeys":[],"configDoc":"Specifies whether default values of Kotlin properties should be encoded.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encode-defaults","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ENCODE_DEFAULTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.explicit-nulls","additionalKeys":[],"configDoc":"Specifies whether `null` values should be encoded for nullable properties and must be present in JSON object during decoding.\n\nWhen this flag is disabled properties with `null` values without default are not encoded; during decoding, the absence of a field value is treated as `null` for nullable properties without a default value.\n\n`true` by default.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"explicit-nulls","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_EXPLICIT_NULLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.ignore-unknown-keys","additionalKeys":[],"configDoc":"Specifies whether encounters of unknown properties in the input JSON should be ignored instead of throwing ++[++SerializationException++]++.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore-unknown-keys","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_IGNORE_UNKNOWN_KEYS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.is-lenient","additionalKeys":[],"configDoc":"Removes JSON specification restriction (RFC-4627) and makes parser more liberal to the malformed input. In lenient mode quoted boolean literals, and unquoted string literals are allowed.\n\nIts relaxations can be expanded in the future, so that lenient parser becomes even more permissive to invalid value in the input, replacing them with defaults.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"is-lenient","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_IS_LENIENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.pretty-print","additionalKeys":[],"configDoc":"Specifies whether resulting JSON should be pretty-printed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pretty-print","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_PRETTY_PRINT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.kotlin-serialization.json.pretty-print-indent","additionalKeys":[],"configDoc":"Specifies indent string to use with ++[++prettyPrint++]++ mode","withinAMap":false,"defaultValue":" ","javaDocSiteLink":"","docMapKey":"pretty-print-indent","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_PRETTY_PRINT_INDENT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.use-alternative-names","additionalKeys":[],"configDoc":"Specifies whether Json instance makes use of ++[++JsonNames++]++ annotation.\n\nDisabling this flag when one does not use ++[++JsonNames++]++ at all may sometimes result in better performance, particularly when a large count of fields is skipped with ++[++ignoreUnknownKeys++]++.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"use-alternative-names","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_USE_ALTERNATIVE_NAMES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.use-array-polymorphism","additionalKeys":[],"configDoc":"Switches polymorphic serialization to the default array format. This is an option for legacy JSON format and should not be generally used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-array-polymorphism","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_USE_ARRAY_POLYMORPHISM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.kotlin-serialization.json.naming-strategy","additionalKeys":[],"configDoc":"Specifies the `JsonNamingStrategy` that should be used for all properties in classes for serialization and deserialization. This strategy is applied for all entities that have `StructureKind.CLASS`.\n\n\n\n`null` by default.\n\n\n\nThis element can be one of two things:\n\n . the fully qualified class name of a type implements the `NamingStrategy` interface and has a no-arg constructor\n - a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"naming-strategy","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_NAMING_STRATEGY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.decode-enums-case-insensitive","additionalKeys":[],"configDoc":"Specifies if the enum values should be decoded case insensitively.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"decode-enums-case-insensitive","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_DECODE_ENUMS_CASE_INSENSITIVE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-trailing-comma","additionalKeys":[],"configDoc":"Specifies if trailing comma is allowed.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-trailing-comma","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_TRAILING_COMMA","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.kotlin-serialization.json.allow-comments","additionalKeys":[],"configDoc":"Allows parser to accept C/Java-style comments in JSON input.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-comments","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.kotlin-serialization","since":null,"environmentVariable":"QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.runtime.TlsConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.runtime.TlsConfig deleted file mode 100644 index 3133487d664..00000000000 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.runtime.TlsConfig +++ /dev/null @@ -1 +0,0 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.tls.trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disable by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_ALL","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.spring.cloud.config.client.runtime.SpringCloudConfigClientConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.spring.cloud.config.client.runtime.SpringCloudConfigClientConfig index 5b82ea0be03..f705fd99d34 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.spring.cloud.config.client.runtime.SpringCloudConfigClientConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.spring.cloud.config.client.runtime.SpringCloudConfigClientConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.enabled","additionalKeys":[],"configDoc":"If enabled, will try to read the configuration from a Spring Cloud Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.fail-fast","additionalKeys":[],"configDoc":"If set to true, the application will not stand up if it cannot obtain configuration from the Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-fast","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.url","additionalKeys":[],"configDoc":"The Base URI where the Spring Cloud Config Server is available","withinAMap":false,"defaultValue":"http://localhost:8888","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_URL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.label","additionalKeys":[],"configDoc":"The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally \"master\" when the server uses a Git backend).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"label","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_LABEL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.connection-timeout","additionalKeys":[],"configDoc":"The amount of time to wait when initially establishing a connection before giving up and timing out.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.read-timeout","additionalKeys":[],"configDoc":"The amount of time to wait for a read on a socket before an exception is thrown.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.username","additionalKeys":[],"configDoc":"The username to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.password","additionalKeys":[],"configDoc":"The password to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.trust-store","additionalKeys":[],"configDoc":"TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.trust-store-password","additionalKeys":[],"configDoc":"Password of TrustStore to be used containing the SSL certificate used by the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.key-store","additionalKeys":[],"configDoc":"KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-store-password","additionalKeys":[],"configDoc":"Password of KeyStore to be used containing the SSL certificate for authentication with the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-password","additionalKeys":[],"configDoc":"Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.trust-certs","additionalKeys":[],"configDoc":"When using HTTPS and no keyStore has been specified, whether to trust all certificates","withinAMap":false,"defaultValue":"${quarkus.tls.trust-all:false}","javaDocSiteLink":"","docMapKey":"trust-certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.spring-cloud-config.headers.\"header-name\"","additionalKeys":[],"configDoc":"Custom headers to pass the Spring Cloud Config Server when performing the HTTP request","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.profiles","additionalKeys":[],"configDoc":"The profiles to use for lookup","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"profiles","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PROFILES","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.enabled","additionalKeys":[],"configDoc":"If enabled, will try to read the configuration from a Spring Cloud Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.fail-fast","additionalKeys":[],"configDoc":"If set to true, the application will not stand up if it cannot obtain configuration from the Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-fast","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.url","additionalKeys":[],"configDoc":"The Base URI where the Spring Cloud Config Server is available","withinAMap":false,"defaultValue":"http://localhost:8888","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_URL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.name","additionalKeys":[],"configDoc":"Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma)","withinAMap":false,"defaultValue":"${quarkus.application.name:}","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.label","additionalKeys":[],"configDoc":"The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally \"master\" when the server uses a Git backend).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"label","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_LABEL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.connection-timeout","additionalKeys":[],"configDoc":"The amount of time to wait when initially establishing a connection before giving up and timing out.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.read-timeout","additionalKeys":[],"configDoc":"The amount of time to wait for a read on a socket before an exception is thrown.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.username","additionalKeys":[],"configDoc":"The username to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.password","additionalKeys":[],"configDoc":"The password to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.trust-store","additionalKeys":[],"configDoc":"TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.trust-store-password","additionalKeys":[],"configDoc":"Password of TrustStore to be used containing the SSL certificate used by the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.key-store","additionalKeys":[],"configDoc":"KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-store-password","additionalKeys":[],"configDoc":"Password of KeyStore to be used containing the SSL certificate for authentication with the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-password","additionalKeys":[],"configDoc":"Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.trust-certs","additionalKeys":[],"configDoc":"When using HTTPS and no keyStore has been specified, whether to trust all certificates","withinAMap":false,"defaultValue":"${quarkus.tls.trust-all:false}","javaDocSiteLink":"","docMapKey":"trust-certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.spring-cloud-config.headers.\"header-name\"","additionalKeys":[],"configDoc":"Custom headers to pass the Spring Cloud Config Server when performing the HTTP request","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.profiles","additionalKeys":[],"configDoc":"The profiles to use for lookup","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"profiles","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PROFILES","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.tls.runtime.config.TlsConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.tls.runtime.config.TlsConfig new file mode 100644 index 00000000000..4f81f35a9de --- /dev/null +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.tls.runtime.config.TlsConfig @@ -0,0 +1 @@ +[{"configDocSection":{"name":"quarkus.tls.default-certificate-config","optional":true,"withinAMap":false,"sectionDetails":"= The default TLS bucket configuration","sectionDetailsTitle":"The default TLS bucket configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.TlsBucketConfig","showSection":true,"configDocItems":[{"configDocSection":{"name":"quarkus.tls.key-store","optional":true,"withinAMap":false,"sectionDetails":"== The key store configuration\n\nKey stores are used to store private keys and their associated X.509 certificate chains. For example, for `HTTPS`, it stores the server's private key and the server's certificate. The certificate is used to prove the server's identity to the client.","sectionDetailsTitle":"The key store configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.KeyStoreConfig","showSection":true,"configDocItems":[{"configDocSection":{"name":"quarkus.tls.key-store.pem","optional":true,"withinAMap":false,"sectionDetails":"== Configures the PEM key/certificate pair","sectionDetailsTitle":"Configures the PEM key/certificate pair","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.PemKeyCertConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":"quarkus.tls.key-store.pem.\"key-certs\".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.key-store.pem.\"key-certs\".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.pem.order","additionalKeys":[],"configDoc":"The order of the key/cert files, based on the names in the `keyCerts` map.\n\nBy default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_PEM_ORDER","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".key-store.pem.\"key-certs\".key","additionalKeys":[],"configDoc":"The path to the key file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".key-store.pem.\"key-certs\".cert","additionalKeys":[],"configDoc":"The path to the certificate file (in PEM format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cert","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.pem.order","additionalKeys":[],"configDoc":"The order of the key/cert files, based on the names in the `keyCerts` map.\n\nBy default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.tls.key-store.p12","optional":true,"withinAMap":false,"sectionDetails":"== Configure the PKCS12 key store","sectionDetailsTitle":"Configure the PKCS12 key store","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.P12KeyStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":"quarkus.tls.key-store.p12.path","additionalKeys":[],"configDoc":"Path to the key store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.p12.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.p12.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.p12.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.p12.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_P12_PROVIDER","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".key-store.p12.path","additionalKeys":[],"configDoc":"Path to the key store file (P12 / PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.p12.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.p12.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.p12.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.p12.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.tls.key-store.jks","optional":true,"withinAMap":false,"sectionDetails":"== Configure the JKS key store","sectionDetailsTitle":"Configure the JKS key store","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.JKSKeyStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":"quarkus.tls.key-store.jks.path","additionalKeys":[],"configDoc":"Path to the keystore file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.jks.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.jks.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.jks.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.jks.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_JKS_PROVIDER","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".key-store.jks.path","additionalKeys":[],"configDoc":"Path to the keystore file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.jks.password","additionalKeys":[],"configDoc":"Password of the key store. When not set, the password must be retrieved from the credential provider.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.jks.alias","additionalKeys":[],"configDoc":"Alias of the private key and certificate in the key store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.jks.alias-password","additionalKeys":[],"configDoc":"Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.jks.provider","additionalKeys":[],"configDoc":"Provider of the key store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":"quarkus.tls.key-store.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI).\n\nServer Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios.\n\nWith this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.\n\nWhen configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_SNI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store password.\n\nIf the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.key-store.credentials-provider.alias-password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store alias password.\n\nIf the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store.","withinAMap":false,"defaultValue":"alias-password","javaDocSiteLink":"","docMapKey":"alias-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.tls.\"tls-bucket-name\".key-store.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI).\n\nServer Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios.\n\nWith this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.\n\nWhen configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store password.\n\nIf the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.","withinAMap":true,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".key-store.credentials-provider.alias-password-key","additionalKeys":[],"configDoc":"The key used to retrieve the key store alias password.\n\nIf the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store.","withinAMap":true,"defaultValue":"alias-password","javaDocSiteLink":"","docMapKey":"alias-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.tls.trust-store","optional":true,"withinAMap":false,"sectionDetails":"== The trust store configuration\n\nTrust stores are used to store certificates from trusted entities. For example, for `HTTPS`, it stores the certificate authorities that are trusted by the server. The server uses the trust store to verify the client's certificate when mTLS (client authentication) is enabled.","sectionDetailsTitle":"The trust store configuration","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.TrustStoreConfig","showSection":true,"configDocItems":[{"configDocSection":{"name":"quarkus.tls.trust-store.pem","optional":true,"withinAMap":false,"sectionDetails":"== Configures the list of trusted certificates","sectionDetailsTitle":"Configures the list of trusted certificates","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.PemCertsConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":"quarkus.tls.trust-store.pem.certs","additionalKeys":[],"configDoc":"List of the trusted cert paths (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_PEM_CERTS","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".trust-store.pem.certs","additionalKeys":[],"configDoc":"List of the trusted cert paths (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.tls.trust-store.p12","optional":true,"withinAMap":false,"sectionDetails":"== Configure the PKCS12 trust store","sectionDetailsTitle":"Configure the PKCS12 trust store","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.P12TrustStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":"quarkus.tls.trust-store.p12.path","additionalKeys":[],"configDoc":"Path to the trust store file (P12 / PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.p12.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.p12.alias","additionalKeys":[],"configDoc":"Alias of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.p12.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_P12_PROVIDER","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".trust-store.p12.path","additionalKeys":[],"configDoc":"Path to the trust store file (P12 / PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.p12.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.p12.alias","additionalKeys":[],"configDoc":"Alias of the trust store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.p12.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"quarkus.tls.trust-store.jks","optional":true,"withinAMap":false,"sectionDetails":"== Configure the JKS trust store","sectionDetailsTitle":"Configure the JKS trust store","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.tls","configGroupType":"io.quarkus.tls.runtime.config.JKSTrustStoreConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"path","key":"quarkus.tls.trust-store.jks.path","additionalKeys":[],"configDoc":"Path to the trust store file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.jks.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.jks.alias","additionalKeys":[],"configDoc":"Alias of the key in the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.jks.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".trust-store.jks.path","additionalKeys":[],"configDoc":"Path to the trust store file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.jks.password","additionalKeys":[],"configDoc":"Password of the trust store. If not set, the password must be retrieved from the credential provider.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.jks.alias","additionalKeys":[],"configDoc":"Alias of the key in the trust store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.jks.provider","additionalKeys":[],"configDoc":"Provider of the trust store.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.trust-store.credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the trust store password.\n\nIf the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.credentials-provider.name","additionalKeys":[],"configDoc":"The name of the \"credential\" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used.\n\nA credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.credentials-provider.bean-name","additionalKeys":[],"configDoc":"The name of the bean providing the credential provider.\n\nThe name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected.\n\nIf not set, the default credential provider is used.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"bean-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".trust-store.credentials-provider.password-key","additionalKeys":[],"configDoc":"The key used to retrieve the trust store password.\n\nIf the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.","withinAMap":true,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":"quarkus.tls.cipher-suites","additionalKeys":[],"configDoc":"Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers.\n\nWhen suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.\n\nAlso, setting this replaces the default list of protocols.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.tls.handshake-timeout","additionalKeys":[],"configDoc":"The timeout for the TLS handshake phase.\n\nIf not set, it defaults to 10 seconds.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"handshake-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_HANDSHAKE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.tls.alpn","additionalKeys":[],"configDoc":"Enables the Application-Layer Protocol Negotiation (ALPN).\n\nApplication-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_ALPN","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.certificate-revocation-list","additionalKeys":[],"configDoc":"Sets the list of revoked certificates (paths to files).\n\nA Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore.\n\nTwo formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-revocation-list","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.tls.trust-all","additionalKeys":[],"configDoc":"If set to `true`, the server trusts all certificates.\n\nThis is useful for testing, but should not be used in production.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.\n\nIf set to `NONE`, it does not verify the hostname.\n\nIf not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be \"HTTPS\". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to \"HTTPS\" or \"LDAPS\".","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".cipher-suites","additionalKeys":[],"configDoc":"Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers.\n\nWhen suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.\n\nAlso, setting this replaces the default list of protocols.","withinAMap":true,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.tls.\"tls-bucket-name\".handshake-timeout","additionalKeys":[],"configDoc":"The timeout for the TLS handshake phase.\n\nIf not set, it defaults to 10 seconds.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"handshake-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.tls.\"tls-bucket-name\".alpn","additionalKeys":[],"configDoc":"Enables the Application-Layer Protocol Negotiation (ALPN).\n\nApplication-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"alpn","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__ALPN","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.tls.\"tls-bucket-name\".certificate-revocation-list","additionalKeys":[],"configDoc":"Sets the list of revoked certificates (paths to files).\n\nA Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore.\n\nTwo formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-revocation-list","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.tls.\"tls-bucket-name\".trust-all","additionalKeys":[],"configDoc":"If set to `true`, the server trusts all certificates.\n\nThis is useful for testing, but should not be used in production.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.tls.\"tls-bucket-name\".hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.\n\nIf set to `NONE`, it does not verify the hostname.\n\nIf not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be \"HTTPS\". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to \"HTTPS\" or \"LDAPS\".","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.tls","since":null,"environmentVariable":"QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpBuildTimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpBuildTimeConfig index 02d0797f8eb..c47084f3077 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpBuildTimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.http.root-path","additionalKeys":[],"configDoc":"The HTTP root path. All web content will be served relative to this root path.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"root-path","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ROOT_PATH","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.auth.basic","additionalKeys":[],"configDoc":"If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"basic","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_BASIC","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.form.enabled","additionalKeys":[],"configDoc":"If form authentication is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.post-location","additionalKeys":[],"configDoc":"The post location.","withinAMap":false,"defaultValue":"/j_security_check","javaDocSiteLink":"","docMapKey":"post-location","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_POST_LOCATION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.proactive","additionalKeys":[],"configDoc":"If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"proactive","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PROACTIVE","enum":false}},{"configDocKey":{"type":"io.vertx.core.http.ClientAuth","key":"quarkus.http.ssl.client-auth","additionalKeys":[],"configDoc":"Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`.\n\nWhen set to `REQUIRED`, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to `REQUIRED`, then, `quarkus.http.insecure-requests` is automatically set to `disabled`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/http/ClientAuth.html","docMapKey":"tls-client-auth","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`none`","`request`","`required`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CLIENT_AUTH","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.virtual","additionalKeys":[],"configDoc":"If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"virtual","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_VIRTUAL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.non-application-root-path","additionalKeys":[],"configDoc":"A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,\nand openapi are deployed under this path by default.\n

\n* Relative path (Default, `q`) ->\nNon-application endpoints will be served from\n`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`.\n* Absolute path (`/q`) ->\nNon-application endpoints will be served from the specified path.\n* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables\nthis root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.\n

\nIf the management interface is enabled, the root path for the endpoints exposed on the management interface\nis configured using the `quarkus.management.root-path` property instead of this property.","withinAMap":false,"defaultValue":"q","javaDocSiteLink":"","docMapKey":"non-application-root-path","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.test-timeout","additionalKeys":[],"configDoc":"The REST Assured client timeout for testing.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"test-timeout","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.enable-compression","additionalKeys":[],"configDoc":"If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`.\n\nNote that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-compression","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ENABLE_COMPRESSION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.enable-decompression","additionalKeys":[],"configDoc":"When enabled, vert.x will decompress the request's body if it's compressed.\n\nNote that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-decompression","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ENABLE_DECOMPRESSION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.compress-media-types","additionalKeys":[],"configDoc":"List of media types for which the compression should be enabled automatically, unless declared explicitly via `Compressed` or `Uncompressed`.","withinAMap":false,"defaultValue":"text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/graphql+json","javaDocSiteLink":"","docMapKey":"compress-media-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_COMPRESS_MEDIA_TYPES","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.compression-level","additionalKeys":[],"configDoc":"The compression level used when compression support is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_COMPRESSION_LEVEL","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.http.root-path","additionalKeys":[],"configDoc":"The HTTP root path. All web content will be served relative to this root path.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"root-path","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ROOT_PATH","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.auth.basic","additionalKeys":[],"configDoc":"If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"basic","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_BASIC","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.form.enabled","additionalKeys":[],"configDoc":"If form authentication is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.post-location","additionalKeys":[],"configDoc":"The post location.","withinAMap":false,"defaultValue":"/j_security_check","javaDocSiteLink":"","docMapKey":"post-location","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_POST_LOCATION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.proactive","additionalKeys":[],"configDoc":"If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"proactive","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PROACTIVE","enum":false}},{"configDocKey":{"type":"io.vertx.core.http.ClientAuth","key":"quarkus.http.ssl.client-auth","additionalKeys":[],"configDoc":"Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`.\n\nWhen set to `REQUIRED`, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to `REQUIRED`, then, `quarkus.http.insecure-requests` is automatically set to `disabled`.","withinAMap":false,"defaultValue":"none","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/http/ClientAuth.html","docMapKey":"tls-client-auth","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`none`","`request`","`required`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CLIENT_AUTH","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.virtual","additionalKeys":[],"configDoc":"If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"virtual","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_VIRTUAL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.non-application-root-path","additionalKeys":[],"configDoc":"A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,\nand openapi are deployed under this path by default.\n

\n* Relative path (Default, `q`) ->\nNon-application endpoints will be served from\n`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`.\n* Absolute path (`/q`) ->\nNon-application endpoints will be served from the specified path.\n* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables\nthis root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.\n

\nIf the management interface is enabled, the root path for the endpoints exposed on the management interface\nis configured using the `quarkus.management.root-path` property instead of this property.","withinAMap":false,"defaultValue":"q","javaDocSiteLink":"","docMapKey":"non-application-root-path","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.test-timeout","additionalKeys":[],"configDoc":"The REST Assured client timeout for testing.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"test-timeout","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.enable-compression","additionalKeys":[],"configDoc":"If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`.\n\nNote that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-compression","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ENABLE_COMPRESSION","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.enable-decompression","additionalKeys":[],"configDoc":"When enabled, vert.x will decompress the request's body if it's compressed.\n\nNote that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-decompression","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ENABLE_DECOMPRESSION","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.compressors","additionalKeys":[],"configDoc":"If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project.\n\nClient expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip","withinAMap":false,"defaultValue":"gzip,deflate","javaDocSiteLink":"","docMapKey":"compressors","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_COMPRESSORS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.compress-media-types","additionalKeys":[],"configDoc":"List of media types for which the compression should be enabled automatically, unless declared explicitly via `Compressed` or `Uncompressed`.","withinAMap":false,"defaultValue":"text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/graphql+json","javaDocSiteLink":"","docMapKey":"compress-media-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_COMPRESS_MEDIA_TYPES","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.compression-level","additionalKeys":[],"configDoc":"The compression level used when compression support is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_COMPRESSION_LEVEL","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration index cb78b416df9..f095bcbd45b 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.auth.permission.\"permissions\".enabled","additionalKeys":[],"configDoc":"Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".policy","additionalKeys":[],"configDoc":"The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"policy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__POLICY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".methods","additionalKeys":[],"configDoc":"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.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".paths","additionalKeys":[],"configDoc":"The paths that this permission check applies to. If the path ends in /++*++ then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__PATHS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".auth-mechanism","additionalKeys":[],"configDoc":"Path specific authentication mechanism which must be used to authenticate a user. It needs to match `HttpCredentialTransport` authentication scheme such as 'basic', 'bearer', 'form', etc.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-mechanism","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.permission.\"permissions\".shared","additionalKeys":[],"configDoc":"Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__SHARED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo","key":"quarkus.http.auth.permission.\"permissions\".applies-to","additionalKeys":[],"configDoc":"Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.","withinAMap":true,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"applies-to","configPhase":"RUN_TIME","acceptedValues":["tooltip:all[Apply on all matching paths.]","tooltip:jaxrs[Declares that a permission check must only be applied on the Jakarta REST request paths. Use this option to delay the permission check if an authentication mechanism is chosen with an annotation on the matching Jakarta REST endpoint. This option must be set if the following REST endpoint annotations are used: - `io.quarkus.oidc.Tenant` annotation which selects an OIDC authentication mechanism with a tenant identifier - `io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` which selects the Basic authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` which selects the Form-based authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` which selects the mTLS authentication mechanism - `io.quarkus.security.webauthn.WebAuthn` which selects the WebAuth authentication mechanism - `io.quarkus.oidc.BearerTokenAuthentication` which selects the OpenID Connect Bearer token authentication mechanism - `io.quarkus.oidc.AuthorizationCodeFlow` which selects the OpenID Connect Code authentication mechanism]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__APPLIES_TO","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.policy.\"role-policy\".roles-allowed","additionalKeys":[],"configDoc":"The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.","withinAMap":true,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"roles-allowed","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.http.auth.policy.\"role-policy\".roles.\"role-name\"","additionalKeys":[],"configDoc":"Add roles granted to the `SecurityIdentity` based on the roles that the `SecurityIdentity` already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.http.auth.policy.\"role-policy\".permissions.\"role-name\"","additionalKeys":[],"configDoc":"Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.policy.\"role-policy\".permission-class","additionalKeys":[],"configDoc":"Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String++[]++`). Permission class must be registered for reflection if you run your application in a native mode.","withinAMap":true,"defaultValue":"io.quarkus.security.StringPermission","javaDocSiteLink":"","docMapKey":"permission-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__PERMISSION_CLASS","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.http.auth.roles-mapping.\"role-name\"","additionalKeys":[],"configDoc":"Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.\n\nFor example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_ROLES_MAPPING__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.auth.certificate-role-properties","additionalKeys":[],"configDoc":"Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.\n\nProperties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-role-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.realm","additionalKeys":[],"configDoc":"The authentication realm","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_REALM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.login-page","additionalKeys":[],"configDoc":"The login page. Redirect to login page can be disabled by setting `quarkus.http.auth.form.login-page=`.","withinAMap":false,"defaultValue":"/login.html","javaDocSiteLink":"","docMapKey":"login-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_LOGIN_PAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.username-parameter","additionalKeys":[],"configDoc":"The username field name.","withinAMap":false,"defaultValue":"j_username","javaDocSiteLink":"","docMapKey":"username-parameter","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_USERNAME_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.password-parameter","additionalKeys":[],"configDoc":"The password field name.","withinAMap":false,"defaultValue":"j_password","javaDocSiteLink":"","docMapKey":"password-parameter","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_PASSWORD_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.error-page","additionalKeys":[],"configDoc":"The error page. Redirect to error page can be disabled by setting `quarkus.http.auth.form.error-page=`.","withinAMap":false,"defaultValue":"/error.html","javaDocSiteLink":"","docMapKey":"error-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_ERROR_PAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.landing-page","additionalKeys":[],"configDoc":"The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting `quarkus.http.auth.form.landing-page=`.","withinAMap":false,"defaultValue":"/index.html","javaDocSiteLink":"","docMapKey":"landing-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_LANDING_PAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.location-cookie","additionalKeys":[],"configDoc":"Option to control the name of the cookie used to redirect the user back to the location they want to access.","withinAMap":false,"defaultValue":"quarkus-redirect-location","javaDocSiteLink":"","docMapKey":"location-cookie","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_LOCATION_COOKIE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.auth.form.timeout","additionalKeys":[],"configDoc":"The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.","withinAMap":false,"defaultValue":"PT30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.auth.form.new-cookie-interval","additionalKeys":[],"configDoc":"How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as \"renewal-timeout\". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user's last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.","withinAMap":false,"defaultValue":"PT1M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"new-cookie-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.cookie-name","additionalKeys":[],"configDoc":"The cookie that is used to store the persistent session","withinAMap":false,"defaultValue":"quarkus-credential","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_COOKIE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.cookie-path","additionalKeys":[],"configDoc":"The cookie path for the session and location cookies.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_COOKIE_PATH","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.form.http-only-cookie","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http-only-cookie","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_HTTP_ONLY_COOKIE","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.FormAuthRuntimeConfig.CookieSameSite","key":"quarkus.http.auth.form.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session and location cookies.","withinAMap":false,"defaultValue":"strict","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"RUN_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_COOKIE_SAME_SITE","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.cors","additionalKeys":[],"configDoc":"Enable the CORS filter.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cors-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.port","additionalKeys":[],"configDoc":"The HTTP port","withinAMap":false,"defaultValue":"8080","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.test-port","additionalKeys":[],"configDoc":"The HTTP port used to run tests","withinAMap":false,"defaultValue":"8081","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.host","additionalKeys":[],"configDoc":"The HTTP host\n\nIn dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0\n\nDefaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.\n\nAs an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.test-host","additionalKeys":[],"configDoc":"Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running and listening on the host specified by this property.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_HOST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.host-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"host-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HOST_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.ssl-port","additionalKeys":[],"configDoc":"The HTTPS port","withinAMap":false,"defaultValue":"8443","javaDocSiteLink":"","docMapKey":"ssl-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.test-ssl-port","additionalKeys":[],"configDoc":"The HTTPS port used to run tests","withinAMap":false,"defaultValue":"8444","javaDocSiteLink":"","docMapKey":"test-ssl-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_SSL_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.test-ssl-enabled","additionalKeys":[],"configDoc":"Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running to configure the test to use SSL.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-ssl-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_SSL_ENABLED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.HttpConfiguration.InsecureRequests","key":"quarkus.http.insecure-requests","additionalKeys":[],"configDoc":"If insecure (i.e. http rather than https) requests are allowed. If this is `enabled` then http works as normal. `redirect` will still open the http port, but all requests will be redirected to the HTTPS port. `disabled` will prevent the HTTP port from opening at all.\n\nDefault is `enabled` except when client auth is set to `required` (configured using `quarkus.http.ssl.client-auth=required`). In this case, the default is `disabled`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"insecure-requests","configPhase":"RUN_TIME","acceptedValues":["`enabled`","`redirect`","`disabled`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_INSECURE_REQUESTS","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.http2","additionalKeys":[],"configDoc":"If this is true (the default) then HTTP/2 will be enabled.\n\nNote that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"http2","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HTTP2","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.http2-push-enabled","additionalKeys":[],"configDoc":"Enables or Disable the HTTP/2 Push feature. This setting can be used to disable server push. The server will not send a `PUSH_PROMISE` frame if it receives this parameter set to @++{++code false++}++.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"http2-push-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HTTP2_PUSH_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.origins","additionalKeys":[],"configDoc":"Origins allowed for CORS Comma separated list of valid URLs, e.g.: http://www.quarkus.io,http://localhost:3000 In case an entry of the list is surrounded by forward slashes, it is interpreted as a regular expression.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"origins","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_ORIGINS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.methods","additionalKeys":[],"configDoc":"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","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.headers","additionalKeys":[],"configDoc":"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","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_HEADERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.exposed-headers","additionalKeys":[],"configDoc":"HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"exposed-headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_EXPOSED_HEADERS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.cors.access-control-max-age","additionalKeys":[],"configDoc":"The `Access-Control-Max-Age` response header value indicating how long the results of a pre-flight request can be cached.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"access-control-max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.cors.access-control-allow-credentials","additionalKeys":[],"configDoc":"The `Access-Control-Allow-Credentials` header is used to tell the browsers to expose the response to front-end JavaScript code when the request’s credentials mode Request.credentials is “include”. The value of this header will default to `true` if `quarkus.http.cors.origins` property is set and there is a match with the precise `Origin` header.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"access-control-allow-credentials","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.credentials-provider","additionalKeys":[],"configDoc":"The `CredentialsProvider`. If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured.\n\nPlease note that using MicroProfile `ConfigSource` which is directly supported by Quarkus Configuration should be preferred unless using `CredentialsProvider` provides for some additional security and dynamism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.credentials-provider-name","additionalKeys":[],"configDoc":"The credentials provider bean name.\n\nThis is a bean name (as in `@Named`) of a bean that implements `CredentialsProvider`. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.\n\nFor Vault, the credentials provider bean name is `vault-credentials-provider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.files","additionalKeys":[],"configDoc":"The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.key-files","additionalKeys":[],"configDoc":"The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled.\n\nThe order of the key files must match the order of the certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.key-store-file","additionalKeys":[],"configDoc":"An optional keystore that holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the key store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-alias-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it is different from `key-store-password` If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-alias-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password for the alias from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.trust-store-file","additionalKeys":[],"configDoc":"An optional trust store that holds the certificate information of the trusted certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.trust-store-files","additionalKeys":[],"configDoc":"An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the trust store file. If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the trust store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-cert-alias","additionalKeys":[],"configDoc":"An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.ssl.certificate.reload-period","additionalKeys":[],"configDoc":"When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified.\n\nAlso, the update can also occur when the TLS certificate is configured using paths (and not in-memory).\n\nThe reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reload-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_RELOAD_PERIOD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.cipher-suites","additionalKeys":[],"configDoc":"The cipher suites to use. If none is given, a reasonable default is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled SSL/TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_PROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.ssl.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_SNI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.static-resources.index-page","additionalKeys":[],"configDoc":"Set the index page when serving static resources.","withinAMap":false,"defaultValue":"index.html","javaDocSiteLink":"","docMapKey":"index-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_INDEX_PAGE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.static-resources.include-hidden","additionalKeys":[],"configDoc":"Set whether hidden files should be served.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-hidden","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_INCLUDE_HIDDEN","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.static-resources.enable-range-support","additionalKeys":[],"configDoc":"Set whether range requests (resumable downloads; media streaming) should be enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-range-support","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_ENABLE_RANGE_SUPPORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.static-resources.caching-enabled","additionalKeys":[],"configDoc":"Set whether cache handling is enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"caching-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_CACHING_ENABLED","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.static-resources.cache-entry-timeout","additionalKeys":[],"configDoc":"Set the cache entry timeout. The default is `30` seconds.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cache-entry-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_CACHE_ENTRY_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.static-resources.max-age","additionalKeys":[],"configDoc":"Set value for max age in caching headers. The default is `24` hours.","withinAMap":false,"defaultValue":"24H","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_MAX_AGE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.static-resources.max-cache-size","additionalKeys":[],"configDoc":"Set the max cache size.","withinAMap":false,"defaultValue":"10000","javaDocSiteLink":"","docMapKey":"max-cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_MAX_CACHE_SIZE","enum":false}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.http.static-resources.content-encoding","additionalKeys":[],"configDoc":"Content encoding for text related files","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"content-encoding","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_CONTENT_ENCODING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.handle-100-continue-automatically","additionalKeys":[],"configDoc":"When set to `true`, the HTTP server automatically sends `100 CONTINUE` response when the request expects it (with the `Expect: 100-Continue` header).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"handle100-continue-automatically","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HANDLE_100_CONTINUE_AUTOMATICALLY","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.io-threads","additionalKeys":[],"configDoc":"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.\n\nIn 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.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"io-threads","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_IO_THREADS","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-header-size","additionalKeys":[],"configDoc":"The maximum length of all headers.","withinAMap":false,"defaultValue":"20K","javaDocSiteLink":"","docMapKey":"max-header-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-body-size","additionalKeys":[],"configDoc":"The maximum size of a request body.","withinAMap":false,"defaultValue":"10240K","javaDocSiteLink":"","docMapKey":"max-body-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size","withinAMap":false,"defaultValue":"8192","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.limits.max-initial-line-length","additionalKeys":[],"configDoc":"The maximum length of the initial line (e.g. `\"GET / HTTP/1.0\"`).","withinAMap":false,"defaultValue":"4096","javaDocSiteLink":"","docMapKey":"max-initial-line-length","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_INITIAL_LINE_LENGTH","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-form-attribute-size","additionalKeys":[],"configDoc":"The maximum length of a form attribute.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-form-attribute-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.limits.max-form-fields","additionalKeys":[],"configDoc":"Set the maximum number of fields of a form. Set to `-1` to allow unlimited number of attributes.","withinAMap":false,"defaultValue":"256","javaDocSiteLink":"","docMapKey":"max-form-fields","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FORM_FIELDS","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-form-buffered-bytes","additionalKeys":[],"configDoc":"Set the maximum number of bytes a server can buffer when decoding a form. Set to `-1` to allow unlimited length","withinAMap":false,"defaultValue":"1K","javaDocSiteLink":"","docMapKey":"max-form-buffered-bytes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FORM_BUFFERED_BYTES","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.limits.max-parameters","additionalKeys":[],"configDoc":"The maximum number of HTTP request parameters permitted for incoming requests.\n\nIf a client sends more than this number of parameters in a request, the connection is closed.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"max-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_PARAMETERS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.limits.max-connections","additionalKeys":[],"configDoc":"The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_CONNECTIONS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.http.limits.header-table-size","additionalKeys":[],"configDoc":"Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting.\n\nAllows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is `4,096` octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-table-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_HEADER_TABLE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.http.limits.max-concurrent-streams","additionalKeys":[],"configDoc":"Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting.\n\nIndicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-concurrent-streams","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_CONCURRENT_STREAMS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.limits.max-frame-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is `2^14` (16,384) octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-frame-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FRAME_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.http.limits.max-header-list-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is `8192`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-header-list-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_HEADER_LIST_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.limits.rst-flood-max-rst-frame-per-window","additionalKeys":[],"configDoc":"Set the max number of RST frame allowed per time window, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks]. The default value is `200`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"rst-flood-max-rst-frame-per-window","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.limits.rst-flood-window-duration","additionalKeys":[],"configDoc":"Set the duration of the time window when checking the max number of RST frames, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks].. The default value is `30 s`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"rst-flood-window-duration","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_RST_FLOOD_WINDOW_DURATION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.idle-timeout","additionalKeys":[],"configDoc":"Http connection idle timeout","withinAMap":false,"defaultValue":"30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.read-timeout","additionalKeys":[],"configDoc":"Http connection read timeout for blocking IO. This is the maximum amount of time a thread will wait for data, before an IOException will be thrown and the connection closed.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.handle-file-uploads","additionalKeys":[],"configDoc":"Whether the files sent using `multipart/form-data` will be stored locally.\n\nIf `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 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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"handle-file-uploads","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_HANDLE_FILE_UPLOADS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.body.uploads-directory","additionalKeys":[],"configDoc":"The directory where the files sent using `multipart/form-data` should be stored.\n\nEither an absolute path or a path relative to the current directory of the application process.","withinAMap":false,"defaultValue":"${java.io.tmpdir}/uploads","javaDocSiteLink":"","docMapKey":"uploads-directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_UPLOADS_DIRECTORY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.merge-form-attributes","additionalKeys":[],"configDoc":"Whether the form attributes should be added to the request parameters.\n\nIf `true`, the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"merge-form-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_MERGE_FORM_ATTRIBUTES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.delete-uploaded-files-on-end","additionalKeys":[],"configDoc":"Whether the uploaded files should be removed after serving the request.\n\nIf `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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"delete-uploaded-files-on-end","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_DELETE_UPLOADED_FILES_ON_END","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.preallocate-body-buffer","additionalKeys":[],"configDoc":"Whether the body buffer should pre-allocated based on the `Content-Length` header value.\n\nIf `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","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"preallocate-body-buffer","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_PREALLOCATE_BODY_BUFFER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.body.multipart.file-content-types","additionalKeys":[],"configDoc":"A comma-separated list of `ContentType` to indicate whether a given multipart field should be handled as a file part. You can use this setting to force HTTP-based extensions to parse a message part as a file based on its content type. For now, this setting only works when using RESTEasy Reactive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"file-content-types","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_MULTIPART_FILE_CONTENT_TYPES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.session.encryption-key","additionalKeys":[],"configDoc":"The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here.\n\nIf no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_SESSION_ENCRYPTION_KEY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.so-reuse-port","additionalKeys":[],"configDoc":"Enable socket reuse port (linux/macOs native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"so-reuse-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SO_REUSE_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.tcp-quick-ack","additionalKeys":[],"configDoc":"Enable tcp quick ack (linux native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tcp-quick-ack","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.tcp-cork","additionalKeys":[],"configDoc":"Enable tcp cork (linux native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tcp-cork","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TCP_CORK","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.tcp-fast-open","additionalKeys":[],"configDoc":"Enable tcp fast open (linux native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tcp-fast-open","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.accept-backlog","additionalKeys":[],"configDoc":"The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected","withinAMap":false,"defaultValue":"-1","javaDocSiteLink":"","docMapKey":"accept-backlog","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCEPT_BACKLOG","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.initial-window-size","additionalKeys":[],"configDoc":"Set the SETTINGS_INITIAL_WINDOW_SIZE HTTP/2 setting. Indicates the sender's initial window size (in octets) for stream-level flow control. The initial value is `2^16-1` (65,535) octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-window-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_INITIAL_WINDOW_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.domain-socket","additionalKeys":[],"configDoc":"Path to a unix domain socket","withinAMap":false,"defaultValue":"/var/run/io.quarkus.app.socket","javaDocSiteLink":"","docMapKey":"domain-socket","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_DOMAIN_SOCKET","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.domain-socket-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"domain-socket-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_DOMAIN_SOCKET_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.record-request-start-time","additionalKeys":[],"configDoc":"If this is true then the request start time will be recorded to enable logging of total request time.\n\nThis has a small performance penalty, so is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"record-request-start-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_RECORD_REQUEST_START_TIME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.enabled","additionalKeys":[],"configDoc":"If access logging is enabled. By default this will log via the standard logging facility","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.exclude-pattern","additionalKeys":[],"configDoc":"A regular expression that can be used to exclude some paths from logging.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"exclude-pattern","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_EXCLUDE_PATTERN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.pattern","additionalKeys":[],"configDoc":"The access log pattern.\n\nIf this is the string `common`, `combined` or `long` then this will use one of the specified named formats:\n\n- common: `%h %l %u %t \"%r\" %s %b`\n- combined: `%h %l %u %t \"%r\" %s %b \"%{i,Referer}\" \"%{i,User-Agent}\"`\n- long: `%r\\n%{ALL_REQUEST_HEADERS}`\n\nOtherwise, consult the Quarkus documentation for the full list of variables that can be used.","withinAMap":false,"defaultValue":"common","javaDocSiteLink":"","docMapKey":"pattern","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_PATTERN","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.log-to-file","additionalKeys":[],"configDoc":"If logging should be done to a separate file.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-to-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_LOG_TO_FILE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.base-file-name","additionalKeys":[],"configDoc":"The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"base-file-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_BASE_FILE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.log-directory","additionalKeys":[],"configDoc":"The log directory to use when logging access to a file If this is not set then the current working directory is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"log-directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_LOG_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.log-suffix","additionalKeys":[],"configDoc":"The log file suffix","withinAMap":false,"defaultValue":".log","javaDocSiteLink":"","docMapKey":"log-suffix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_LOG_SUFFIX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.category","additionalKeys":[],"configDoc":"The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty).","withinAMap":false,"defaultValue":"io.quarkus.http.access-log","javaDocSiteLink":"","docMapKey":"category","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_CATEGORY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.rotate","additionalKeys":[],"configDoc":"If the log should be rotated daily","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"rotate","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_ROTATE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.consolidate-rerouted-requests","additionalKeys":[],"configDoc":"If rerouted requests should be consolidated into one log entry","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"consolidate-rerouted-requests","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_CONSOLIDATE_REROUTED_REQUESTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.traffic-shaping.enabled","additionalKeys":[],"configDoc":"Enables the traffic shaping.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_ENABLED","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.traffic-shaping.inbound-global-bandwidth","additionalKeys":[],"configDoc":"Set bandwidth limit in bytes per second for inbound connections. If not set, no limits are applied.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"inbound-global-bandwidth","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_INBOUND_GLOBAL_BANDWIDTH","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.traffic-shaping.outbound-global-bandwidth","additionalKeys":[],"configDoc":"Set bandwidth limit in bytes per second for outbound connections. If not set, no limits are applied.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"outbound-global-bandwidth","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_OUTBOUND_GLOBAL_BANDWIDTH","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.traffic-shaping.max-delay","additionalKeys":[],"configDoc":"Set the maximum delay to wait in case of traffic excess. Default is 15s. Must be less than the HTTP timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_MAX_DELAY","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.traffic-shaping.check-interval","additionalKeys":[],"configDoc":"Set the delay between two computations of performances for channels. If set to 0, no stats are computed. Despite 0 is accepted (no accounting), it is recommended to set a positive value for the check interval, even if it is high since the precision of the traffic shaping depends on the period where the traffic is computed. In this case, a suggested value is something close to 5 or 10 minutes.\n\nIf not default, it defaults to 1s.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"check-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_CHECK_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.traffic-shaping.peak-outbound-global-bandwidth","additionalKeys":[],"configDoc":"Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write are suspended. The default value is 400 MB.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"peak-outbound-global-bandwidth","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_PEAK_OUTBOUND_GLOBAL_BANDWIDTH","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".case-sensitive","additionalKeys":[],"configDoc":"If the cookie pattern is case-sensitive","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"case-sensitive","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__CASE_SENSITIVE","enum":false}},{"configDocKey":{"type":"io.vertx.core.http.CookieSameSite","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".value","additionalKeys":[],"configDoc":"The value to set in the samesite attribute","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/http/CookieSameSite.html","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":["`none`","`strict`","`lax`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__VALUE","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".enable-client-checker","additionalKeys":[],"configDoc":"Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-client-checker","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ENABLE_CLIENT_CHECKER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".add-secure-for-none","additionalKeys":[],"configDoc":"If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-secure-for-none","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ADD_SECURE_FOR_NONE","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.HttpConfiguration.PayloadHint","key":"quarkus.http.unhandled-error-content-type-default","additionalKeys":[],"configDoc":"Provides a hint (optional) for the default content type of responses generated for the errors not handled by the application.\n\nIf the client requested a supported content-type in request headers (e.g. \"Accept: application/json\", \"Accept: text/html\"), Quarkus will use that content type.\n\nOtherwise, it will default to the content type configured here.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"unhandled-error-content-type-default","configPhase":"RUN_TIME","acceptedValues":["`json`","`html`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_UNHANDLED_ERROR_CONTENT_TYPE_DEFAULT","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.http.header.\"header\".path","additionalKeys":[],"configDoc":"The path this header should be applied","withinAMap":true,"defaultValue":"/*","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HEADER__HEADER__PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.header.\"header\".value","additionalKeys":[],"configDoc":"The value for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HEADER__HEADER__VALUE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.header.\"header\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HEADER__HEADER__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.filter.\"filter\".matches","additionalKeys":[],"configDoc":"A regular expression for the paths matching this configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"matches","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__MATCHES","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.http.filter.\"filter\".header.\"header-name\"","additionalKeys":[],"configDoc":"Additional HTTP Headers always sent in the response","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__HEADER__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.filter.\"filter\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this path configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__METHODS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.filter.\"filter\".order","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__ORDER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.use-proxy-protocol","additionalKeys":[],"configDoc":"Set whether the server should use the HA `PROXY` protocol when serving requests from behind a proxy. (see the link:https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt[PROXY Protocol]). When set to `true`, the remote address returned will be the one from the actual connecting client. If it is set to `false` (default), the remote address returned will be the one from the proxy.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-proxy-protocol","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_USE_PROXY_PROTOCOL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.proxy-address-forwarding","additionalKeys":[],"configDoc":"If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as `X-Forwarded-For`. This should only be set if you are behind a proxy that sets these headers.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"proxy-address-forwarding","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_PROXY_ADDRESS_FORWARDING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.allow-forwarded","additionalKeys":[],"configDoc":"If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ALLOW_FORWARDED","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.proxy.allow-x-forwarded","additionalKeys":[],"configDoc":"If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"allow-x-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ALLOW_X_FORWARDED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.enable-forwarded-host","additionalKeys":[],"configDoc":"Enable override the received request's host through a forwarded host header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.proxy.forwarded-host-header","additionalKeys":[],"configDoc":"Configure the forwarded host header to be used if override enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Host","javaDocSiteLink":"","docMapKey":"forwarded-host-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_FORWARDED_HOST_HEADER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.enable-forwarded-prefix","additionalKeys":[],"configDoc":"Enable prefix the received request's path with a forwarded prefix header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-prefix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_PREFIX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.proxy.forwarded-prefix-header","additionalKeys":[],"configDoc":"Configure the forwarded prefix header to be used if prefixing enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Prefix","javaDocSiteLink":"","docMapKey":"forwarded-prefix-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_FORWARDED_PREFIX_HEADER","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.TrustedProxyCheck.TrustedProxyCheckPart","key":"quarkus.http.proxy.trusted-proxies","additionalKeys":[],"configDoc":"Configure the list of trusted proxy addresses. Received `Forwarded`, `X-Forwarded` or `X-Forwarded-++*++` headers from any other proxy address will be ignored. The trusted proxy address should be specified as the IP address (IPv4 or IPv6), hostname or Classless Inter-Domain Routing (CIDR) notation. Please note that Quarkus needs to perform DNS lookup for all hostnames during the request. For that reason, using hostnames is not recommended.\n\nExamples of a socket address in the form of `host` or `host:port`:\n\n - `127.0.0.1:8084`\n - `++[++0:0:0:0:0:0:0:1++]++`\n - `++[++0:0:0:0:0:0:0:1++]++:8084`\n - `++[++::++]++`\n - `localhost`\n - `localhost:8084`\n\nExamples of a CIDR notation:\n\n - `::/128`\n - `::/0`\n - `127.0.0.0/8`\n\nPlease bear in mind that IPv4 CIDR won't match request sent from the IPv6 address and the other way around.","withinAMap":false,"defaultValue":"All proxy addresses are trusted","javaDocSiteLink":"","docMapKey":"trusted-proxies","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_TRUSTED_PROXIES","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.auth.permission.\"permissions\".enabled","additionalKeys":[],"configDoc":"Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".policy","additionalKeys":[],"configDoc":"The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"policy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__POLICY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".methods","additionalKeys":[],"configDoc":"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.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".paths","additionalKeys":[],"configDoc":"The paths that this permission check applies to. If the path ends in /++*++ then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__PATHS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.permission.\"permissions\".auth-mechanism","additionalKeys":[],"configDoc":"Path specific authentication mechanism which must be used to authenticate a user. It needs to match `HttpCredentialTransport` authentication scheme such as 'basic', 'bearer', 'form', etc.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-mechanism","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.permission.\"permissions\".shared","additionalKeys":[],"configDoc":"Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__SHARED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo","key":"quarkus.http.auth.permission.\"permissions\".applies-to","additionalKeys":[],"configDoc":"Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.","withinAMap":true,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"applies-to","configPhase":"RUN_TIME","acceptedValues":["tooltip:all[Apply on all matching paths.]","tooltip:jaxrs[Declares that a permission check must only be applied on the Jakarta REST request paths. Use this option to delay the permission check if an authentication mechanism is chosen with an annotation on the matching Jakarta REST endpoint. This option must be set if the following REST endpoint annotations are used: - `io.quarkus.oidc.Tenant` annotation which selects an OIDC authentication mechanism with a tenant identifier - `io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` which selects the Basic authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` which selects the Form-based authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` which selects the mTLS authentication mechanism - `io.quarkus.security.webauthn.WebAuthn` which selects the WebAuth authentication mechanism - `io.quarkus.oidc.BearerTokenAuthentication` which selects the OpenID Connect Bearer token authentication mechanism - `io.quarkus.oidc.AuthorizationCodeFlow` which selects the OpenID Connect Code authentication mechanism]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__APPLIES_TO","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.policy.\"role-policy\".roles-allowed","additionalKeys":[],"configDoc":"The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.","withinAMap":true,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"roles-allowed","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.http.auth.policy.\"role-policy\".roles.\"role-name\"","additionalKeys":[],"configDoc":"Add roles granted to the `SecurityIdentity` based on the roles that the `SecurityIdentity` already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.http.auth.policy.\"role-policy\".permissions.\"role-name\"","additionalKeys":[],"configDoc":"Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.policy.\"role-policy\".permission-class","additionalKeys":[],"configDoc":"Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String++[]++`). Permission class must be registered for reflection if you run your application in a native mode.","withinAMap":true,"defaultValue":"io.quarkus.security.StringPermission","javaDocSiteLink":"","docMapKey":"permission-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__PERMISSION_CLASS","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.http.auth.roles-mapping.\"role-name\"","additionalKeys":[],"configDoc":"Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.\n\nFor example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_ROLES_MAPPING__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.certificate-role-attribute","additionalKeys":[],"configDoc":"Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:\n\n - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.\n - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.\n - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).\n - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`","withinAMap":false,"defaultValue":"CN","javaDocSiteLink":"","docMapKey":"certificate-role-attribute","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.auth.certificate-role-properties","additionalKeys":[],"configDoc":"Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.\n\nProperties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate-role-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.realm","additionalKeys":[],"configDoc":"The authentication realm","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_REALM","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.login-page","additionalKeys":[],"configDoc":"The login page. Redirect to login page can be disabled by setting `quarkus.http.auth.form.login-page=`.","withinAMap":false,"defaultValue":"/login.html","javaDocSiteLink":"","docMapKey":"login-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_LOGIN_PAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.username-parameter","additionalKeys":[],"configDoc":"The username field name.","withinAMap":false,"defaultValue":"j_username","javaDocSiteLink":"","docMapKey":"username-parameter","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_USERNAME_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.password-parameter","additionalKeys":[],"configDoc":"The password field name.","withinAMap":false,"defaultValue":"j_password","javaDocSiteLink":"","docMapKey":"password-parameter","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_PASSWORD_PARAMETER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.error-page","additionalKeys":[],"configDoc":"The error page. Redirect to error page can be disabled by setting `quarkus.http.auth.form.error-page=`.","withinAMap":false,"defaultValue":"/error.html","javaDocSiteLink":"","docMapKey":"error-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_ERROR_PAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.landing-page","additionalKeys":[],"configDoc":"The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting `quarkus.http.auth.form.landing-page=`.","withinAMap":false,"defaultValue":"/index.html","javaDocSiteLink":"","docMapKey":"landing-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_LANDING_PAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.location-cookie","additionalKeys":[],"configDoc":"Option to control the name of the cookie used to redirect the user back to the location they want to access.","withinAMap":false,"defaultValue":"quarkus-redirect-location","javaDocSiteLink":"","docMapKey":"location-cookie","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_LOCATION_COOKIE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.auth.form.timeout","additionalKeys":[],"configDoc":"The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.","withinAMap":false,"defaultValue":"PT30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.auth.form.new-cookie-interval","additionalKeys":[],"configDoc":"How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as \"renewal-timeout\". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user's last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.","withinAMap":false,"defaultValue":"PT1M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"new-cookie-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.cookie-name","additionalKeys":[],"configDoc":"The cookie that is used to store the persistent session","withinAMap":false,"defaultValue":"quarkus-credential","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_COOKIE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.form.cookie-path","additionalKeys":[],"configDoc":"The cookie path for the session and location cookies.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_COOKIE_PATH","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.auth.form.http-only-cookie","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http-only-cookie","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_HTTP_ONLY_COOKIE","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.FormAuthRuntimeConfig.CookieSameSite","key":"quarkus.http.auth.form.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session and location cookies.","withinAMap":false,"defaultValue":"strict","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"RUN_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_FORM_COOKIE_SAME_SITE","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.cors","additionalKeys":[],"configDoc":"Enable the CORS filter.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cors-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.port","additionalKeys":[],"configDoc":"The HTTP port","withinAMap":false,"defaultValue":"8080","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.test-port","additionalKeys":[],"configDoc":"The HTTP port used to run tests","withinAMap":false,"defaultValue":"8081","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.host","additionalKeys":[],"configDoc":"The HTTP host\n\nIn dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0\n\nDefaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.\n\nAs an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.test-host","additionalKeys":[],"configDoc":"Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running and listening on the host specified by this property.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_HOST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.host-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"host-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HOST_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.ssl-port","additionalKeys":[],"configDoc":"The HTTPS port","withinAMap":false,"defaultValue":"8443","javaDocSiteLink":"","docMapKey":"ssl-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.test-ssl-port","additionalKeys":[],"configDoc":"The HTTPS port used to run tests","withinAMap":false,"defaultValue":"8444","javaDocSiteLink":"","docMapKey":"test-ssl-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_SSL_PORT","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.test-ssl-enabled","additionalKeys":[],"configDoc":"Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running to configure the test to use SSL.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"test-ssl-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TEST_SSL_ENABLED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.HttpConfiguration.InsecureRequests","key":"quarkus.http.insecure-requests","additionalKeys":[],"configDoc":"If insecure (i.e. http rather than https) requests are allowed. If this is `enabled` then http works as normal. `redirect` will still open the http port, but all requests will be redirected to the HTTPS port. `disabled` will prevent the HTTP port from opening at all.\n\nDefault is `enabled` except when client auth is set to `required` (configured using `quarkus.http.ssl.client-auth=required`). In this case, the default is `disabled`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"insecure-requests","configPhase":"RUN_TIME","acceptedValues":["`enabled`","`redirect`","`disabled`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_INSECURE_REQUESTS","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.http2","additionalKeys":[],"configDoc":"If this is true (the default) then HTTP/2 will be enabled.\n\nNote that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"http2","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HTTP2","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.http2-push-enabled","additionalKeys":[],"configDoc":"Enables or Disable the HTTP/2 Push feature. This setting can be used to disable server push. The server will not send a `PUSH_PROMISE` frame if it receives this parameter set to @++{++code false++}++.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"http2-push-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HTTP2_PUSH_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.origins","additionalKeys":[],"configDoc":"Origins allowed for CORS Comma separated list of valid URLs, e.g.: http://www.quarkus.io,http://localhost:3000 In case an entry of the list is surrounded by forward slashes, it is interpreted as a regular expression.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"origins","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_ORIGINS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.methods","additionalKeys":[],"configDoc":"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","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.headers","additionalKeys":[],"configDoc":"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","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_HEADERS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.cors.exposed-headers","additionalKeys":[],"configDoc":"HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"exposed-headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_EXPOSED_HEADERS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.cors.access-control-max-age","additionalKeys":[],"configDoc":"The `Access-Control-Max-Age` response header value indicating how long the results of a pre-flight request can be cached.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"access-control-max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.cors.access-control-allow-credentials","additionalKeys":[],"configDoc":"The `Access-Control-Allow-Credentials` header is used to tell the browsers to expose the response to front-end JavaScript code when the request’s credentials mode Request.credentials is “include”. The value of this header will default to `true` if `quarkus.http.cors.origins` property is set and there is a match with the precise `Origin` header.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"access-control-allow-credentials","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.credentials-provider","additionalKeys":[],"configDoc":"The `CredentialsProvider`. If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured.\n\nPlease note that using MicroProfile `ConfigSource` which is directly supported by Quarkus Configuration should be preferred unless using `CredentialsProvider` provides for some additional security and dynamism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.credentials-provider-name","additionalKeys":[],"configDoc":"The credentials provider bean name.\n\nThis is a bean name (as in `@Named`) of a bean that implements `CredentialsProvider`. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.\n\nFor Vault, the credentials provider bean name is `vault-credentials-provider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.files","additionalKeys":[],"configDoc":"The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.key-files","additionalKeys":[],"configDoc":"The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled.\n\nThe order of the key files must match the order of the certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.key-store-file","additionalKeys":[],"configDoc":"An optional keystore that holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the key store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-alias-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it is different from `key-store-password` If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.key-store-alias-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password for the alias from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.trust-store-file","additionalKeys":[],"configDoc":"An optional trust store that holds the certificate information of the trusted certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.http.ssl.certificate.trust-store-files","additionalKeys":[],"configDoc":"An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the trust store file. If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the trust store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.certificate.trust-store-cert-alias","additionalKeys":[],"configDoc":"An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.ssl.certificate.reload-period","additionalKeys":[],"configDoc":"When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified.\n\nAlso, the update can also occur when the TLS certificate is configured using paths (and not in-memory).\n\nThe reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reload-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CERTIFICATE_RELOAD_PERIOD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.cipher-suites","additionalKeys":[],"configDoc":"The cipher suites to use. If none is given, a reasonable default is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.ssl.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled SSL/TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_PROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.ssl.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SSL_SNI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.http.ssl` will be used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.static-resources.index-page","additionalKeys":[],"configDoc":"Set the index page when serving static resources.","withinAMap":false,"defaultValue":"index.html","javaDocSiteLink":"","docMapKey":"index-page","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_INDEX_PAGE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.static-resources.include-hidden","additionalKeys":[],"configDoc":"Set whether hidden files should be served.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-hidden","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_INCLUDE_HIDDEN","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.static-resources.enable-range-support","additionalKeys":[],"configDoc":"Set whether range requests (resumable downloads; media streaming) should be enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-range-support","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_ENABLE_RANGE_SUPPORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.static-resources.caching-enabled","additionalKeys":[],"configDoc":"Set whether cache handling is enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"caching-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_CACHING_ENABLED","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.static-resources.cache-entry-timeout","additionalKeys":[],"configDoc":"Set the cache entry timeout. The default is `30` seconds.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cache-entry-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_CACHE_ENTRY_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.static-resources.max-age","additionalKeys":[],"configDoc":"Set value for max age in caching headers. The default is `24` hours.","withinAMap":false,"defaultValue":"24H","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_MAX_AGE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.static-resources.max-cache-size","additionalKeys":[],"configDoc":"Set the max cache size.","withinAMap":false,"defaultValue":"10000","javaDocSiteLink":"","docMapKey":"max-cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_MAX_CACHE_SIZE","enum":false}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.http.static-resources.content-encoding","additionalKeys":[],"configDoc":"Content encoding for text related files","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"content-encoding","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_STATIC_RESOURCES_CONTENT_ENCODING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.handle-100-continue-automatically","additionalKeys":[],"configDoc":"When set to `true`, the HTTP server automatically sends `100 CONTINUE` response when the request expects it (with the `Expect: 100-Continue` header).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"handle100-continue-automatically","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HANDLE_100_CONTINUE_AUTOMATICALLY","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.io-threads","additionalKeys":[],"configDoc":"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.\n\nIn 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.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"io-threads","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_IO_THREADS","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-header-size","additionalKeys":[],"configDoc":"The maximum length of all headers.","withinAMap":false,"defaultValue":"20K","javaDocSiteLink":"","docMapKey":"max-header-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-body-size","additionalKeys":[],"configDoc":"The maximum size of a request body.","withinAMap":false,"defaultValue":"10240K","javaDocSiteLink":"","docMapKey":"max-body-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size","withinAMap":false,"defaultValue":"8192","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.limits.max-initial-line-length","additionalKeys":[],"configDoc":"The maximum length of the initial line (e.g. `\"GET / HTTP/1.0\"`).","withinAMap":false,"defaultValue":"4096","javaDocSiteLink":"","docMapKey":"max-initial-line-length","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_INITIAL_LINE_LENGTH","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-form-attribute-size","additionalKeys":[],"configDoc":"The maximum length of a form attribute.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-form-attribute-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.limits.max-form-fields","additionalKeys":[],"configDoc":"Set the maximum number of fields of a form. Set to `-1` to allow unlimited number of attributes.","withinAMap":false,"defaultValue":"256","javaDocSiteLink":"","docMapKey":"max-form-fields","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FORM_FIELDS","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.limits.max-form-buffered-bytes","additionalKeys":[],"configDoc":"Set the maximum number of bytes a server can buffer when decoding a form. Set to `-1` to allow unlimited length","withinAMap":false,"defaultValue":"1K","javaDocSiteLink":"","docMapKey":"max-form-buffered-bytes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FORM_BUFFERED_BYTES","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.limits.max-parameters","additionalKeys":[],"configDoc":"The maximum number of HTTP request parameters permitted for incoming requests.\n\nIf a client sends more than this number of parameters in a request, the connection is closed.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"max-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_PARAMETERS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.limits.max-connections","additionalKeys":[],"configDoc":"The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_CONNECTIONS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.http.limits.header-table-size","additionalKeys":[],"configDoc":"Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting.\n\nAllows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is `4,096` octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-table-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_HEADER_TABLE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.http.limits.max-concurrent-streams","additionalKeys":[],"configDoc":"Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting.\n\nIndicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-concurrent-streams","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_CONCURRENT_STREAMS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.limits.max-frame-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is `2^14` (16,384) octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-frame-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_FRAME_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.http.limits.max-header-list-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is `8192`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-header-list-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_MAX_HEADER_LIST_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.limits.rst-flood-max-rst-frame-per-window","additionalKeys":[],"configDoc":"Set the max number of RST frame allowed per time window, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks]. The default value is `200`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"rst-flood-max-rst-frame-per-window","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.limits.rst-flood-window-duration","additionalKeys":[],"configDoc":"Set the duration of the time window when checking the max number of RST frames, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks].. The default value is `30 s`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"rst-flood-window-duration","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_LIMITS_RST_FLOOD_WINDOW_DURATION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.idle-timeout","additionalKeys":[],"configDoc":"Http connection idle timeout","withinAMap":false,"defaultValue":"30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.read-timeout","additionalKeys":[],"configDoc":"Http connection read timeout for blocking IO. This is the maximum amount of time a thread will wait for data, before an IOException will be thrown and the connection closed.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.handle-file-uploads","additionalKeys":[],"configDoc":"Whether the files sent using `multipart/form-data` will be stored locally.\n\nIf `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 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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"handle-file-uploads","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_HANDLE_FILE_UPLOADS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.body.uploads-directory","additionalKeys":[],"configDoc":"The directory where the files sent using `multipart/form-data` should be stored.\n\nEither an absolute path or a path relative to the current directory of the application process.","withinAMap":false,"defaultValue":"${java.io.tmpdir}/uploads","javaDocSiteLink":"","docMapKey":"uploads-directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_UPLOADS_DIRECTORY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.merge-form-attributes","additionalKeys":[],"configDoc":"Whether the form attributes should be added to the request parameters.\n\nIf `true`, the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"merge-form-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_MERGE_FORM_ATTRIBUTES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.delete-uploaded-files-on-end","additionalKeys":[],"configDoc":"Whether the uploaded files should be removed after serving the request.\n\nIf `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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"delete-uploaded-files-on-end","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_DELETE_UPLOADED_FILES_ON_END","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.body.preallocate-body-buffer","additionalKeys":[],"configDoc":"Whether the body buffer should pre-allocated based on the `Content-Length` header value.\n\nIf `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","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"preallocate-body-buffer","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_PREALLOCATE_BODY_BUFFER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.body.multipart.file-content-types","additionalKeys":[],"configDoc":"A comma-separated list of `ContentType` to indicate whether a given multipart field should be handled as a file part. You can use this setting to force HTTP-based extensions to parse a message part as a file based on its content type. For now, this setting only works when using RESTEasy Reactive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"file-content-types","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_BODY_MULTIPART_FILE_CONTENT_TYPES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.auth.session.encryption-key","additionalKeys":[],"configDoc":"The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here.\n\nIf no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_AUTH_SESSION_ENCRYPTION_KEY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.so-reuse-port","additionalKeys":[],"configDoc":"Enable socket reuse port (linux/macOs native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"so-reuse-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SO_REUSE_PORT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.tcp-quick-ack","additionalKeys":[],"configDoc":"Enable tcp quick ack (linux native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tcp-quick-ack","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TCP_QUICK_ACK","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.tcp-cork","additionalKeys":[],"configDoc":"Enable tcp cork (linux native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tcp-cork","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TCP_CORK","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.tcp-fast-open","additionalKeys":[],"configDoc":"Enable tcp fast open (linux native transport only)","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tcp-fast-open","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TCP_FAST_OPEN","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.http.accept-backlog","additionalKeys":[],"configDoc":"The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected","withinAMap":false,"defaultValue":"-1","javaDocSiteLink":"","docMapKey":"accept-backlog","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCEPT_BACKLOG","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.initial-window-size","additionalKeys":[],"configDoc":"Set the SETTINGS_INITIAL_WINDOW_SIZE HTTP/2 setting. Indicates the sender's initial window size (in octets) for stream-level flow control. The initial value is `2^16-1` (65,535) octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-window-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_INITIAL_WINDOW_SIZE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.domain-socket","additionalKeys":[],"configDoc":"Path to a unix domain socket","withinAMap":false,"defaultValue":"/var/run/io.quarkus.app.socket","javaDocSiteLink":"","docMapKey":"domain-socket","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_DOMAIN_SOCKET","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.domain-socket-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"domain-socket-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_DOMAIN_SOCKET_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.record-request-start-time","additionalKeys":[],"configDoc":"If this is true then the request start time will be recorded to enable logging of total request time.\n\nThis has a small performance penalty, so is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"record-request-start-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_RECORD_REQUEST_START_TIME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.enabled","additionalKeys":[],"configDoc":"If access logging is enabled. By default this will log via the standard logging facility","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.exclude-pattern","additionalKeys":[],"configDoc":"A regular expression that can be used to exclude some paths from logging.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"exclude-pattern","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_EXCLUDE_PATTERN","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.pattern","additionalKeys":[],"configDoc":"The access log pattern.\n\nIf this is the string `common`, `combined` or `long` then this will use one of the specified named formats:\n\n- common: `%h %l %u %t \"%r\" %s %b`\n- combined: `%h %l %u %t \"%r\" %s %b \"%{i,Referer}\" \"%{i,User-Agent}\"`\n- long: `%r\\n%{ALL_REQUEST_HEADERS}`\n\nOtherwise, consult the Quarkus documentation for the full list of variables that can be used.","withinAMap":false,"defaultValue":"common","javaDocSiteLink":"","docMapKey":"pattern","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_PATTERN","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.log-to-file","additionalKeys":[],"configDoc":"If logging should be done to a separate file.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"log-to-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_LOG_TO_FILE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.base-file-name","additionalKeys":[],"configDoc":"The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"base-file-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_BASE_FILE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.log-directory","additionalKeys":[],"configDoc":"The log directory to use when logging access to a file If this is not set then the current working directory is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"log-directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_LOG_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.log-suffix","additionalKeys":[],"configDoc":"The log file suffix","withinAMap":false,"defaultValue":".log","javaDocSiteLink":"","docMapKey":"log-suffix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_LOG_SUFFIX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.access-log.category","additionalKeys":[],"configDoc":"The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty).","withinAMap":false,"defaultValue":"io.quarkus.http.access-log","javaDocSiteLink":"","docMapKey":"category","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_CATEGORY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.rotate","additionalKeys":[],"configDoc":"If the log should be rotated daily","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"rotate","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_ROTATE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.access-log.consolidate-rerouted-requests","additionalKeys":[],"configDoc":"If rerouted requests should be consolidated into one log entry","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"consolidate-rerouted-requests","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_ACCESS_LOG_CONSOLIDATE_REROUTED_REQUESTS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.traffic-shaping.enabled","additionalKeys":[],"configDoc":"Enables the traffic shaping.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_ENABLED","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.traffic-shaping.inbound-global-bandwidth","additionalKeys":[],"configDoc":"Set bandwidth limit in bytes per second for inbound connections. If not set, no limits are applied.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"inbound-global-bandwidth","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_INBOUND_GLOBAL_BANDWIDTH","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.traffic-shaping.outbound-global-bandwidth","additionalKeys":[],"configDoc":"Set bandwidth limit in bytes per second for outbound connections. If not set, no limits are applied.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"outbound-global-bandwidth","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_OUTBOUND_GLOBAL_BANDWIDTH","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.traffic-shaping.max-delay","additionalKeys":[],"configDoc":"Set the maximum delay to wait in case of traffic excess. Default is 15s. Must be less than the HTTP timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_MAX_DELAY","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.http.traffic-shaping.check-interval","additionalKeys":[],"configDoc":"Set the delay between two computations of performances for channels. If set to 0, no stats are computed. Despite 0 is accepted (no accounting), it is recommended to set a positive value for the check interval, even if it is high since the precision of the traffic shaping depends on the period where the traffic is computed. In this case, a suggested value is something close to 5 or 10 minutes.\n\nIf not default, it defaults to 1s.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"check-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_CHECK_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.http.traffic-shaping.peak-outbound-global-bandwidth","additionalKeys":[],"configDoc":"Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write are suspended. The default value is 400 MB.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"peak-outbound-global-bandwidth","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_TRAFFIC_SHAPING_PEAK_OUTBOUND_GLOBAL_BANDWIDTH","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".case-sensitive","additionalKeys":[],"configDoc":"If the cookie pattern is case-sensitive","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"case-sensitive","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__CASE_SENSITIVE","enum":false}},{"configDocKey":{"type":"io.vertx.core.http.CookieSameSite","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".value","additionalKeys":[],"configDoc":"The value to set in the samesite attribute","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://vertx.io/docs/apidocs/io/vertx/core/http/CookieSameSite.html","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":["`none`","`strict`","`lax`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__VALUE","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".enable-client-checker","additionalKeys":[],"configDoc":"Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enable-client-checker","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ENABLE_CLIENT_CHECKER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.same-site-cookie.\"same-site-cookie\".add-secure-for-none","additionalKeys":[],"configDoc":"If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-secure-for-none","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ADD_SECURE_FOR_NONE","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.HttpConfiguration.PayloadHint","key":"quarkus.http.unhandled-error-content-type-default","additionalKeys":[],"configDoc":"Provides a hint (optional) for the default content type of responses generated for the errors not handled by the application.\n\nIf the client requested a supported content-type in request headers (e.g. \"Accept: application/json\", \"Accept: text/html\"), Quarkus will use that content type.\n\nOtherwise, it will default to the content type configured here.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"unhandled-error-content-type-default","configPhase":"RUN_TIME","acceptedValues":["`json`","`html`"],"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_UNHANDLED_ERROR_CONTENT_TYPE_DEFAULT","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.http.header.\"header\".path","additionalKeys":[],"configDoc":"The path this header should be applied","withinAMap":true,"defaultValue":"/*","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HEADER__HEADER__PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.header.\"header\".value","additionalKeys":[],"configDoc":"The value for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HEADER__HEADER__VALUE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.header.\"header\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_HEADER__HEADER__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.filter.\"filter\".matches","additionalKeys":[],"configDoc":"A regular expression for the paths matching this configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"matches","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__MATCHES","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.http.filter.\"filter\".header.\"header-name\"","additionalKeys":[],"configDoc":"Additional HTTP Headers always sent in the response","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__HEADER__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.filter.\"filter\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this path configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__METHODS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.http.filter.\"filter\".order","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_FILTER__FILTER__ORDER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.use-proxy-protocol","additionalKeys":[],"configDoc":"Set whether the server should use the HA `PROXY` protocol when serving requests from behind a proxy. (see the link:https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt[PROXY Protocol]). When set to `true`, the remote address returned will be the one from the actual connecting client. If it is set to `false` (default), the remote address returned will be the one from the proxy.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-proxy-protocol","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_USE_PROXY_PROTOCOL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.proxy-address-forwarding","additionalKeys":[],"configDoc":"If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as `X-Forwarded-For`. This should only be set if you are behind a proxy that sets these headers.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"proxy-address-forwarding","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_PROXY_ADDRESS_FORWARDING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.allow-forwarded","additionalKeys":[],"configDoc":"If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ALLOW_FORWARDED","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.http.proxy.allow-x-forwarded","additionalKeys":[],"configDoc":"If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"allow-x-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ALLOW_X_FORWARDED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.enable-forwarded-host","additionalKeys":[],"configDoc":"Enable override the received request's host through a forwarded host header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.proxy.forwarded-host-header","additionalKeys":[],"configDoc":"Configure the forwarded host header to be used if override enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Host","javaDocSiteLink":"","docMapKey":"forwarded-host-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_FORWARDED_HOST_HEADER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.http.proxy.enable-forwarded-prefix","additionalKeys":[],"configDoc":"Enable prefix the received request's path with a forwarded prefix header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-prefix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_PREFIX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.http.proxy.forwarded-prefix-header","additionalKeys":[],"configDoc":"Configure the forwarded prefix header to be used if prefixing enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Prefix","javaDocSiteLink":"","docMapKey":"forwarded-prefix-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_FORWARDED_PREFIX_HEADER","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.TrustedProxyCheck.TrustedProxyCheckPart","key":"quarkus.http.proxy.trusted-proxies","additionalKeys":[],"configDoc":"Configure the list of trusted proxy addresses. Received `Forwarded`, `X-Forwarded` or `X-Forwarded-++*++` headers from any other proxy address will be ignored. The trusted proxy address should be specified as the IP address (IPv4 or IPv6), hostname or Classless Inter-Domain Routing (CIDR) notation. Please note that Quarkus needs to perform DNS lookup for all hostnames during the request. For that reason, using hostnames is not recommended.\n\nExamples of a socket address in the form of `host` or `host:port`:\n\n - `127.0.0.1:8084`\n - `++[++0:0:0:0:0:0:0:1++]++`\n - `++[++0:0:0:0:0:0:0:1++]++:8084`\n - `++[++::++]++`\n - `localhost`\n - `localhost:8084`\n\nExamples of a CIDR notation:\n\n - `::/128`\n - `::/0`\n - `127.0.0.0/8`\n\nPlease bear in mind that IPv4 CIDR won't match request sent from the IPv6 address and the other way around.","withinAMap":false,"defaultValue":"All proxy addresses are trusted","javaDocSiteLink":"","docMapKey":"trusted-proxies","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.http","since":null,"environmentVariable":"QUARKUS_HTTP_PROXY_TRUSTED_PROXIES","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.management.ManagementInterfaceConfiguration b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.management.ManagementInterfaceConfiguration index 763eb27638c..2ee3a81c02c 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.management.ManagementInterfaceConfiguration +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.management.ManagementInterfaceConfiguration @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.management.auth.permission.\"permissions\".enabled","additionalKeys":[],"configDoc":"Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".policy","additionalKeys":[],"configDoc":"The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"policy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__POLICY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".methods","additionalKeys":[],"configDoc":"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.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".paths","additionalKeys":[],"configDoc":"The paths that this permission check applies to. If the path ends in /++*++ then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__PATHS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".auth-mechanism","additionalKeys":[],"configDoc":"Path specific authentication mechanism which must be used to authenticate a user. It needs to match `HttpCredentialTransport` authentication scheme such as 'basic', 'bearer', 'form', etc.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-mechanism","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.auth.permission.\"permissions\".shared","additionalKeys":[],"configDoc":"Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__SHARED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo","key":"quarkus.management.auth.permission.\"permissions\".applies-to","additionalKeys":[],"configDoc":"Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.","withinAMap":true,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"applies-to","configPhase":"RUN_TIME","acceptedValues":["tooltip:all[Apply on all matching paths.]","tooltip:jaxrs[Declares that a permission check must only be applied on the Jakarta REST request paths. Use this option to delay the permission check if an authentication mechanism is chosen with an annotation on the matching Jakarta REST endpoint. This option must be set if the following REST endpoint annotations are used: - `io.quarkus.oidc.Tenant` annotation which selects an OIDC authentication mechanism with a tenant identifier - `io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` which selects the Basic authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` which selects the Form-based authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` which selects the mTLS authentication mechanism - `io.quarkus.security.webauthn.WebAuthn` which selects the WebAuth authentication mechanism - `io.quarkus.oidc.BearerTokenAuthentication` which selects the OpenID Connect Bearer token authentication mechanism - `io.quarkus.oidc.AuthorizationCodeFlow` which selects the OpenID Connect Code authentication mechanism]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__APPLIES_TO","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.policy.\"role-policy\".roles-allowed","additionalKeys":[],"configDoc":"The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.","withinAMap":true,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"roles-allowed","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.management.auth.policy.\"role-policy\".roles.\"role-name\"","additionalKeys":[],"configDoc":"Add roles granted to the `SecurityIdentity` based on the roles that the `SecurityIdentity` already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.management.auth.policy.\"role-policy\".permissions.\"role-name\"","additionalKeys":[],"configDoc":"Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.policy.\"role-policy\".permission-class","additionalKeys":[],"configDoc":"Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String++[]++`). Permission class must be registered for reflection if you run your application in a native mode.","withinAMap":true,"defaultValue":"io.quarkus.security.StringPermission","javaDocSiteLink":"","docMapKey":"permission-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__PERMISSION_CLASS","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.management.auth.roles-mapping.\"role-name\"","additionalKeys":[],"configDoc":"Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.\n\nFor example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_ROLES_MAPPING__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.port","additionalKeys":[],"configDoc":"The HTTP port","withinAMap":false,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.test-port","additionalKeys":[],"configDoc":"The HTTP port","withinAMap":false,"defaultValue":"9001","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.host","additionalKeys":[],"configDoc":"The HTTP host Defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HOST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.host-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"host-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HOST_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.credentials-provider","additionalKeys":[],"configDoc":"The `CredentialsProvider`. If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured.\n\nPlease note that using MicroProfile `ConfigSource` which is directly supported by Quarkus Configuration should be preferred unless using `CredentialsProvider` provides for some additional security and dynamism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_CREDENTIALS_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.credentials-provider-name","additionalKeys":[],"configDoc":"The credentials provider bean name.\n\nThis is a bean name (as in `@Named`) of a bean that implements `CredentialsProvider`. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.\n\nFor Vault, the credentials provider bean name is `vault-credentials-provider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.files","additionalKeys":[],"configDoc":"The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.key-files","additionalKeys":[],"configDoc":"The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled.\n\nThe order of the key files must match the order of the certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.key-store-file","additionalKeys":[],"configDoc":"An optional keystore that holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_FILE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the key store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-alias-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it is different from `key-store-password` If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-alias-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password for the alias from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.trust-store-file","additionalKeys":[],"configDoc":"An optional trust store that holds the certificate information of the trusted certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.trust-store-files","additionalKeys":[],"configDoc":"An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the trust store file. If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the trust store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-cert-alias","additionalKeys":[],"configDoc":"An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.management.ssl.certificate.reload-period","additionalKeys":[],"configDoc":"When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified.\n\nAlso, the update can also occur when the TLS certificate is configured using paths (and not in-memory).\n\nThe reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reload-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_RELOAD_PERIOD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.cipher-suites","additionalKeys":[],"configDoc":"The cipher suites to use. If none is given, a reasonable default is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled SSL/TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_PROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.ssl.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_SNI","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.handle-100-continue-automatically","additionalKeys":[],"configDoc":"When set to `true`, the HTTP server automatically sends `100 CONTINUE` response when the request expects it (with the `Expect: 100-Continue` header).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"handle100-continue-automatically","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HANDLE_100_CONTINUE_AUTOMATICALLY","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-header-size","additionalKeys":[],"configDoc":"The maximum length of all headers.","withinAMap":false,"defaultValue":"20K","javaDocSiteLink":"","docMapKey":"max-header-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-body-size","additionalKeys":[],"configDoc":"The maximum size of a request body.","withinAMap":false,"defaultValue":"10240K","javaDocSiteLink":"","docMapKey":"max-body-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_BODY_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size","withinAMap":false,"defaultValue":"8192","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.limits.max-initial-line-length","additionalKeys":[],"configDoc":"The maximum length of the initial line (e.g. `\"GET / HTTP/1.0\"`).","withinAMap":false,"defaultValue":"4096","javaDocSiteLink":"","docMapKey":"max-initial-line-length","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_INITIAL_LINE_LENGTH","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-form-attribute-size","additionalKeys":[],"configDoc":"The maximum length of a form attribute.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-form-attribute-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_ATTRIBUTE_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.limits.max-form-fields","additionalKeys":[],"configDoc":"Set the maximum number of fields of a form. Set to `-1` to allow unlimited number of attributes.","withinAMap":false,"defaultValue":"256","javaDocSiteLink":"","docMapKey":"max-form-fields","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_FIELDS","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-form-buffered-bytes","additionalKeys":[],"configDoc":"Set the maximum number of bytes a server can buffer when decoding a form. Set to `-1` to allow unlimited length","withinAMap":false,"defaultValue":"1K","javaDocSiteLink":"","docMapKey":"max-form-buffered-bytes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_BUFFERED_BYTES","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.limits.max-parameters","additionalKeys":[],"configDoc":"The maximum number of HTTP request parameters permitted for incoming requests.\n\nIf a client sends more than this number of parameters in a request, the connection is closed.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"max-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_PARAMETERS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.limits.max-connections","additionalKeys":[],"configDoc":"The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_CONNECTIONS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.management.limits.header-table-size","additionalKeys":[],"configDoc":"Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting.\n\nAllows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is `4,096` octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-table-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_HEADER_TABLE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.management.limits.max-concurrent-streams","additionalKeys":[],"configDoc":"Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting.\n\nIndicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-concurrent-streams","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_CONCURRENT_STREAMS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.limits.max-frame-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is `2^14` (16,384) octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-frame-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FRAME_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.management.limits.max-header-list-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is `8192`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-header-list-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_LIST_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.limits.rst-flood-max-rst-frame-per-window","additionalKeys":[],"configDoc":"Set the max number of RST frame allowed per time window, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks]. The default value is `200`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"rst-flood-max-rst-frame-per-window","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.management.limits.rst-flood-window-duration","additionalKeys":[],"configDoc":"Set the duration of the time window when checking the max number of RST frames, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks].. The default value is `30 s`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"rst-flood-window-duration","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_WINDOW_DURATION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.management.idle-timeout","additionalKeys":[],"configDoc":"Http connection idle timeout","withinAMap":false,"defaultValue":"30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.handle-file-uploads","additionalKeys":[],"configDoc":"Whether the files sent using `multipart/form-data` will be stored locally.\n\nIf `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 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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"handle-file-uploads","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_HANDLE_FILE_UPLOADS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.body.uploads-directory","additionalKeys":[],"configDoc":"The directory where the files sent using `multipart/form-data` should be stored.\n\nEither an absolute path or a path relative to the current directory of the application process.","withinAMap":false,"defaultValue":"${java.io.tmpdir}/uploads","javaDocSiteLink":"","docMapKey":"uploads-directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_UPLOADS_DIRECTORY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.merge-form-attributes","additionalKeys":[],"configDoc":"Whether the form attributes should be added to the request parameters.\n\nIf `true`, the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"merge-form-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_MERGE_FORM_ATTRIBUTES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.delete-uploaded-files-on-end","additionalKeys":[],"configDoc":"Whether the uploaded files should be removed after serving the request.\n\nIf `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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"delete-uploaded-files-on-end","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_DELETE_UPLOADED_FILES_ON_END","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.preallocate-body-buffer","additionalKeys":[],"configDoc":"Whether the body buffer should pre-allocated based on the `Content-Length` header value.\n\nIf `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","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"preallocate-body-buffer","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_PREALLOCATE_BODY_BUFFER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.body.multipart.file-content-types","additionalKeys":[],"configDoc":"A comma-separated list of `ContentType` to indicate whether a given multipart field should be handled as a file part. You can use this setting to force HTTP-based extensions to parse a message part as a file based on its content type. For now, this setting only works when using RESTEasy Reactive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"file-content-types","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_MULTIPART_FILE_CONTENT_TYPES","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.accept-backlog","additionalKeys":[],"configDoc":"The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected","withinAMap":false,"defaultValue":"-1","javaDocSiteLink":"","docMapKey":"accept-backlog","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_ACCEPT_BACKLOG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.domain-socket","additionalKeys":[],"configDoc":"Path to a unix domain socket","withinAMap":false,"defaultValue":"/var/run/io.quarkus.management.socket","javaDocSiteLink":"","docMapKey":"domain-socket","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_DOMAIN_SOCKET","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.domain-socket-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"domain-socket-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_DOMAIN_SOCKET_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.header.\"header\".path","additionalKeys":[],"configDoc":"The path this header should be applied","withinAMap":true,"defaultValue":"/*","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HEADER__HEADER__PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.header.\"header\".value","additionalKeys":[],"configDoc":"The value for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HEADER__HEADER__VALUE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.header.\"header\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HEADER__HEADER__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.filter.\"filter\".matches","additionalKeys":[],"configDoc":"A regular expression for the paths matching this configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"matches","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__MATCHES","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.management.filter.\"filter\".header.\"header-name\"","additionalKeys":[],"configDoc":"Additional HTTP Headers always sent in the response","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__HEADER__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.filter.\"filter\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this path configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__METHODS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.filter.\"filter\".order","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__ORDER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.use-proxy-protocol","additionalKeys":[],"configDoc":"Set whether the server should use the HA `PROXY` protocol when serving requests from behind a proxy. (see the link:https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt[PROXY Protocol]). When set to `true`, the remote address returned will be the one from the actual connecting client. If it is set to `false` (default), the remote address returned will be the one from the proxy.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-proxy-protocol","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_USE_PROXY_PROTOCOL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.proxy-address-forwarding","additionalKeys":[],"configDoc":"If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as `X-Forwarded-For`. This should only be set if you are behind a proxy that sets these headers.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"proxy-address-forwarding","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_PROXY_ADDRESS_FORWARDING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.allow-forwarded","additionalKeys":[],"configDoc":"If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ALLOW_FORWARDED","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.management.proxy.allow-x-forwarded","additionalKeys":[],"configDoc":"If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"allow-x-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ALLOW_X_FORWARDED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.enable-forwarded-host","additionalKeys":[],"configDoc":"Enable override the received request's host through a forwarded host header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ENABLE_FORWARDED_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.proxy.forwarded-host-header","additionalKeys":[],"configDoc":"Configure the forwarded host header to be used if override enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Host","javaDocSiteLink":"","docMapKey":"forwarded-host-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_FORWARDED_HOST_HEADER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.enable-forwarded-prefix","additionalKeys":[],"configDoc":"Enable prefix the received request's path with a forwarded prefix header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-prefix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ENABLE_FORWARDED_PREFIX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.proxy.forwarded-prefix-header","additionalKeys":[],"configDoc":"Configure the forwarded prefix header to be used if prefixing enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Prefix","javaDocSiteLink":"","docMapKey":"forwarded-prefix-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_FORWARDED_PREFIX_HEADER","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.TrustedProxyCheck.TrustedProxyCheckPart","key":"quarkus.management.proxy.trusted-proxies","additionalKeys":[],"configDoc":"Configure the list of trusted proxy addresses. Received `Forwarded`, `X-Forwarded` or `X-Forwarded-++*++` headers from any other proxy address will be ignored. The trusted proxy address should be specified as the IP address (IPv4 or IPv6), hostname or Classless Inter-Domain Routing (CIDR) notation. Please note that Quarkus needs to perform DNS lookup for all hostnames during the request. For that reason, using hostnames is not recommended.\n\nExamples of a socket address in the form of `host` or `host:port`:\n\n - `127.0.0.1:8084`\n - `++[++0:0:0:0:0:0:0:1++]++`\n - `++[++0:0:0:0:0:0:0:1++]++:8084`\n - `++[++::++]++`\n - `localhost`\n - `localhost:8084`\n\nExamples of a CIDR notation:\n\n - `::/128`\n - `::/0`\n - `127.0.0.0/8`\n\nPlease bear in mind that IPv4 CIDR won't match request sent from the IPv6 address and the other way around.","withinAMap":false,"defaultValue":"All proxy addresses are trusted","javaDocSiteLink":"","docMapKey":"trusted-proxies","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_TRUSTED_PROXIES","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.management.auth.permission.\"permissions\".enabled","additionalKeys":[],"configDoc":"Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".policy","additionalKeys":[],"configDoc":"The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"policy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__POLICY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".methods","additionalKeys":[],"configDoc":"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.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".paths","additionalKeys":[],"configDoc":"The paths that this permission check applies to. If the path ends in /++*++ then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"paths","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__PATHS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.permission.\"permissions\".auth-mechanism","additionalKeys":[],"configDoc":"Path specific authentication mechanism which must be used to authenticate a user. It needs to match `HttpCredentialTransport` authentication scheme such as 'basic', 'bearer', 'form', etc.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-mechanism","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.auth.permission.\"permissions\".shared","additionalKeys":[],"configDoc":"Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__SHARED","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo","key":"quarkus.management.auth.permission.\"permissions\".applies-to","additionalKeys":[],"configDoc":"Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.","withinAMap":true,"defaultValue":"all","javaDocSiteLink":"","docMapKey":"applies-to","configPhase":"RUN_TIME","acceptedValues":["tooltip:all[Apply on all matching paths.]","tooltip:jaxrs[Declares that a permission check must only be applied on the Jakarta REST request paths. Use this option to delay the permission check if an authentication mechanism is chosen with an annotation on the matching Jakarta REST endpoint. This option must be set if the following REST endpoint annotations are used: - `io.quarkus.oidc.Tenant` annotation which selects an OIDC authentication mechanism with a tenant identifier - `io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` which selects the Basic authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` which selects the Form-based authentication mechanism - `io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` which selects the mTLS authentication mechanism - `io.quarkus.security.webauthn.WebAuthn` which selects the WebAuth authentication mechanism - `io.quarkus.oidc.BearerTokenAuthentication` which selects the OpenID Connect Bearer token authentication mechanism - `io.quarkus.oidc.AuthorizationCodeFlow` which selects the OpenID Connect Code authentication mechanism]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__APPLIES_TO","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.policy.\"role-policy\".roles-allowed","additionalKeys":[],"configDoc":"The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.","withinAMap":true,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"roles-allowed","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.management.auth.policy.\"role-policy\".roles.\"role-name\"","additionalKeys":[],"configDoc":"Add roles granted to the `SecurityIdentity` based on the roles that the `SecurityIdentity` already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.management.auth.policy.\"role-policy\".permissions.\"role-name\"","additionalKeys":[],"configDoc":"Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.auth.policy.\"role-policy\".permission-class","additionalKeys":[],"configDoc":"Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String++[]++`). Permission class must be registered for reflection if you run your application in a native mode.","withinAMap":true,"defaultValue":"io.quarkus.security.StringPermission","javaDocSiteLink":"","docMapKey":"permission-class","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__PERMISSION_CLASS","enum":false}},{"configDocKey":{"type":"java.util.List","key":"quarkus.management.auth.roles-mapping.\"role-name\"","additionalKeys":[],"configDoc":"Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.\n\nFor example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/List.html","docMapKey":"role-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_AUTH_ROLES_MAPPING__ROLE_NAME_","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.port","additionalKeys":[],"configDoc":"The HTTP port","withinAMap":false,"defaultValue":"9000","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PORT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.test-port","additionalKeys":[],"configDoc":"The HTTP port","withinAMap":false,"defaultValue":"9001","javaDocSiteLink":"","docMapKey":"test-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_TEST_PORT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.host","additionalKeys":[],"configDoc":"The HTTP host\n\nDefaults to 0.0.0.0\n\nDefaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HOST","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.host-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"host-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HOST_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.credentials-provider","additionalKeys":[],"configDoc":"The `CredentialsProvider`. If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured.\n\nPlease note that using MicroProfile `ConfigSource` which is directly supported by Quarkus Configuration should be preferred unless using `CredentialsProvider` provides for some additional security and dynamism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_CREDENTIALS_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.credentials-provider-name","additionalKeys":[],"configDoc":"The credentials provider bean name.\n\nThis is a bean name (as in `@Named`) of a bean that implements `CredentialsProvider`. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.\n\nFor Vault, the credentials provider bean name is `vault-credentials-provider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"credentials-provider-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.files","additionalKeys":[],"configDoc":"The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.key-files","additionalKeys":[],"configDoc":"The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled.\n\nThe order of the key files must match the order of the certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_FILES","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.key-store-file","additionalKeys":[],"configDoc":"An optional keystore that holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_FILE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"password","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the key store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-alias-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it is different from `key-store-password` If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.key-store-alias-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password for the alias from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-alias-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.trust-store-file","additionalKeys":[],"configDoc":"An optional trust store that holds the certificate information of the trusted certificates.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILE","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.management.ssl.certificate.trust-store-files","additionalKeys":[],"configDoc":"An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-files","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PROVIDER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the trust store file. If not given, it might be retrieved from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-password-key","additionalKeys":[],"configDoc":"A parameter to specify a `CredentialsProvider` property key, which can be used to get the password of the trust store file from `CredentialsProvider`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.certificate.trust-store-cert-alias","additionalKeys":[],"configDoc":"An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.management.ssl.certificate.reload-period","additionalKeys":[],"configDoc":"When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified.\n\nAlso, the update can also occur when the TLS certificate is configured using paths (and not in-memory).\n\nThe reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reload-period","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CERTIFICATE_RELOAD_PERIOD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.cipher-suites","additionalKeys":[],"configDoc":"The cipher suites to use. If none is given, a reasonable default is selected.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cipher-suites","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_CIPHER_SUITES","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.ssl.protocols","additionalKeys":[],"configDoc":"Sets the ordered list of enabled SSL/TLS protocols.\n\nIf not set, it defaults to `\"TLSv1.3, TLSv1.2\"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to \"TLSv1.3\"`.\n\nNote that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.","withinAMap":false,"defaultValue":"TLSv1.3,TLSv1.2","javaDocSiteLink":"","docMapKey":"protocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_PROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.ssl.sni","additionalKeys":[],"configDoc":"Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sni","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_SSL_SNI","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nIf no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.management.ssl` will be used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.handle-100-continue-automatically","additionalKeys":[],"configDoc":"When set to `true`, the HTTP server automatically sends `100 CONTINUE` response when the request expects it (with the `Expect: 100-Continue` header).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"handle100-continue-automatically","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HANDLE_100_CONTINUE_AUTOMATICALLY","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-header-size","additionalKeys":[],"configDoc":"The maximum length of all headers.","withinAMap":false,"defaultValue":"20K","javaDocSiteLink":"","docMapKey":"max-header-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-body-size","additionalKeys":[],"configDoc":"The maximum size of a request body.","withinAMap":false,"defaultValue":"10240K","javaDocSiteLink":"","docMapKey":"max-body-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_BODY_SIZE","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-chunk-size","additionalKeys":[],"configDoc":"The max HTTP chunk size","withinAMap":false,"defaultValue":"8192","javaDocSiteLink":"","docMapKey":"max-chunk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_CHUNK_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.limits.max-initial-line-length","additionalKeys":[],"configDoc":"The maximum length of the initial line (e.g. `\"GET / HTTP/1.0\"`).","withinAMap":false,"defaultValue":"4096","javaDocSiteLink":"","docMapKey":"max-initial-line-length","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_INITIAL_LINE_LENGTH","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-form-attribute-size","additionalKeys":[],"configDoc":"The maximum length of a form attribute.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-form-attribute-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_ATTRIBUTE_SIZE","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.limits.max-form-fields","additionalKeys":[],"configDoc":"Set the maximum number of fields of a form. Set to `-1` to allow unlimited number of attributes.","withinAMap":false,"defaultValue":"256","javaDocSiteLink":"","docMapKey":"max-form-fields","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_FIELDS","enum":false}},{"configDocKey":{"type":"io.quarkus.runtime.configuration.MemorySize","key":"quarkus.management.limits.max-form-buffered-bytes","additionalKeys":[],"configDoc":"Set the maximum number of bytes a server can buffer when decoding a form. Set to `-1` to allow unlimited length","withinAMap":false,"defaultValue":"1K","javaDocSiteLink":"","docMapKey":"max-form-buffered-bytes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_BUFFERED_BYTES","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.limits.max-parameters","additionalKeys":[],"configDoc":"The maximum number of HTTP request parameters permitted for incoming requests.\n\nIf a client sends more than this number of parameters in a request, the connection is closed.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"max-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_PARAMETERS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.limits.max-connections","additionalKeys":[],"configDoc":"The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_CONNECTIONS","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.management.limits.header-table-size","additionalKeys":[],"configDoc":"Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting.\n\nAllows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is `4,096` octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header-table-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_HEADER_TABLE_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.management.limits.max-concurrent-streams","additionalKeys":[],"configDoc":"Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting.\n\nIndicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-concurrent-streams","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_CONCURRENT_STREAMS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.limits.max-frame-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is `2^14` (16,384) octets.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-frame-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_FRAME_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Long","key":"quarkus.management.limits.max-header-list-size","additionalKeys":[],"configDoc":"Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is `8192`","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-header-list-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_LIST_SIZE","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.limits.rst-flood-max-rst-frame-per-window","additionalKeys":[],"configDoc":"Set the max number of RST frame allowed per time window, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks]. The default value is `200`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"rst-flood-max-rst-frame-per-window","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.management.limits.rst-flood-window-duration","additionalKeys":[],"configDoc":"Set the duration of the time window when checking the max number of RST frames, this is used to prevent link:https://github.com/netty/netty/security/advisories/GHSA-xpw8-rcwv-8f8p[HTTP/2 RST frame flood DDOS attacks].. The default value is `30 s`, setting zero or a negative value, disables flood protection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"rst-flood-window-duration","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_WINDOW_DURATION","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.management.idle-timeout","additionalKeys":[],"configDoc":"Http connection idle timeout","withinAMap":false,"defaultValue":"30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_IDLE_TIMEOUT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.handle-file-uploads","additionalKeys":[],"configDoc":"Whether the files sent using `multipart/form-data` will be stored locally.\n\nIf `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 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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"handle-file-uploads","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_HANDLE_FILE_UPLOADS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.body.uploads-directory","additionalKeys":[],"configDoc":"The directory where the files sent using `multipart/form-data` should be stored.\n\nEither an absolute path or a path relative to the current directory of the application process.","withinAMap":false,"defaultValue":"${java.io.tmpdir}/uploads","javaDocSiteLink":"","docMapKey":"uploads-directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_UPLOADS_DIRECTORY","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.merge-form-attributes","additionalKeys":[],"configDoc":"Whether the form attributes should be added to the request parameters.\n\nIf `true`, the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"merge-form-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_MERGE_FORM_ATTRIBUTES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.delete-uploaded-files-on-end","additionalKeys":[],"configDoc":"Whether the uploaded files should be removed after serving the request.\n\nIf `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.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"delete-uploaded-files-on-end","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_DELETE_UPLOADED_FILES_ON_END","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.body.preallocate-body-buffer","additionalKeys":[],"configDoc":"Whether the body buffer should pre-allocated based on the `Content-Length` header value.\n\nIf `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","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"preallocate-body-buffer","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_PREALLOCATE_BODY_BUFFER","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.body.multipart.file-content-types","additionalKeys":[],"configDoc":"A comma-separated list of `ContentType` to indicate whether a given multipart field should be handled as a file part. You can use this setting to force HTTP-based extensions to parse a message part as a file based on its content type. For now, this setting only works when using RESTEasy Reactive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"file-content-types","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_BODY_MULTIPART_FILE_CONTENT_TYPES","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.management.accept-backlog","additionalKeys":[],"configDoc":"The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected","withinAMap":false,"defaultValue":"-1","javaDocSiteLink":"","docMapKey":"accept-backlog","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_ACCEPT_BACKLOG","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.domain-socket","additionalKeys":[],"configDoc":"Path to a unix domain socket","withinAMap":false,"defaultValue":"/var/run/io.quarkus.management.socket","javaDocSiteLink":"","docMapKey":"domain-socket","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_DOMAIN_SOCKET","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.domain-socket-enabled","additionalKeys":[],"configDoc":"Enable listening to host:port","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"domain-socket-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_DOMAIN_SOCKET_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.header.\"header\".path","additionalKeys":[],"configDoc":"The path this header should be applied","withinAMap":true,"defaultValue":"/*","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HEADER__HEADER__PATH","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.header.\"header\".value","additionalKeys":[],"configDoc":"The value for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HEADER__HEADER__VALUE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.header.\"header\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this header configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_HEADER__HEADER__METHODS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.filter.\"filter\".matches","additionalKeys":[],"configDoc":"A regular expression for the paths matching this configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"matches","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__MATCHES","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.management.filter.\"filter\".header.\"header-name\"","additionalKeys":[],"configDoc":"Additional HTTP Headers always sent in the response","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__HEADER__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.filter.\"filter\".methods","additionalKeys":[],"configDoc":"The HTTP methods for this path configuration","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"methods","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__METHODS","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.management.filter.\"filter\".order","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"order","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_FILTER__FILTER__ORDER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.use-proxy-protocol","additionalKeys":[],"configDoc":"Set whether the server should use the HA `PROXY` protocol when serving requests from behind a proxy. (see the link:https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt[PROXY Protocol]). When set to `true`, the remote address returned will be the one from the actual connecting client. If it is set to `false` (default), the remote address returned will be the one from the proxy.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-proxy-protocol","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_USE_PROXY_PROTOCOL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.proxy-address-forwarding","additionalKeys":[],"configDoc":"If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as `X-Forwarded-For`. This should only be set if you are behind a proxy that sets these headers.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"proxy-address-forwarding","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_PROXY_ADDRESS_FORWARDING","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.allow-forwarded","additionalKeys":[],"configDoc":"If this is true and proxy address forwarding is enabled then the standard `Forwarded` header will be used. In case the not standard `X-Forwarded-For` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-x-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"allow-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ALLOW_FORWARDED","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.management.proxy.allow-x-forwarded","additionalKeys":[],"configDoc":"If either this or `allow-forwarded` are true and proxy address forwarding is enabled then the not standard `Forwarded` header will be used. In case the standard `Forwarded` header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with `quarkus.http.proxy.allow-forwarded` has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected `X-Forwarded` or `X-Forwarded-++*++` headers from the client.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"allow-x-forwarded","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ALLOW_X_FORWARDED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.enable-forwarded-host","additionalKeys":[],"configDoc":"Enable override the received request's host through a forwarded host header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-host","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ENABLE_FORWARDED_HOST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.proxy.forwarded-host-header","additionalKeys":[],"configDoc":"Configure the forwarded host header to be used if override enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Host","javaDocSiteLink":"","docMapKey":"forwarded-host-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_FORWARDED_HOST_HEADER","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.management.proxy.enable-forwarded-prefix","additionalKeys":[],"configDoc":"Enable prefix the received request's path with a forwarded prefix header.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-forwarded-prefix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_ENABLE_FORWARDED_PREFIX","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.management.proxy.forwarded-prefix-header","additionalKeys":[],"configDoc":"Configure the forwarded prefix header to be used if prefixing enabled.","withinAMap":false,"defaultValue":"X-Forwarded-Prefix","javaDocSiteLink":"","docMapKey":"forwarded-prefix-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_FORWARDED_PREFIX_HEADER","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.TrustedProxyCheck.TrustedProxyCheckPart","key":"quarkus.management.proxy.trusted-proxies","additionalKeys":[],"configDoc":"Configure the list of trusted proxy addresses. Received `Forwarded`, `X-Forwarded` or `X-Forwarded-++*++` headers from any other proxy address will be ignored. The trusted proxy address should be specified as the IP address (IPv4 or IPv6), hostname or Classless Inter-Domain Routing (CIDR) notation. Please note that Quarkus needs to perform DNS lookup for all hostnames during the request. For that reason, using hostnames is not recommended.\n\nExamples of a socket address in the form of `host` or `host:port`:\n\n - `127.0.0.1:8084`\n - `++[++0:0:0:0:0:0:0:1++]++`\n - `++[++0:0:0:0:0:0:0:1++]++:8084`\n - `++[++::++]++`\n - `localhost`\n - `localhost:8084`\n\nExamples of a CIDR notation:\n\n - `::/128`\n - `::/0`\n - `127.0.0.0/8`\n\nPlease bear in mind that IPv4 CIDR won't match request sent from the IPv6 address and the other way around.","withinAMap":false,"defaultValue":"All proxy addresses are trusted","javaDocSiteLink":"","docMapKey":"trusted-proxies","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.management","since":null,"environmentVariable":"QUARKUS_MANAGEMENT_PROXY_TRUSTED_PROXIES","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsClientRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsClientRuntimeConfig index 706181fad5a..9e97a2e8134 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsClientRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsClientRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.client.offer-per-message-compression","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"offer-per-message-compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.client.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the client sends a ping message to a connected server automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.client.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY","enum":true}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.client.offer-per-message-compression","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"offer-per-message-compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.client.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the client sends a ping message to a connected server automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.client.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.websockets-next.client.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nThe default TLS configuration is *not* used by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.client.traffic-logging.enabled","additionalKeys":[],"configDoc":"If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.websockets-next.client.traffic-logging.text-payload-limit","additionalKeys":[],"configDoc":"The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"text-payload-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig index 37d069320e0..e5fac04325b 100644 --- a/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig +++ b/_generated-doc/latest/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.server.per-message-compression-supported","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"per-message-compression-supported","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.server.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the server sends a ping message to a connected client automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.server.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY","enum":true}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.server.per-message-compression-supported","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"per-message-compression-supported","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.server.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the server sends a ping message to a connected client automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.server.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.security.auth-failure-redirect-url","additionalKeys":[],"configDoc":"Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-failure-redirect-url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.server.traffic-logging.enabled","additionalKeys":[],"configDoc":"If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.websockets-next.server.traffic-logging.text-payload-limit","additionalKeys":[],"configDoc":"The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"text-payload-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-container-image-podman.adoc/io.quarkus.container.image.podman.deployment.PodmanConfig b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-container-image-podman.adoc/io.quarkus.container.image.podman.deployment.PodmanConfig new file mode 100644 index 00000000000..0a9812cc26f --- /dev/null +++ b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-container-image-podman.adoc/io.quarkus.container.image.podman.deployment.PodmanConfig @@ -0,0 +1 @@ +io.quarkus.container.image.podman.deployment.PodmanConfig \ No newline at end of file diff --git a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-core.adoc/io.quarkus.runtime.TlsConfig b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-core.adoc/io.quarkus.runtime.TlsConfig deleted file mode 100644 index 16e4eb2bac0..00000000000 --- a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-core.adoc/io.quarkus.runtime.TlsConfig +++ /dev/null @@ -1 +0,0 @@ -io.quarkus.runtime.TlsConfig \ No newline at end of file diff --git a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-jfr.adoc/io.quarkus.jfr.runtime.config.JfrRuntimeConfig b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-jfr.adoc/io.quarkus.jfr.runtime.config.JfrRuntimeConfig new file mode 100644 index 00000000000..50061c4fa2a --- /dev/null +++ b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-jfr.adoc/io.quarkus.jfr.runtime.config.JfrRuntimeConfig @@ -0,0 +1 @@ +io.quarkus.jfr.runtime.config.JfrRuntimeConfig \ No newline at end of file diff --git a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-load-shedding.adoc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-load-shedding.adoc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig new file mode 100644 index 00000000000..ac94e750625 --- /dev/null +++ b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-load-shedding.adoc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig @@ -0,0 +1 @@ +io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig \ No newline at end of file diff --git a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-narayana-lra.adoc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-narayana-lra.adoc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration new file mode 100644 index 00000000000..c89134115f3 --- /dev/null +++ b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-narayana-lra.adoc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration @@ -0,0 +1 @@ +io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration \ No newline at end of file diff --git a/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-tls.adoc/io.quarkus.tls.runtime.config.TlsConfig b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-tls.adoc/io.quarkus.tls.runtime.config.TlsConfig new file mode 100644 index 00000000000..ac955b3be69 --- /dev/null +++ b/_generated-doc/latest/config/extensions-configuration-roots-list/quarkus-tls.adoc/io.quarkus.tls.runtime.config.TlsConfig @@ -0,0 +1 @@ +io.quarkus.tls.runtime.config.TlsConfig \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-all-build-items.adoc b/_generated-doc/latest/config/quarkus-all-build-items.adoc index 725da816d24..22745907537 100644 --- a/_generated-doc/latest/config/quarkus-all-build-items.adoc +++ b/_generated-doc/latest/config/quarkus-all-build-items.adoc @@ -149,6 +149,10 @@ a| `RuntimeValue bannerSupplier` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/console/ConsoleInstalledBuildItem.java[`io.quarkus.deployment.console.ConsoleInstalledBuildItem`, window="_blank"] :: +++Build item that signifies that the interactive console is ready. This will not always be present, as the console may not be installed+++ a| None +a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/ContainerRuntimeStatusBuildItem.java[`io.quarkus.deployment.builditem.ContainerRuntimeStatusBuildItem`, window="_blank"] :: +++No Javadoc found+++ +a| `IsContainerRuntimeWorking isContainerRuntimeWorking` :: +++No Javadoc found+++ +`Boolean cachedStatus` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/ContextHandlerBuildItem.java[`io.quarkus.deployment.builditem.ContextHandlerBuildItem`, window="_blank"] :: +++No Javadoc found+++ a| `ContextHandler contextHandler` :: +++No Javadoc found+++ @@ -208,9 +212,7 @@ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/ a| `Predicate predicate` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/DockerStatusBuildItem.java[`io.quarkus.deployment.builditem.DockerStatusBuildItem`, window="_blank"] :: +++No Javadoc found+++ -a| `IsDockerWorking isDockerWorking` :: +++No Javadoc found+++ -`Boolean cachedStatus` :: +++No Javadoc found+++ - +a| None a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/ide/EffectiveIdeBuildItem.java[`io.quarkus.deployment.ide.EffectiveIdeBuildItem`, window="_blank"] :: +++Contains the IDE to be opened when a request to open a class is made+++ a| `Ide ide` :: +++No Javadoc found+++ @@ -260,7 +262,7 @@ a| `String name` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/GeneratedResourceBuildItem.java[`io.quarkus.deployment.builditem.GeneratedResourceBuildItem`, window="_blank"] :: +++No Javadoc found+++ a| `String name` :: +++No Javadoc found+++ `byte[] data` :: +++No Javadoc found+++ -`boolean excludeFromDevCL` :: +++No Javadoc found+++ +`boolean excludeFromDevCL` :: +++This option is only meant to be set by extensions that also generated the resource on the file system and must rely on Quarkus not getting in the way of loading that resource. It is currently used by Kogito to get serving of static resources in Dev Mode by Vert.x
+++ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/HotDeploymentWatchedFileBuildItem.java[`io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem`, window="_blank"] :: +++Identifies a file from a that, if modified, may result in a hot redeployment when in the dev mode.

A file may be identified with an location or a matching predicate. See and . The location may be:

  • a relative OS-agnostic file path where is used as a separator; e.g.
  • an absolute OS-specific file path; e.g.
  • a glob pattern as defined in ; e.g.

If multiple build items match the same file then the final value of is computed as a logical OR of all the values.+++ a| `String location` :: +++No Javadoc found+++ @@ -385,6 +387,9 @@ a| `Consumer factoryConsumer` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/NamedLogHandlersBuildItem.java[`io.quarkus.deployment.builditem.NamedLogHandlersBuildItem`, window="_blank"] :: +++A build item for adding additional named logging handlers.+++ a| `RuntimeValue namedHandlersMap` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageAgentConfigDirectoryBuildItem.java[`io.quarkus.deployment.builditem.nativeimage.NativeImageAgentConfigDirectoryBuildItem`, window="_blank"] :: +++Native configuration generated by native image agent can be integrated directly into subsequence native build steps, if the user enables . This build item is used to transfer the native configuration folder path onto the . If the build item is passed, the directory is added to the native image build execution.+++ +a| `String directory` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageAllowIncompleteClasspathAggregateBuildItem.java[`io.quarkus.deployment.builditem.nativeimage.NativeImageAllowIncompleteClasspathAggregateBuildItem`, window="_blank"] :: +++Do not use directly: use instead.+++ a| `boolean allow` :: +++No Javadoc found+++ @@ -450,6 +455,8 @@ a| `Path outputDirectory` :: +++No Javadoc found+++ `Properties buildSystemProperties` :: +++No Javadoc found+++ `Optional includedOptionalDependencies` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/PodmanStatusBuildItem.java[`io.quarkus.deployment.builditem.PodmanStatusBuildItem`, window="_blank"] :: +++No Javadoc found+++ +a| None a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/PreloadClassBuildItem.java[`io.quarkus.deployment.builditem.PreloadClassBuildItem`, window="_blank"] :: +++Class to be preloaded in static initialization phase of Quarkus.+++ a| `String className` :: +++No Javadoc found+++ @@ -684,7 +691,7 @@ a| `List beanClasses` :: +++No Javadoc found+++ `DotName defaultScope` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/AnnotationsTransformerBuildItem.java[`io.quarkus.arc.deployment.AnnotationsTransformerBuildItem`, window="_blank"] :: +++Make it possible to add, remove or alter annotations on various components. The provided transformer uses to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won't be able to see any changes made via !+++ -a| `AnnotationsTransformer transformer` :: +++No Javadoc found+++ +a| `AnnotationTransformation transformer` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/devui/ArcBeanInfoBuildItem.java[`io.quarkus.arc.deployment.devui.ArcBeanInfoBuildItem`, window="_blank"] :: +++No Javadoc found+++ a| `DevBeanInfos beanInfos` :: +++No Javadoc found+++ @@ -790,6 +797,9 @@ a| `InterceptorResolver resolver` :: +++No Javadoc found+++ `Set interceptorBindings` :: +++No Javadoc found+++ `BeanDeployment beanDeployment` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/InvokerFactoryBuildItem.java[`io.quarkus.arc.deployment.InvokerFactoryBuildItem`, window="_blank"] :: +++Provides access to . May only be used in the bean registration phase, observer registration phase, and validation phase (basically, until ArC generates the classes). Afterwards, any attempt to call throws an exception.+++ +a| `BeanDeployment beanDeployment` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/KnownCompatibleBeanArchiveBuildItem.java[`io.quarkus.arc.deployment.KnownCompatibleBeanArchiveBuildItem`, window="_blank"] :: +++Marks a bean archive with given coordinates (groupId, artifactId and optionally classifier) as known compatible with Quarkus. This is only useful for bean archives whose defines a bean discovery mode of ; bean archives with discovery mode of or are always compatible. If a bean archive is known to be compatible with Quarkus, no warning about discovery is logged during application build.+++ a| `String groupId` :: +++No Javadoc found+++ `String artifactId` :: +++No Javadoc found+++ @@ -1495,6 +1505,9 @@ a| `List codecProviderClassNames` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/extensions/mongodb-client/deployment/src/main/java/io/quarkus/mongodb/deployment/CommandListenerBuildItem.java[`io.quarkus.mongodb.deployment.CommandListenerBuildItem`, window="_blank"] :: +++Register additional s for the MongoDB clients.+++ a| `List commandListenerClassNames` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/mongodb-client/deployment/src/main/java/io/quarkus/mongodb/deployment/ContextProviderBuildItem.java[`io.quarkus.mongodb.deployment.ContextProviderBuildItem`, window="_blank"] :: +++Register additional s for the MongoDB clients.+++ +a| `List classNames` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/extensions/mongodb-client/deployment/src/main/java/io/quarkus/mongodb/deployment/MongoClientBuildItem.java[`io.quarkus.mongodb.deployment.MongoClientBuildItem`, window="_blank"] :: +++Provide the MongoDB clients as RuntimeValue's.+++ a| `RuntimeValue client` :: +++No Javadoc found+++ `RuntimeValue reactive` :: +++No Javadoc found+++ @@ -1872,7 +1885,7 @@ a| `MethodInfo methodInfo` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest/spi-deployment/src/main/java/io/quarkus/resteasy/reactive/server/spi/AllowNotRestParametersBuildItem.java[`io.quarkus.resteasy.reactive.server.spi.AllowNotRestParametersBuildItem`, window="_blank"] :: +++A build item which extensions can generate when they want to allow RESTEasy Reactive methods with parameters that are annotated with not REST annotations. This allows RESTEasy Reactive to let mixed parameters coexist within resource methods signature+++ a| None a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest/spi-deployment/src/main/java/io/quarkus/resteasy/reactive/server/spi/AnnotationsTransformerBuildItem.java[`io.quarkus.resteasy.reactive.server.spi.AnnotationsTransformerBuildItem`, window="_blank"] :: +++Make it possible to add, remove or alter annotations on various components. The provided transformer uses to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won't be able to see any changes made via !+++ -a| `AnnotationsTransformer transformer` :: +++No Javadoc found+++ +a| `AnnotationTransformation transformer` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest/spi-deployment/src/main/java/io/quarkus/resteasy/reactive/server/spi/ContextTypeBuildItem.java[`io.quarkus.resteasy.reactive.server.spi.ContextTypeBuildItem`, window="_blank"] :: +++Register types that should be available for injection into JAX-RS methods via+++ a| `DotName type` :: +++No Javadoc found+++ @@ -2007,7 +2020,7 @@ a| `String targetClass` :: +++No Javadoc found+++ |=== |Class Name |Attributes a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest-client/spi-deployment/src/main/java/io/quarkus/rest/client/reactive/spi/RestClientAnnotationsTransformerBuildItem.java[`io.quarkus.rest.client.reactive.spi.RestClientAnnotationsTransformerBuildItem`, window="_blank"] :: +++Make it possible to add, remove or alter annotations on various components. The provided transformer uses to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won't be able to see any changes made via !+++ -a| `AnnotationsTransformer transformer` :: +++No Javadoc found+++ +a| `AnnotationTransformation transformer` :: +++No Javadoc found+++ |=== == REST data with Panache @@ -2151,6 +2164,15 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/ma a| `Collection additionalSecuredMethods` :: +++No Javadoc found+++ `Optional rolesAllowed` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/AdditionalSecurityConstrainerEventPropsBuildItem.java[`io.quarkus.security.spi.AdditionalSecurityConstrainerEventPropsBuildItem`, window="_blank"] :: +++This item allows to enhance properties of security events produced by SecurityConstrainer. The SecurityConstrainer is usually invoked when CDI request context is already fully setup, and the additional properties can be added based on the active context.+++ +a| `Supplier additionalEventPropsSupplier` :: +++No Javadoc found+++ + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/ClassSecurityCheckAnnotationBuildItem.java[`io.quarkus.security.spi.ClassSecurityCheckAnnotationBuildItem`, window="_blank"] :: +++Allows to create additional security checks for standard security annotations defined on a class level. We strongly recommended to secure CDI beans with if additional security is required. If you decide to use this build item, you must use class security check storage and apply checks manually. Thus, it's only suitable for very special cases.+++ +a| `DotName classAnnotation` :: +++No Javadoc found+++ + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/ClassSecurityCheckStorageBuildItem.java[`io.quarkus.security.spi.ClassSecurityCheckStorageBuildItem`, window="_blank"] :: +++Security check storage containing additional security checks created for secured classes matching one of the filters during the static init.+++ +a| `Map classNameToSecurityCheck` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/DefaultSecurityCheckBuildItem.java[`io.quarkus.security.spi.DefaultSecurityCheckBuildItem`, window="_blank"] :: +++Registers default SecurityCheck with the SecurityCheckStorage. Please make sure this build item is produced exactly once or validation will fail and exception will be thrown.+++ a| `List rolesAllowed` :: +++No Javadoc found+++ @@ -2263,6 +2285,18 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/swagger-ui/deployme a| `String swaggerUiFinalDestination` :: +++No Javadoc found+++ `String swaggerUiPath` :: +++No Javadoc found+++ +|=== +== TLS Registry +[%header,cols=2*] +|=== +|Class Name |Attributes +a| https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/deployment/src/main/java/io/quarkus/tls/TlsCertificateBuildItem.java[`io.quarkus.tls.TlsCertificateBuildItem`, window="_blank"] :: +++A build item to register a TLS certificate.+++ +a| `String name` :: +++No Javadoc found+++ +`Supplier supplier` :: +++No Javadoc found+++ + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/deployment/src/main/java/io/quarkus/tls/TlsRegistryBuildItem.java[`io.quarkus.tls.TlsRegistryBuildItem`, window="_blank"] :: +++A build item that indicates that the TLS registry has been initialized.+++ +a| `Supplier registry` :: +++No Javadoc found+++ + |=== == Undertow - SPI [%header,cols=2*] @@ -2532,13 +2566,14 @@ a| `List content` :: +++No Javadoc found+++ [%header,cols=2*] |=== |Class Name |Attributes -a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment-spi/src/main/java/io/quarkus/vertx/http/deployment/spi/AdditionalStaticResourceBuildItem.java[`io.quarkus.vertx.http.deployment.spi.AdditionalStaticResourceBuildItem`, window="_blank"] :: +++Meant to be used by extensions that generate resource into . These resources cannot be picked up automatically by the standard Static resources handling because when the check is made, these resources don't exist yet on the file system. The value of should be prefixed with and is assumed to be a path under .+++ -a| `String path` :: +++No Javadoc found+++ -`boolean isDirectory` :: +++No Javadoc found+++ - a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment-spi/src/main/java/io/quarkus/vertx/http/deployment/spi/FrameworkEndpointsBuildItem.java[`io.quarkus.vertx.http.deployment.spi.FrameworkEndpointsBuildItem`, window="_blank"] :: +++No Javadoc found+++ a| `List endpoints` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment-spi/src/main/java/io/quarkus/vertx/http/deployment/spi/GeneratedStaticResourceBuildItem.java[`io.quarkus.vertx.http.deployment.spi.GeneratedStaticResourceBuildItem`, window="_blank"] :: +++This build item aims to be used by extensions to generate static resources.
Those resources will be served on the given . It is NOT necessary to create the file on disk.
Behind the scenes the build step will take care of add those resources to the final build, through , and build items.
The value of should be prefixed with .+++ +a| `String endpoint` :: +++No Javadoc found+++ +`Path file` :: +++No Javadoc found+++ +`byte[] content` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment-spi/src/main/java/io/quarkus/vertx/http/deployment/spi/RouteBuildItem.java[`io.quarkus.vertx.http.deployment.spi.RouteBuildItem`, window="_blank"] :: +++A build item that represents a route that should be added to the router.

Producing this build item does not mean the HTTP server is available. It will be consumed if the Quarkus Vert.x HTTP extension is present.+++ a| `RouteType typeOfRoute` :: +++No Javadoc found+++ `OptionalInt order` :: +++No Javadoc found+++ @@ -2556,6 +2591,14 @@ a| `Set entries` :: +++No Javadoc found+++ a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment-spi/src/main/java/io/quarkus/vertx/http/deployment/spi/UseManagementInterfaceBuildItem.java[`io.quarkus.vertx.http.deployment.spi.UseManagementInterfaceBuildItem`, window="_blank"] :: +++Marker build item indicating that the application uses a separate interface:port for the management endpoints such as metrics, health and prometheus.+++ a| None +|=== +== Vert.x - SPI +[%header,cols=2*] +|=== +|Class Name |Attributes +a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx/deployment-spi/src/main/java/io/quarkus/vertx/deployment/spi/EventConsumerInvokerCustomizerBuildItem.java[`io.quarkus.vertx.deployment.spi.EventConsumerInvokerCustomizerBuildItem`, window="_blank"] :: +++This build item should be considered private and should not be used outside of core Quarkus. It can be changed without notice.+++ +a| `BiConsumer invokerCustomizer` :: +++No Javadoc found+++ + |=== == Web Dependency Locator [%header,cols=2*] diff --git a/_generated-doc/latest/config/quarkus-all-config.adoc b/_generated-doc/latest/config/quarkus-all-config.adoc index 27eea7bf064..bf16f5c6265 100644 --- a/_generated-doc/latest/config/quarkus-all-config.adoc +++ b/_generated-doc/latest/config/quarkus-all-config.adoc @@ -2900,7 +2900,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image_quarkus-contain [.description] -- -The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present. +The name of the container image extension to use (e.g. docker, podman, jib, s2i). The option will be used in case multiple extensions are present. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CONTAINER_IMAGE_BUILDER+++[] @@ -3099,8 +3099,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++[] endif::add-copy-button-to-env-var[] @@ -3108,7 +3106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++` endif::add-copy-button-to-env-var[] --|string -|`src/main/docker/Dockerfile.jvm` +| a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-dockerfile-native-path]]`link:#quarkus-container-image-docker_quarkus-docker-dockerfile-native-path[quarkus.docker.dockerfile-native-path]` @@ -3116,8 +3114,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++[] endif::add-copy-button-to-env-var[] @@ -3125,7 +3121,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++` endif::add-copy-button-to-env-var[] --|string -|`src/main/docker/Dockerfile.native` +| a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-cache-from]]`link:#quarkus-container-image-docker_quarkus-docker-cache-from[quarkus.docker.cache-from]` @@ -3133,8 +3129,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Images to consider as cache sources. Values are passed to `docker build` via the `cache-from` option - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_CACHE_FROM+++[] endif::add-copy-button-to-env-var[] @@ -3150,8 +3144,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -The networking mode for the RUN instructions during build - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_NETWORK+++[] endif::add-copy-button-to-env-var[] @@ -3167,8 +3159,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Name of binary used to execute the docker commands. This setting can override the global container runtime detection. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_EXECUTABLE_NAME+++[] endif::add-copy-button-to-env-var[] @@ -3184,8 +3174,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Additional arbitrary arguments passed to the executable when building the container image. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[] endif::add-copy-button-to-env-var[] @@ -3196,18 +3184,16 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-build-args-arg-name]]`link:#quarkus-container-image-docker_quarkus-docker-build-args-arg-name[quarkus.docker.build-args."arg-name"]` +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-build-args-build-args]]`link:#quarkus-container-image-docker_quarkus-docker-build-args-build-args[quarkus.docker.build-args."build-args"]` [.description] -- -Build args passed to docker via `--build-arg` - ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++` +Environment variable: `+++QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] @@ -4122,6 +4108,134 @@ endif::add-copy-button-to-env-var[] |`PT5M` +h|[[quarkus-container-image-podman_quarkus-container-image-podman-container-image-podman]]link:#quarkus-container-image-podman_quarkus-container-image-podman-container-image-podman[Container Image Podman] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-dockerfile-jvm-path]]`link:#quarkus-container-image-podman_quarkus-podman-dockerfile-jvm-path[quarkus.podman.dockerfile-jvm-path]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-dockerfile-native-path]]`link:#quarkus-container-image-podman_quarkus-podman-dockerfile-native-path[quarkus.podman.dockerfile-native-path]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-cache-from]]`link:#quarkus-container-image-podman_quarkus-podman-cache-from[quarkus.podman.cache-from]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_CACHE_FROM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_CACHE_FROM+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-network]]`link:#quarkus-container-image-podman_quarkus-podman-network[quarkus.podman.network]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_NETWORK+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_NETWORK+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-executable-name]]`link:#quarkus-container-image-podman_quarkus-podman-executable-name[quarkus.podman.executable-name]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_EXECUTABLE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_EXECUTABLE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-additional-args]]`link:#quarkus-container-image-podman_quarkus-podman-additional-args[quarkus.podman.additional-args]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-platform]]`link:#quarkus-container-image-podman_quarkus-podman-platform[quarkus.podman.platform]` + + +[.description] +-- +Which platform(s) to target during the build. See https://docs.podman.io/en/latest/markdown/podman-build.1.html++#++platform-os-arch-variant + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_PLATFORM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_PLATFORM+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-build-args-build-args]]`link:#quarkus-container-image-podman_quarkus-podman-build-args-build-args[quarkus.podman.build-args."build-args"]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +| + + h|[[quarkus-datasource_quarkus-datasource-datasources]]link:#quarkus-datasource_quarkus-datasource-datasources[Datasources] h|Type @@ -5685,6 +5799,23 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-hosts]]`link:#quarkus-vertx-http_quarkus-dev-ui-hosts[quarkus.dev-ui.hosts]` + + +[.description] +-- +More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_HOSTS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-cors-enabled]]`link:#quarkus-vertx-http_quarkus-dev-ui-cors-enabled[quarkus.dev-ui.cors.enabled]` @@ -5909,6 +6040,25 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compressors]]`link:#quarkus-vertx-http_quarkus-http-compressors[quarkus.http.compressors]` + + +[.description] +-- +If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project. + +Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_COMPRESSORS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`gzip,deflate` + + a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compress-media-types]]`link:#quarkus-vertx-http_quarkus-http-compress-media-types[quarkus.http.compress-media-types]` @@ -5943,14 +6093,36 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]` + + +[.description] +-- +Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are: + + - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported. + - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name. + - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI). + - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++` +endif::add-copy-button-to-env-var[] +--|string +|`CN` + + a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]` [.description] -- -Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. +Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. -Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8. +Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[] @@ -6912,6 +7084,27 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-vertx-http_quarkus-http-tls-configuration-name]]`link:#quarkus-vertx-http_quarkus-http-tls-configuration-name[quarkus.http.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.http.ssl` will be used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-vertx-http_quarkus-http-static-resources-index-page]]`link:#quarkus-vertx-http_quarkus-http-static-resources-index-page[quarkus.http.static-resources.index-page]` @@ -8728,7 +8921,11 @@ a| [[quarkus-vertx-http_quarkus-management-host]]`link:#quarkus-vertx-http_quark [.description] -- -The HTTP host Defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. +The HTTP host + +Defaults to 0.0.0.0 + +Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_HOST+++[] @@ -9165,6 +9362,27 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-vertx-http_quarkus-management-tls-configuration-name]]`link:#quarkus-vertx-http_quarkus-management-tls-configuration-name[quarkus.management.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.management.ssl` will be used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-vertx-http_quarkus-management-handle-100-continue-automatically]]`link:#quarkus-vertx-http_quarkus-management-handle-100-continue-automatically[quarkus.management.handle-100-continue-automatically]` @@ -13604,10 +13822,10 @@ a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate [.description] -- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. +Paths to files containing the SQL statements to execute when Hibernate ORM starts. -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). +The files are retrieved from the classpath resources, +so they must be located in the resources directory (e.g. `src/main/resources`). The default value for this setting differs depending on the Quarkus launch mode: @@ -13644,7 +13862,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] --|list of link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] -|`import.sql in DEV, TEST ; no-file otherwise` +|`import.sql in dev and test modes ; no-file otherwise` a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-physical-naming-strategy]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-physical-naming-strategy[quarkus.hibernate-orm.physical-naming-strategy]` @@ -13823,25 +14041,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-multitenant-schema-datasource]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm.multitenant-schema-datasource]` - -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm."persistence-unit-name".multitenant-schema-datasource]` - - -[.description] --- -Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-validate-in-dev-mode]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm.validate-in-dev-mode]` `link:#quarkus-hibernate-orm_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm."persistence-unit-name".validate-in-dev-mode]` @@ -14147,6 +14346,25 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` + + +[.description] +-- +Highlight the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` `link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` @@ -18520,40 +18738,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-enabled]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-enabled[quarkus.infinispan-client.devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-devservices-config-files]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-devservices-config-files[quarkus.infinispan-client.devservices.config-files]` @@ -19149,40 +19333,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name[quarkus.infinispan-client."named-infinispan-clients".devservices.container-env."environment-variable-name"]` @@ -20329,6 +20479,45 @@ endif::add-copy-button-to-env-var[] |`target/jacoco-report` +h|[[quarkus-jfr_quarkus-jfr-jfr]]link:#quarkus-jfr_quarkus-jfr-jfr[Jfr] + +h|Type +h|Default + +a| [[quarkus-jfr_quarkus-jfr-enabled]]`link:#quarkus-jfr_quarkus-jfr-enabled[quarkus.jfr.enabled]` + + +[.description] +-- +If false, only quarkus-jfr events are not recorded even if JFR is enabled. In this case, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JFR_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_JFR_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-jfr_quarkus-jfr-rest-enabled]]`link:#quarkus-jfr_quarkus-jfr-rest-enabled[quarkus.jfr.rest.enabled]` + + +[.description] +-- +If false, only REST events in quarkus-jfr are not recorded even if JFR is enabled. In this case, other quarkus-jfr, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JFR_REST_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_JFR_REST_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-keycloak-admin-client-common_quarkus-keycloak-admin-client-common-keycloak-admin-client-common]]link:#quarkus-keycloak-admin-client-common_quarkus-keycloak-admin-client-common-keycloak-admin-client-common[Keycloak Admin Client Common] h|Type @@ -39323,6 +39512,130 @@ endif::add-copy-button-to-env-var[] | +h|[[quarkus-load-shedding_quarkus-load-shedding-load-shedding]]link:#quarkus-load-shedding_quarkus-load-shedding-load-shedding[Load Shedding] + +h|Type +h|Default + +a| [[quarkus-load-shedding_quarkus-load-shedding-enabled]]`link:#quarkus-load-shedding_quarkus-load-shedding-enabled[quarkus.load-shedding.enabled]` + + +[.description] +-- +Whether load shedding should be enabled. Currently, this only applies to incoming HTTP requests. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-max-limit]]`link:#quarkus-load-shedding_quarkus-load-shedding-max-limit[quarkus.load-shedding.max-limit]` + + +[.description] +-- +The maximum number of concurrent requests allowed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_MAX_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_MAX_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-alpha-factor]]`link:#quarkus-load-shedding_quarkus-load-shedding-alpha-factor[quarkus.load-shedding.alpha-factor]` + + +[.description] +-- +The `alpha` factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|int +|`3` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-beta-factor]]`link:#quarkus-load-shedding_quarkus-load-shedding-beta-factor[quarkus.load-shedding.beta-factor]` + + +[.description] +-- +The `beta` factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_BETA_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_BETA_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|int +|`6` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-probe-factor]]`link:#quarkus-load-shedding_quarkus-load-shedding-probe-factor[quarkus.load-shedding.probe-factor]` + + +[.description] +-- +The probe factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PROBE_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PROBE_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|double +|`30.0` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-initial-limit]]`link:#quarkus-load-shedding_quarkus-load-shedding-initial-limit[quarkus.load-shedding.initial-limit]` + + +[.description] +-- +The initial limit of concurrent requests allowed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-priority-enabled]]`link:#quarkus-load-shedding_quarkus-load-shedding-priority-enabled[quarkus.load-shedding.priority.enabled]` + + +[.description] +-- +Whether priority load shedding should be enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-logging-gelf_quarkus-logging-gelf-logging-gelf]]link:#quarkus-logging-gelf_quarkus-logging-gelf-logging-gelf[Logging GELF] h|Type @@ -40381,7 +40694,9 @@ a| [[quarkus-mailer_quarkus-mailer-port]]`link:#quarkus-mailer_quarkus-mailer-po [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_PORT+++[] @@ -40427,35 +40742,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-ssl]]`link:#quarkus-mailer_quarkus-mailer-ssl[quarkus.mailer.ssl]` +a| [[quarkus-mailer_quarkus-mailer-tls-configuration-name]]`link:#quarkus-mailer_quarkus-mailer-tls-configuration-name[quarkus.mailer.tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_SSL+++` +Environment variable: `+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer_quarkus-mailer-trust-all]]`link:#quarkus-mailer_quarkus-mailer-trust-all[quarkus.mailer.trust-all]` +a| [[quarkus-mailer_quarkus-mailer-tls]]`link:#quarkus-mailer_quarkus-mailer-tls[quarkus.mailer.tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER_TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -40517,7 +40840,9 @@ a| [[quarkus-mailer_quarkus-mailer-disable-esmtp]]`link:#quarkus-mailer_quarkus- [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_DISABLE_ESMTP+++[] @@ -40779,7 +41104,9 @@ a| [[quarkus-mailer_quarkus-mailer-auth-methods]]`link:#quarkus-mailer_quarkus-m [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_AUTH_METHODS+++[] @@ -40791,59 +41118,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-truststore-password]]`link:#quarkus-mailer_quarkus-mailer-truststore-password[quarkus.mailer.truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer_quarkus-mailer-truststore-paths]]`link:#quarkus-mailer_quarkus-mailer-truststore-paths[quarkus.mailer.truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer_quarkus-mailer-truststore-type]]`link:#quarkus-mailer_quarkus-mailer-truststore-type[quarkus.mailer.truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer_quarkus-mailer-multi-part-only]]`link:#quarkus-mailer_quarkus-mailer-multi-part-only[quarkus.mailer.multi-part-only]` @@ -41084,7 +41358,9 @@ a| [[quarkus-mailer_quarkus-mailer-mailer-name-port]]`link:#quarkus-mailer_quark [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__PORT+++[] @@ -41130,35 +41406,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-mailer-name-ssl]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-ssl[quarkus.mailer."mailer-name".ssl]` +a| [[quarkus-mailer_quarkus-mailer-mailer-name-tls-configuration-name]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-tls-configuration-name[quarkus.mailer."mailer-name".tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__SSL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer_quarkus-mailer-mailer-name-trust-all]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-trust-all[quarkus.mailer."mailer-name".trust-all]` +a| [[quarkus-mailer_quarkus-mailer-mailer-name-tls]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-tls[quarkus.mailer."mailer-name".tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -41220,7 +41504,9 @@ a| [[quarkus-mailer_quarkus-mailer-mailer-name-disable-esmtp]]`link:#quarkus-mai [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP+++[] @@ -41482,7 +41768,9 @@ a| [[quarkus-mailer_quarkus-mailer-mailer-name-auth-methods]]`link:#quarkus-mail [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS+++[] @@ -41494,59 +41782,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-mailer-name-truststore-password]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-truststore-password[quarkus.mailer."mailer-name".truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer_quarkus-mailer-mailer-name-truststore-paths]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-truststore-paths[quarkus.mailer."mailer-name".truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer_quarkus-mailer-mailer-name-truststore-type]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-truststore-type[quarkus.mailer."mailer-name".truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer_quarkus-mailer-mailer-name-multi-part-only]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-multi-part-only[quarkus.mailer."mailer-name".multi-part-only]` @@ -43414,7 +43649,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-client_quarkus-mongodb- [.description] -- -If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_ENABLED+++[] @@ -43462,6 +43699,44 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-client_quarkus-mongodb-devservices-shared]]`link:#quarkus-mongodb-client_quarkus-mongodb-devservices-shared[quarkus.mongodb.devservices.shared]` + + +[.description] +-- +Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container. + +The discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-client_quarkus-mongodb-devservices-service-name]]`link:#quarkus-mongodb-client_quarkus-mongodb-devservices-service-name[quarkus.mongodb.devservices.service-name]` + + +[.description] +-- +The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`mongodb` + + a| [[quarkus-mongodb-client_quarkus-mongodb-connection-string]]`link:#quarkus-mongodb-client_quarkus-mongodb-connection-string[quarkus.mongodb.connection-string]` @@ -45054,6 +45329,23 @@ h|[[quarkus-narayana-lra_quarkus-narayana-lra-narayana-lra-lra-participant-suppo h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-narayana-lra_quarkus-lra-openapi-included]]`link:#quarkus-narayana-lra_quarkus-lra-openapi-included[quarkus.lra.openapi.included]` + + +[.description] +-- +Whether to include LRA proxy endpoints in the generated OpenAPI document + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LRA_OPENAPI_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LRA_OPENAPI_INCLUDED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a| [[quarkus-narayana-lra_quarkus-lra-coordinator-url]]`link:#quarkus-narayana-lra_quarkus-lra-coordinator-url[quarkus.lra.coordinator-url]` @@ -45129,7 +45421,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] --|string -|`quay.io/keycloak/keycloak:23.0.7` +|`quay.io/keycloak/keycloak:24.0.4` a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image]]`link:#quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image[quarkus.keycloak.devservices.keycloak-x-image]` @@ -52878,6 +53170,23 @@ endif::add-copy-button-to-env-var[] |`parentbased_always_on` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled]]`link:#quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled[quarkus.otel.traces.eusp.enabled]` + + +[.description] +-- +If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-metrics-exporter]]`link:#quarkus-opentelemetry_quarkus-otel-metrics-exporter[quarkus.otel.metrics.exporter]` @@ -53669,6 +53978,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name]]`link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name[quarkus.otel.exporter.otlp.traces.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]]`link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[quarkus.otel.exporter.otlp.traces.proxy-options.enabled]` @@ -54749,7 +55077,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-devservices-launch [.description] -- -Global flag that can be used to force the attachmment of Dev Services to shared netxork. Default is false. +Global flag that can be used to force the attachmment of Dev Services to shared network. Default is false. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DEVSERVICES_LAUNCH_ON_SHARED_NETWORK+++[] @@ -55738,6 +56066,25 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-agent-configuration-apply]]`link:#quarkus-core_quarkus-native-agent-configuration-apply[quarkus.native.agent-configuration-apply]` + + +[.description] +-- +Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process. + +Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-enabled]]`link:#quarkus-core_quarkus-package-jar-enabled[quarkus.package.jar.enabled]` @@ -56977,23 +57324,6 @@ endif::add-copy-button-to-env-var[] |`30S` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-tls-trust-all]]`link:#quarkus-core_quarkus-tls-trust-all[quarkus.tls.trust-all]` - - -[.description] --- -Enable trusting all certificates. Disable by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - h|[[quarkus-core_quarkus-index-dependency-index-dependency-artifacts-on-the-classpath-that-should-also-be-indexed]]link:#quarkus-core_quarkus-index-dependency-index-dependency-artifacts-on-the-classpath-that-should-also-be-indexed[Artifacts on the classpath that should also be indexed] h|Type @@ -58722,6 +59052,23 @@ endif::add-copy-button-to-env-var[] |`http://localhost:8888` +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name]]`link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name[quarkus.spring-cloud-config.name]` + + +[.description] +-- +Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma) + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`${quarkus.application.name:}` + + a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label]]`link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label[quarkus.spring-cloud-config.label]` @@ -60729,6 +61076,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-rest-client-config_quarkus-rest-client-tls-configuration-name]]`link:#quarkus-rest-client-config_quarkus-rest-client-tls-configuration-name[quarkus.rest-client.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-rest-client-config_quarkus-rest-client-http2]]`link:#quarkus-rest-client-config_quarkus-rest-client-http2[quarkus.rest-client.http2]` @@ -61167,6 +61537,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-rest-client-config_quarkus-rest-client-config-key-tls-configuration-name]]`link:#quarkus-rest-client-config_quarkus-rest-client-config-key-tls-configuration-name[quarkus.rest-client."config-key".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-rest-client-config_quarkus-rest-client-config-key-connection-ttl]]`link:#quarkus-rest-client-config_quarkus-rest-client-config-key-connection-ttl[quarkus.rest-client."config-key".connection-ttl]` @@ -61860,6 +62253,23 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-rest-kotlin-serialization-common_quarkus-kotlin-serialization-json-allow-comments]]`link:#quarkus-rest-kotlin-serialization-common_quarkus-kotlin-serialization-json-allow-comments[quarkus.kotlin-serialization.json.allow-comments]` + + +[.description] +-- +Allows parser to accept C/Java-style comments in JSON input. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + h|[[quarkus-rest-qute_quarkus-rest-qute-rest-qute]]link:#quarkus-rest-qute_quarkus-rest-qute-rest-qute[REST Qute] h|Type @@ -64412,6 +64822,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]]`link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[quarkus.redis.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-redis-client_quarkus-redis-redis-client-name-load-script]]`link:#quarkus-redis-client_quarkus-redis-redis-client-name-load-script[quarkus.redis."redis-client-name".load-script]` @@ -64947,6 +65380,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]]`link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[quarkus.redis."redis-client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-redis-client_quarkus-redis-tcp-tcp-config]]link:#quarkus-redis-client_quarkus-redis-tcp-tcp-config[TCP config] h|Type @@ -70266,682 +70722,2194 @@ endif::add-copy-button-to-env-var[] | -h|[[quarkus-undertow_quarkus-undertow-undertow-servlet]]link:#quarkus-undertow_quarkus-undertow-undertow-servlet[Undertow Servlet] +h|[[quarkus-tls-registry_quarkus-tls-registry-tls-certificate-registry]]link:#quarkus-tls-registry_quarkus-tls-registry-tls-certificate-registry[TLS certificate registry] h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-undertow_quarkus-servlet-context-path]]`link:#quarkus-undertow_quarkus-servlet-context-path[quarkus.servlet.context-path]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-cipher-suites]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-cipher-suites[quarkus.tls."tls-bucket-name".cipher-suites]` [.description] -- -The context path for Servlet content. This will determine the path used to resolve all Servlet-based resources, including JAX-RS resources - when using the Undertow extension in conjunction with RESTEasy. - -This path is specified with a leading `/`, but is resolved relative to `quarkus.http.root-path`. +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. - - If `quarkus.http.root-path=/` and `quarkus.servlet.context-path=/bar`, the servlet path will be `/bar` - - If `quarkus.http.root-path=/foo` and `quarkus.servlet.context-path=/bar`, the servlet path will be `/foo/bar` +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_CONTEXT_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SERVLET_CONTEXT_PATH+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++` endif::add-copy-button-to-env-var[] ---|string +--|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-undertow_quarkus-servlet-default-charset]]`link:#quarkus-undertow_quarkus-servlet-default-charset[quarkus.servlet.default-charset]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-protocols]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-protocols[quarkus.tls."tls-bucket-name".protocols]` [.description] -- -The default charset to use for reading and writing requests +Sets the ordered list of enabled TLS protocols. -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_DEFAULT_CHARSET+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SERVLET_DEFAULT_CHARSET+++` -endif::add-copy-button-to-env-var[] ---|string -|`UTF-8` - - -a| [[quarkus-undertow_quarkus-servlet-buffer-size]]`link:#quarkus-undertow_quarkus-servlet-buffer-size[quarkus.servlet.buffer-size]` +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. -[.description] --- -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. +Also, setting this replaces the default list of protocols. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_BUFFER_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SERVLET_BUFFER_SIZE+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] -| +--|list of string +|`TLSv1.3,TLSv1.2` -a| [[quarkus-undertow_quarkus-servlet-direct-buffers]]`link:#quarkus-undertow_quarkus-servlet-direct-buffers[quarkus.servlet.direct-buffers]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout[quarkus.tls."tls-bucket-name".handshake-timeout]` [.description] -- -If Servlet should use direct buffers, this gives maximum performance but can be problematic in memory constrained environments +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_DIRECT_BUFFERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SERVLET_DIRECT_BUFFERS+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|boolean -| +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` -a| [[quarkus-undertow_quarkus-servlet-max-parameters]]`link:#quarkus-undertow_quarkus-servlet-max-parameters[quarkus.servlet.max-parameters]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn[quarkus.tls."tls-bucket-name".alpn]` [.description] -- -The maximum number of HTTP request parameters permitted for Servlet requests. If a client sends more than this number of parameters in a request, the connection is closed. +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_MAX_PARAMETERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SERVLET_MAX_PARAMETERS+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++` endif::add-copy-button-to-env-var[] ---|int -|`1000` - - -h|[[quarkus-virtual-threads_quarkus-virtual-threads-virtual-threads-support]]link:#quarkus-virtual-threads_quarkus-virtual-threads-virtual-threads-support[Virtual Threads Support] +--|boolean +|`true` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-name-prefix]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-name-prefix[quarkus.virtual-threads.name-prefix]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-certificate-revocation-list]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-certificate-revocation-list[quarkus.tls."tls-bucket-name".certificate-revocation-list]` [.description] -- -Virtual thread name prefix. If left blank virtual threads will be unnamed. +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_NAME_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_VIRTUAL_THREADS_NAME_PREFIX+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++` endif::add-copy-button-to-env-var[] ---|string -|`quarkus-virtual-thread-` +--|list of path +| -a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-timeout]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-timeout[quarkus.virtual-threads.shutdown-timeout]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-all]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-all[quarkus.tls."tls-bucket-name".trust-all]` [.description] -- -The shutdown timeout. If all pending work has not been completed by this time then any pending tasks will be interrupted, and the shutdown process will continue +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`1M` +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval[quarkus.virtual-threads.shutdown-check-interval]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-hostname-verification-algorithm]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-hostname-verification-algorithm[quarkus.tls."tls-bucket-name".hostname-verification-algorithm]` [.description] -- -The frequency at which the status of the executor service should be checked during shutdown. Setting this key to an empty value disables the shutdown check interval. +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`5s` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-enabled]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-enabled[quarkus.virtual-threads.enabled]` +h|[[quarkus-tls-registry_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration]]link:#quarkus-tls-registry_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration[The default TLS bucket configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-registry_quarkus-tls-cipher-suites]]`link:#quarkus-tls-registry_quarkus-tls-cipher-suites[quarkus.tls.cipher-suites]` [.description] -- -A flag to explicitly disabled virtual threads, even if the JVM support them. In this case, methods annotated with `@RunOnVirtualThread` are executed on the worker thread pool. +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. -This flag is intended to be used when running with virtual threads become more expensive than plain worker threads, because of pinning, monopolization or thread-based object pool. +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CIPHER_SUITES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_VIRTUAL_THREADS_ENABLED+++` +Environment variable: `+++QUARKUS_TLS_CIPHER_SUITES+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -h|[[quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-dependency-locator]]link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-dependency-locator[Web Dependency Locator] +--|list of string +| -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-version-reroute]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-version-reroute[quarkus.web-dependency-locator.version-reroute]` +a| [[quarkus-tls-registry_quarkus-tls-protocols]]`link:#quarkus-tls-registry_quarkus-tls-protocols[quarkus.tls.protocols]` [.description] -- -If the version reroute is enabled. +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_VERSION_REROUTE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_VERSION_REROUTE+++` +Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|list of string +|`TLSv1.3,TLSv1.2` -a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-root]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-root[quarkus.web-dependency-locator.web-root]` +a| [[quarkus-tls-registry_quarkus-tls-handshake-timeout]]`link:#quarkus-tls-registry_quarkus-tls-handshake-timeout[quarkus.tls.handshake-timeout]` [.description] -- -The directory in the resources which serves as root for the web assets +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_WEB_ROOT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_WEB_ROOT+++` +Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|string -|`web` +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-app-root]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-app-root[quarkus.web-dependency-locator.app-root]` +a| [[quarkus-tls-registry_quarkus-tls-alpn]]`link:#quarkus-tls-registry_quarkus-tls-alpn[quarkus.tls.alpn]` [.description] -- -The directory in the resources which serves as root for the app assets +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_APP_ROOT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_ALPN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_APP_ROOT+++` +Environment variable: `+++QUARKUS_TLS_ALPN+++` endif::add-copy-button-to-env-var[] ---|string -|`app` +--|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-import-mappings-module-specifier]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-import-mappings-module-specifier[quarkus.web-dependency-locator.import-mappings."module-specifier"]` +a| [[quarkus-tls-registry_quarkus-tls-certificate-revocation-list]]`link:#quarkus-tls-registry_quarkus-tls-certificate-revocation-list[quarkus.tls.certificate-revocation-list]` [.description] -- -User defined import mappings +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_IMPORT_MAPPINGS__MODULE_SPECIFIER_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_IMPORT_MAPPINGS__MODULE_SPECIFIER_+++` +Environment variable: `+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +--|list of path | -h|[[quarkus-websockets-client_quarkus-websockets-client-websockets-client]]link:#quarkus-websockets-client_quarkus-websockets-client-websockets-client[WebSockets Client] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-websockets-client_quarkus-websocket-max-frame-size]]`link:#quarkus-websockets-client_quarkus-websocket-max-frame-size[quarkus.websocket.max-frame-size]` +a| [[quarkus-tls-registry_quarkus-tls-trust-all]]`link:#quarkus-tls-registry_quarkus-tls-trust-all[quarkus.tls.trust-all]` [.description] -- -The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKET_MAX_FRAME_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKET_MAX_FRAME_SIZE+++` +Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` endif::add-copy-button-to-env-var[] ---|int -|`65536` +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-websockets-client_quarkus-websocket-dispatch-to-worker]]`link:#quarkus-websockets-client_quarkus-websocket-dispatch-to-worker[quarkus.websocket.dispatch-to-worker]` +a| [[quarkus-tls-registry_quarkus-tls-hostname-verification-algorithm]]`link:#quarkus-tls-registry_quarkus-tls-hostname-verification-algorithm[quarkus.tls.hostname-verification-algorithm]` [.description] -- -If the websocket methods should be run in a worker thread. This allows them to run blocking tasks, however it will not be as fast as running directly in the IO thread. +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKET_DISPATCH_TO_WORKER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKET_DISPATCH_TO_WORKER+++` +Environment variable: `+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - +--|string +| -h|[[quarkus-websockets-next_quarkus-websockets-next-websockets-next]]link:#quarkus-websockets-next_quarkus-websockets-next-websockets-next[WebSockets Next] +h|[[quarkus-tls-registry_quarkus-tls-key-store-the-key-store-configuration]]link:#quarkus-tls-registry_quarkus-tls-key-store-the-key-store-configuration[The key store configuration] +This configuration section is optional h|Type h|Default -a| [[quarkus-websockets-next_quarkus-websockets-next-client-offer-per-message-compression]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-offer-per-message-compression[quarkus.websockets-next.client.offer-per-message-compression]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-sni]]`link:#quarkus-tls-registry_quarkus-tls-key-store-sni[quarkus.tls.key-store.sni]` [.description] -- -Compression Extensions for WebSocket are supported by default. +Enables Server Name Indication (SNI). -See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692] +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_SNI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_SNI+++` endif::add-copy-button-to-env-var[] --|boolean |`false` -a| [[quarkus-websockets-next_quarkus-websockets-next-client-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-compression-level[quarkus.websockets-next.client.compression-level]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-name]]`link:#quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-name[quarkus.tls.key-store.credentials-provider.name]` [.description] -- -The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`. +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -a| [[quarkus-websockets-next_quarkus-websockets-next-client-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-max-message-size[quarkus.websockets-next.client.max-message-size]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-bean-name[quarkus.tls.key-store.credentials-provider.bean-name]` [.description] -- -The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`. +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -a| [[quarkus-websockets-next_quarkus-websockets-next-client-auto-ping-interval]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-auto-ping-interval[quarkus.websockets-next.client.auto-ping-interval]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-password-key]]`link:#quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-password-key[quarkus.tls.key-store.credentials-provider.password-key]` [.description] -- -The interval after which, when set, the client sends a ping message to a connected server automatically. +The key used to retrieve the key store password. -Ping messages are not sent automatically by default. +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +--|string +|`password` -a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[quarkus.websockets-next.client.unhandled-failure-strategy]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-registry_quarkus-tls-key-store-credentials-provider-alias-password-key[quarkus.tls.key-store.credentials-provider.alias-password-key]` [.description] -- -The strategy used when an error occurs but no error handler can handle the failure. +The key used to retrieve the key store alias password. -By default, the connection is closed when an unhandled failure occurs. +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` endif::add-copy-button-to-env-var[] --- a| -`close`, `log`, `noop` -|`close` +--|string +|`alias-password` -a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[quarkus.websockets-next.server.supported-subprotocols]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` [.description] -- -See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol] +Enables Server Name Indication (SNI). -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. -a| [[quarkus-websockets-next_quarkus-websockets-next-server-per-message-compression-supported]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-per-message-compression-supported[quarkus.websockets-next.server.per-message-compression-supported]` - - -[.description] --- -Compression Extensions for WebSocket are supported by default. - -See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692] +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` endif::add-copy-button-to-env-var[] --|boolean -|`true` +|`false` -a| [[quarkus-websockets-next_quarkus-websockets-next-server-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-compression-level[quarkus.websockets-next.server.compression-level]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` [.description] -- -The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`. +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -a| [[quarkus-websockets-next_quarkus-websockets-next-server-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-max-message-size[quarkus.websockets-next.server.max-message-size]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` [.description] -- -The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`. +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -a| [[quarkus-websockets-next_quarkus-websockets-next-server-auto-ping-interval]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-auto-ping-interval[quarkus.websockets-next.server.auto-ping-interval]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` [.description] -- -The interval after which, when set, the server sends a ping message to a connected client automatically. +The key used to retrieve the key store password. -Ping messages are not sent automatically by default. +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +--|string +|`password` -a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy[quarkus.websockets-next.server.unhandled-failure-strategy]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` [.description] -- -The strategy used when an error occurs but no error handler can handle the failure. +The key used to retrieve the key store alias password. -By default, the connection is closed when an unhandled failure occurs. +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` endif::add-copy-button-to-env-var[] --- a| -`close`, `log`, `noop` -|`close` - +--|string +|`alias-password` -h|[[quarkus-grpc_quarkus-grpc-grpc]]link:#quarkus-grpc_quarkus-grpc-grpc[gRPC] +h|[[quarkus-tls-registry_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-registry_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto]]`link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto[quarkus.generate-code.grpc.scan-for-proto]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls-registry_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` [.description] -- -gRPC code generation can scan dependencies of the application for proto files to generate Java stubs from. This property sets the scope of the dependencies to scan. Applicable values: +The order of the key/cert files, based on the names in the `keyCerts` map. - - _none_ - default - don't scan dependencies - - a comma separated list of _groupId:artifactId_ coordinates to scan - - _all_ - scan all dependencies +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` endif::add-copy-button-to-env-var[] ---|string -|`none` +--|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports]]`link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports[quarkus.generate-code.grpc.scan-for-imports]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` [.description] -- -Specify the dependencies that are allowed to have proto files that can be imported by this application's protos Applicable values: - - - _none_ - default - don't scan dependencies - - a comma separated list of _groupId:artifactId_ coordinates to scan - - _all_ - scan all dependencies By default, _com.google.protobuf:protobuf-java_. +The path to the key file (in PEM format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` endif::add-copy-button-to-env-var[] ---|string -|`com.google.protobuf:protobuf-java` +--|path +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-dev-mode-force-server-start]]`link:#quarkus-grpc_quarkus-grpc-dev-mode-force-server-start[quarkus.grpc.dev-mode.force-server-start]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` [.description] -- -Start gRPC server in dev mode even if no gRPC services are implemented. By default set to `true` to ease incremental development of new services using dev mode. +The path to the certificate file (in PEM format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_DEV_MODE_FORCE_SERVER_START+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_DEV_MODE_FORCE_SERVER_START+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|path +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-client-stork-proactive-connections]]`link:#quarkus-grpc_quarkus-grpc-client-stork-proactive-connections[quarkus.grpc-client.stork-proactive-connections]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` [.description] -- -If set to true, and a Stork load balancer is used, connections with all available service instances will be requested proactively. This means better load balancing at the cost of having multiple active connections. +The path to the key file (in PEM format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENT_STORK_PROACTIVE_CONNECTIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_CLIENT_STORK_PROACTIVE_CONNECTIONS+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|path +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-server-health-enabled]]`link:#quarkus-grpc_quarkus-grpc-server-health-enabled[quarkus.grpc.server.health.enabled]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` [.description] -- -Whether a health check on gRPC status is published in case the smallrye-health extension is present. +The path to the certificate file (in PEM format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_HEALTH_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_SERVER_HEALTH_ENABLED+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|path +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-server-grpc-health-enabled]]`link:#quarkus-grpc_quarkus-grpc-server-grpc-health-enabled[quarkus.grpc.server.grpc-health.enabled]` +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` [.description] -- -Whether the gRPC health check is exposed. +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_GRPC_HEALTH_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_SERVER_GRPC_HEALTH_ENABLED+++` +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` - +--|list of string +| -h|[[quarkus-grpc_quarkus-grpc-clients-configures-the-grpc-clients]]link:#quarkus-grpc_quarkus-grpc-clients-configures-the-grpc-clients[Configures the gRPC clients] +h|[[quarkus-tls-registry_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-registry_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional h|Type h|Default -a| [[quarkus-grpc_quarkus-grpc-clients-client-name-use-quarkus-grpc-client]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-use-quarkus-grpc-client[quarkus.grpc.clients."client-name".use-quarkus-grpc-client]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls-registry_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` [.description] -- -Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support. +Path to the key store file (P12 / PFX format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|path +|required icon:exclamation-circle[title=Configuration property is required] -a| [[quarkus-grpc_quarkus-grpc-clients-client-name-xds-enabled]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-xds-enabled[quarkus.grpc.clients."client-name".xds.enabled]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls-registry_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` [.description] -- -Explicitly enable use of XDS. +Password of the key store. When not set, the password must be retrieved from the credential provider. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-grpc_quarkus-grpc-clients-client-name-xds-secure]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-xds-secure[quarkus.grpc.clients."client-name".xds.secure]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls-registry_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` [.description] -- -Use secure credentials. +Alias of the private key and certificate in the key store. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-grpc_quarkus-grpc-clients-client-name-xds-target]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-xds-target[quarkus.grpc.clients."client-name".xds.target]` +a| [[quarkus-tls-registry_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls-registry_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` [.description] -- -Optional explicit target. +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET+++` +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls-registry_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-registry_quarkus-tls-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-registry_quarkus-tls-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-registry_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls-registry_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls-registry_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls-registry_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls-registry_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls-registry_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-registry_quarkus-tls-trust-store-the-trust-store-configuration]]link:#quarkus-tls-registry_quarkus-tls-trust-store-the-trust-store-configuration[The trust store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-credentials-provider-name]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-credentials-provider-name[quarkus.tls.trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-credentials-provider-bean-name[quarkus.tls.trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-credentials-provider-password-key[quarkus.tls.trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls-registry_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-registry_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-registry_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-registry_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-registry_quarkus-tls-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-registry_quarkus-tls-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls-registry_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-undertow_quarkus-undertow-undertow-servlet]]link:#quarkus-undertow_quarkus-undertow-undertow-servlet[Undertow Servlet] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-undertow_quarkus-servlet-context-path]]`link:#quarkus-undertow_quarkus-servlet-context-path[quarkus.servlet.context-path]` + + +[.description] +-- +The context path for Servlet content. This will determine the path used to resolve all Servlet-based resources, including JAX-RS resources - when using the Undertow extension in conjunction with RESTEasy. + +This path is specified with a leading `/`, but is resolved relative to `quarkus.http.root-path`. + + - If `quarkus.http.root-path=/` and `quarkus.servlet.context-path=/bar`, the servlet path will be `/bar` + - If `quarkus.http.root-path=/foo` and `quarkus.servlet.context-path=/bar`, the servlet path will be `/foo/bar` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_CONTEXT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SERVLET_CONTEXT_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-undertow_quarkus-servlet-default-charset]]`link:#quarkus-undertow_quarkus-servlet-default-charset[quarkus.servlet.default-charset]` + + +[.description] +-- +The default charset to use for reading and writing requests + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_DEFAULT_CHARSET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SERVLET_DEFAULT_CHARSET+++` +endif::add-copy-button-to-env-var[] +--|string +|`UTF-8` + + +a| [[quarkus-undertow_quarkus-servlet-buffer-size]]`link:#quarkus-undertow_quarkus-servlet-buffer-size[quarkus.servlet.buffer-size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_BUFFER_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SERVLET_BUFFER_SIZE+++` +endif::add-copy-button-to-env-var[] +--|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +| + + +a| [[quarkus-undertow_quarkus-servlet-direct-buffers]]`link:#quarkus-undertow_quarkus-servlet-direct-buffers[quarkus.servlet.direct-buffers]` + + +[.description] +-- +If Servlet should use direct buffers, this gives maximum performance but can be problematic in memory constrained environments + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_DIRECT_BUFFERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SERVLET_DIRECT_BUFFERS+++` +endif::add-copy-button-to-env-var[] +--|boolean +| + + +a| [[quarkus-undertow_quarkus-servlet-max-parameters]]`link:#quarkus-undertow_quarkus-servlet-max-parameters[quarkus.servlet.max-parameters]` + + +[.description] +-- +The maximum number of HTTP request parameters permitted for Servlet requests. If a client sends more than this number of parameters in a request, the connection is closed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SERVLET_MAX_PARAMETERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SERVLET_MAX_PARAMETERS+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +h|[[quarkus-virtual-threads_quarkus-virtual-threads-virtual-threads-support]]link:#quarkus-virtual-threads_quarkus-virtual-threads-virtual-threads-support[Virtual Threads Support] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-name-prefix]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-name-prefix[quarkus.virtual-threads.name-prefix]` + + +[.description] +-- +Virtual thread name prefix. If left blank virtual threads will be unnamed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_VIRTUAL_THREADS_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +--|string +|`quarkus-virtual-thread-` + + +a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-timeout]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-timeout[quarkus.virtual-threads.shutdown-timeout]` + + +[.description] +-- +The shutdown timeout. If all pending work has not been completed by this time then any pending tasks will be interrupted, and the shutdown process will continue + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`1M` + + +a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval[quarkus.virtual-threads.shutdown-check-interval]` + + +[.description] +-- +The frequency at which the status of the executor service should be checked during shutdown. Setting this key to an empty value disables the shutdown check interval. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5s` + + +a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-enabled]]`link:#quarkus-virtual-threads_quarkus-virtual-threads-enabled[quarkus.virtual-threads.enabled]` + + +[.description] +-- +A flag to explicitly disabled virtual threads, even if the JVM support them. In this case, methods annotated with `@RunOnVirtualThread` are executed on the worker thread pool. + +This flag is intended to be used when running with virtual threads become more expensive than plain worker threads, because of pinning, monopolization or thread-based object pool. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_VIRTUAL_THREADS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_VIRTUAL_THREADS_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +h|[[quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-dependency-locator]]link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-dependency-locator[Web Dependency Locator] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-version-reroute]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-version-reroute[quarkus.web-dependency-locator.version-reroute]` + + +[.description] +-- +If the version reroute is enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_VERSION_REROUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_VERSION_REROUTE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-root]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-web-root[quarkus.web-dependency-locator.web-root]` + + +[.description] +-- +The directory in the resources which serves as root for the web assets + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_WEB_ROOT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_WEB_ROOT+++` +endif::add-copy-button-to-env-var[] +--|string +|`web` + + +a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-app-root]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-app-root[quarkus.web-dependency-locator.app-root]` + + +[.description] +-- +The directory in the resources which serves as root for the app assets + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_APP_ROOT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_APP_ROOT+++` +endif::add-copy-button-to-env-var[] +--|string +|`app` + + +a|icon:lock[title=Fixed at build time] [[quarkus-web-dependency-locator_quarkus-web-dependency-locator-import-mappings-module-specifier]]`link:#quarkus-web-dependency-locator_quarkus-web-dependency-locator-import-mappings-module-specifier[quarkus.web-dependency-locator.import-mappings."module-specifier"]` + + +[.description] +-- +User defined import mappings + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEB_DEPENDENCY_LOCATOR_IMPORT_MAPPINGS__MODULE_SPECIFIER_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEB_DEPENDENCY_LOCATOR_IMPORT_MAPPINGS__MODULE_SPECIFIER_+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +| + + +h|[[quarkus-websockets-client_quarkus-websockets-client-websockets-client]]link:#quarkus-websockets-client_quarkus-websockets-client-websockets-client[WebSockets Client] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-websockets-client_quarkus-websocket-max-frame-size]]`link:#quarkus-websockets-client_quarkus-websocket-max-frame-size[quarkus.websocket.max-frame-size]` + + +[.description] +-- +The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKET_MAX_FRAME_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKET_MAX_FRAME_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`65536` + + +a|icon:lock[title=Fixed at build time] [[quarkus-websockets-client_quarkus-websocket-dispatch-to-worker]]`link:#quarkus-websockets-client_quarkus-websocket-dispatch-to-worker[quarkus.websocket.dispatch-to-worker]` + + +[.description] +-- +If the websocket methods should be run in a worker thread. This allows them to run blocking tasks, however it will not be as fast as running directly in the IO thread. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKET_DISPATCH_TO_WORKER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKET_DISPATCH_TO_WORKER+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +h|[[quarkus-websockets-next_quarkus-websockets-next-websockets-next]]link:#quarkus-websockets-next_quarkus-websockets-next-websockets-next[WebSockets Next] + +h|Type +h|Default + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-offer-per-message-compression]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-offer-per-message-compression[quarkus.websockets-next.client.offer-per-message-compression]` + + +[.description] +-- +Compression Extensions for WebSocket are supported by default. + +See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692] + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-compression-level[quarkus.websockets-next.client.compression-level]` + + +[.description] +-- +The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL+++` +endif::add-copy-button-to-env-var[] +--|int +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-max-message-size[quarkus.websockets-next.client.max-message-size]` + + +[.description] +-- +The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-auto-ping-interval]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-auto-ping-interval[quarkus.websockets-next.client.auto-ping-interval]` + + +[.description] +-- +The interval after which, when set, the client sends a ping message to a connected server automatically. + +Ping messages are not sent automatically by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[quarkus.websockets-next.client.unhandled-failure-strategy]` + + +[.description] +-- +The strategy used when an error occurs but no error handler can handle the failure. + +By default, the connection is closed when an unhandled failure occurs. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- a| +`close`, `log`, `noop` +|`close` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name[quarkus.websockets-next.client.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-enabled]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-enabled[quarkus.websockets-next.client.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-text-payload-limit[quarkus.websockets-next.client.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[quarkus.websockets-next.server.supported-subprotocols]` + + +[.description] +-- +See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol] + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-per-message-compression-supported]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-per-message-compression-supported[quarkus.websockets-next.server.per-message-compression-supported]` + + +[.description] +-- +Compression Extensions for WebSocket are supported by default. + +See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692] + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-compression-level[quarkus.websockets-next.server.compression-level]` + + +[.description] +-- +The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++` +endif::add-copy-button-to-env-var[] +--|int +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-max-message-size[quarkus.websockets-next.server.max-message-size]` + + +[.description] +-- +The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-auto-ping-interval]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-auto-ping-interval[quarkus.websockets-next.server.auto-ping-interval]` + + +[.description] +-- +The interval after which, when set, the server sends a ping message to a connected client automatically. + +Ping messages are not sent automatically by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy[quarkus.websockets-next.server.unhandled-failure-strategy]` + + +[.description] +-- +The strategy used when an error occurs but no error handler can handle the failure. + +By default, the connection is closed when an unhandled failure occurs. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- a| +`close`, `log`, `noop` +|`close` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url[quarkus.websockets-next.server.security.auth-failure-redirect-url]` + + +[.description] +-- +Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-enabled]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-enabled[quarkus.websockets-next.server.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-text-payload-limit[quarkus.websockets-next.server.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +h|[[quarkus-grpc_quarkus-grpc-grpc]]link:#quarkus-grpc_quarkus-grpc-grpc[gRPC] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto]]`link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto[quarkus.generate-code.grpc.scan-for-proto]` + + +[.description] +-- +gRPC code generation can scan dependencies of the application for proto files to generate Java stubs from. This property sets the scope of the dependencies to scan. Applicable values: + + - _none_ - default - don't scan dependencies + - a comma separated list of _groupId:artifactId_ coordinates to scan + - _all_ - scan all dependencies + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports]]`link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports[quarkus.generate-code.grpc.scan-for-imports]` + + +[.description] +-- +Specify the dependencies that are allowed to have proto files that can be imported by this application's protos Applicable values: + + - _none_ - default - don't scan dependencies + - a comma separated list of _groupId:artifactId_ coordinates to scan + - _all_ - scan all dependencies By default, _com.google.protobuf:protobuf-java_. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++` +endif::add-copy-button-to-env-var[] +--|string +|`com.google.protobuf:protobuf-java` + + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-dev-mode-force-server-start]]`link:#quarkus-grpc_quarkus-grpc-dev-mode-force-server-start[quarkus.grpc.dev-mode.force-server-start]` + + +[.description] +-- +Start gRPC server in dev mode even if no gRPC services are implemented. By default set to `true` to ease incremental development of new services using dev mode. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_DEV_MODE_FORCE_SERVER_START+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_DEV_MODE_FORCE_SERVER_START+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-client-stork-proactive-connections]]`link:#quarkus-grpc_quarkus-grpc-client-stork-proactive-connections[quarkus.grpc-client.stork-proactive-connections]` + + +[.description] +-- +If set to true, and a Stork load balancer is used, connections with all available service instances will be requested proactively. This means better load balancing at the cost of having multiple active connections. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENT_STORK_PROACTIVE_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENT_STORK_PROACTIVE_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-server-health-enabled]]`link:#quarkus-grpc_quarkus-grpc-server-health-enabled[quarkus.grpc.server.health.enabled]` + + +[.description] +-- +Whether a health check on gRPC status is published in case the smallrye-health extension is present. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_HEALTH_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_SERVER_HEALTH_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-server-grpc-health-enabled]]`link:#quarkus-grpc_quarkus-grpc-server-grpc-health-enabled[quarkus.grpc.server.grpc-health.enabled]` + + +[.description] +-- +Whether the gRPC health check is exposed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_GRPC_HEALTH_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_SERVER_GRPC_HEALTH_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +h|[[quarkus-grpc_quarkus-grpc-clients-configures-the-grpc-clients]]link:#quarkus-grpc_quarkus-grpc-clients-configures-the-grpc-clients[Configures the gRPC clients] + +h|Type +h|Default + +a| [[quarkus-grpc_quarkus-grpc-clients-client-name-use-quarkus-grpc-client]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-use-quarkus-grpc-client[quarkus.grpc.clients."client-name".use-quarkus-grpc-client]` + + +[.description] +-- +Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-grpc_quarkus-grpc-clients-client-name-xds-enabled]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-xds-enabled[quarkus.grpc.clients."client-name".xds.enabled]` + + +[.description] +-- +Explicitly enable use of XDS. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-grpc_quarkus-grpc-clients-client-name-xds-secure]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-xds-secure[quarkus.grpc.clients."client-name".xds.secure]` + + +[.description] +-- +Use secure credentials. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-grpc_quarkus-grpc-clients-client-name-xds-target]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-xds-target[quarkus.grpc.clients."client-name".xds.target]` + + +[.description] +-- +Optional explicit target. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET+++` endif::add-copy-button-to-env-var[] --|string | @@ -71168,6 +73136,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-grpc_quarkus-grpc-clients-client-name-tls-configuration-name]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-tls-configuration-name[quarkus.grpc.clients."client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used. + +Important: This is only supported when using the Quarkus (Vert.x-based) gRPC client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-grpc_quarkus-grpc-clients-client-name-tls-enabled]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-tls-enabled[quarkus.grpc.clients."client-name".tls.enabled]` diff --git a/_generated-doc/latest/config/quarkus-container-image-container-image-config.adoc b/_generated-doc/latest/config/quarkus-container-image-container-image-config.adoc index d1fa8d89876..87a7c1fce70 100644 --- a/_generated-doc/latest/config/quarkus-container-image-container-image-config.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-container-image-config.adoc @@ -202,7 +202,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-container-image [.description] -- -The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present. +The name of the container image extension to use (e.g. docker, podman, jib, s2i). The option will be used in case multiple extensions are present. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CONTAINER_IMAGE_BUILDER+++[] diff --git a/_generated-doc/latest/config/quarkus-container-image-docker.adoc b/_generated-doc/latest/config/quarkus-container-image-docker.adoc index 14769d02763..57057c3f1a3 100644 --- a/_generated-doc/latest/config/quarkus-container-image-docker.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-docker.adoc @@ -15,8 +15,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++[] endif::add-copy-button-to-env-var[] @@ -24,7 +22,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++` endif::add-copy-button-to-env-var[] --|string -|`src/main/docker/Dockerfile.jvm` +| a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-dockerfile-native-path]]`link:#quarkus-container-image-docker_quarkus-docker-dockerfile-native-path[quarkus.docker.dockerfile-native-path]` @@ -32,8 +30,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++[] endif::add-copy-button-to-env-var[] @@ -41,7 +37,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++` endif::add-copy-button-to-env-var[] --|string -|`src/main/docker/Dockerfile.native` +| a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-cache-from]]`link:#quarkus-container-image-docker_quarkus-docker-cache-from[quarkus.docker.cache-from]` @@ -49,8 +45,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Images to consider as cache sources. Values are passed to `docker build` via the `cache-from` option - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_CACHE_FROM+++[] endif::add-copy-button-to-env-var[] @@ -66,8 +60,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -The networking mode for the RUN instructions during build - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_NETWORK+++[] endif::add-copy-button-to-env-var[] @@ -83,8 +75,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Name of binary used to execute the docker commands. This setting can override the global container runtime detection. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_EXECUTABLE_NAME+++[] endif::add-copy-button-to-env-var[] @@ -100,8 +90,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus- [.description] -- -Additional arbitrary arguments passed to the executable when building the container image. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[] endif::add-copy-button-to-env-var[] @@ -112,18 +100,16 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-build-args-arg-name]]`link:#quarkus-container-image-docker_quarkus-docker-build-args-arg-name[quarkus.docker.build-args."arg-name"]` +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-docker-build-args-build-args]]`link:#quarkus-container-image-docker_quarkus-docker-build-args-build-args[quarkus.docker.build-args."build-args"]` [.description] -- -Build args passed to docker via `--build-arg` - ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++` +Environment variable: `+++QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] diff --git a/_generated-doc/latest/config/quarkus-container-image-podman.adoc b/_generated-doc/latest/config/quarkus-container-image-podman.adoc new file mode 100644 index 00000000000..fa4318afa8e --- /dev/null +++ b/_generated-doc/latest/config/quarkus-container-image-podman.adoc @@ -0,0 +1,135 @@ + +:summaryTableId: quarkus-container-image-podman +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-container-image-podman_configuration]]link:#quarkus-container-image-podman_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-dockerfile-jvm-path]]`link:#quarkus-container-image-podman_quarkus-podman-dockerfile-jvm-path[quarkus.podman.dockerfile-jvm-path]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-dockerfile-native-path]]`link:#quarkus-container-image-podman_quarkus-podman-dockerfile-native-path[quarkus.podman.dockerfile-native-path]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-cache-from]]`link:#quarkus-container-image-podman_quarkus-podman-cache-from[quarkus.podman.cache-from]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_CACHE_FROM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_CACHE_FROM+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-network]]`link:#quarkus-container-image-podman_quarkus-podman-network[quarkus.podman.network]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_NETWORK+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_NETWORK+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-executable-name]]`link:#quarkus-container-image-podman_quarkus-podman-executable-name[quarkus.podman.executable-name]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_EXECUTABLE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_EXECUTABLE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-additional-args]]`link:#quarkus-container-image-podman_quarkus-podman-additional-args[quarkus.podman.additional-args]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-platform]]`link:#quarkus-container-image-podman_quarkus-podman-platform[quarkus.podman.platform]` + + +[.description] +-- +Which platform(s) to target during the build. See https://docs.podman.io/en/latest/markdown/podman-build.1.html++#++platform-os-arch-variant + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_PLATFORM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_PLATFORM+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-build-args-build-args]]`link:#quarkus-container-image-podman_quarkus-podman-build-args-build-args[quarkus.podman.build-args."build-args"]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image.adoc b/_generated-doc/latest/config/quarkus-container-image.adoc index ac638f61bf8..6871eea7dd3 100644 --- a/_generated-doc/latest/config/quarkus-container-image.adoc +++ b/_generated-doc/latest/config/quarkus-container-image.adoc @@ -202,7 +202,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image_quarkus-contain [.description] -- -The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present. +The name of the container image extension to use (e.g. docker, podman, jib, s2i). The option will be used in case multiple extensions are present. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CONTAINER_IMAGE_BUILDER+++[] diff --git a/_generated-doc/latest/config/quarkus-core.adoc b/_generated-doc/latest/config/quarkus-core.adoc index 280c6f11298..501bf83a257 100644 --- a/_generated-doc/latest/config/quarkus-core.adoc +++ b/_generated-doc/latest/config/quarkus-core.adoc @@ -938,7 +938,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-devservices-launch [.description] -- -Global flag that can be used to force the attachmment of Dev Services to shared netxork. Default is false. +Global flag that can be used to force the attachmment of Dev Services to shared network. Default is false. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DEVSERVICES_LAUNCH_ON_SHARED_NETWORK+++[] @@ -1927,6 +1927,25 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-agent-configuration-apply]]`link:#quarkus-core_quarkus-native-agent-configuration-apply[quarkus.native.agent-configuration-apply]` + + +[.description] +-- +Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process. + +Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-enabled]]`link:#quarkus-core_quarkus-package-jar-enabled[quarkus.package.jar.enabled]` @@ -3166,23 +3185,6 @@ endif::add-copy-button-to-env-var[] |`30S` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-tls-trust-all]]`link:#quarkus-core_quarkus-tls-trust-all[quarkus.tls.trust-all]` - - -[.description] --- -Enable trusting all certificates. Disable by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - h|[[quarkus-core_quarkus-index-dependency-index-dependency-artifacts-on-the-classpath-that-should-also-be-indexed]]link:#quarkus-core_quarkus-index-dependency-index-dependency-artifacts-on-the-classpath-that-should-also-be-indexed[Artifacts on the classpath that should also be indexed] h|Type diff --git a/_generated-doc/latest/config/quarkus-dev-ui-dev-ui-config.adoc b/_generated-doc/latest/config/quarkus-dev-ui-dev-ui-config.adoc index 7d5c49cd0d6..f57ec967c90 100644 --- a/_generated-doc/latest/config/quarkus-dev-ui-dev-ui-config.adoc +++ b/_generated-doc/latest/config/quarkus-dev-ui-dev-ui-config.adoc @@ -44,6 +44,23 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-dev-ui-dev-ui-config_quarkus-dev-ui-hosts]]`link:#quarkus-dev-ui-dev-ui-config_quarkus-dev-ui-hosts[quarkus.dev-ui.hosts]` + + +[.description] +-- +More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_HOSTS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-dev-ui-dev-ui-config_quarkus-dev-ui-cors-enabled]]`link:#quarkus-dev-ui-dev-ui-config_quarkus-dev-ui-cors-enabled[quarkus.dev-ui.cors.enabled]` diff --git a/_generated-doc/latest/config/quarkus-devservices-dev-devservices-global-dev-services-config.adoc b/_generated-doc/latest/config/quarkus-devservices-dev-devservices-global-dev-services-config.adoc index 12c31b3616d..1b8934708f6 100644 --- a/_generated-doc/latest/config/quarkus-devservices-dev-devservices-global-dev-services-config.adoc +++ b/_generated-doc/latest/config/quarkus-devservices-dev-devservices-global-dev-services-config.adoc @@ -32,7 +32,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-devservices-dev-devservices-glo [.description] -- -Global flag that can be used to force the attachmment of Dev Services to shared netxork. Default is false. +Global flag that can be used to force the attachmment of Dev Services to shared network. Default is false. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DEVSERVICES_LAUNCH_ON_SHARED_NETWORK+++[] diff --git a/_generated-doc/latest/config/quarkus-devui.adoc b/_generated-doc/latest/config/quarkus-devui.adoc index 1b6523684f5..4d2f41b203a 100644 --- a/_generated-doc/latest/config/quarkus-devui.adoc +++ b/_generated-doc/latest/config/quarkus-devui.adoc @@ -44,6 +44,23 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-devui_quarkus-dev-ui-hosts]]`link:#quarkus-devui_quarkus-dev-ui-hosts[quarkus.dev-ui.hosts]` + + +[.description] +-- +More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_HOSTS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-devui_quarkus-dev-ui-cors-enabled]]`link:#quarkus-devui_quarkus-dev-ui-cors-enabled[quarkus.dev-ui.cors.enabled]` diff --git a/_generated-doc/latest/config/quarkus-docker-docker-config.adoc b/_generated-doc/latest/config/quarkus-docker-docker-config.adoc index cfbe5d5d9a0..527b7af4316 100644 --- a/_generated-doc/latest/config/quarkus-docker-docker-config.adoc +++ b/_generated-doc/latest/config/quarkus-docker-docker-config.adoc @@ -15,8 +15,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-do [.description] -- -Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++[] endif::add-copy-button-to-env-var[] @@ -24,7 +22,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++` endif::add-copy-button-to-env-var[] --|string -|`src/main/docker/Dockerfile.jvm` +| a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-docker-dockerfile-native-path]]`link:#quarkus-docker-docker-config_quarkus-docker-dockerfile-native-path[quarkus.docker.dockerfile-native-path]` @@ -32,8 +30,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-do [.description] -- -Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++[] endif::add-copy-button-to-env-var[] @@ -41,7 +37,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++` endif::add-copy-button-to-env-var[] --|string -|`src/main/docker/Dockerfile.native` +| a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-docker-cache-from]]`link:#quarkus-docker-docker-config_quarkus-docker-cache-from[quarkus.docker.cache-from]` @@ -49,8 +45,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-do [.description] -- -Images to consider as cache sources. Values are passed to `docker build` via the `cache-from` option - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_CACHE_FROM+++[] endif::add-copy-button-to-env-var[] @@ -66,8 +60,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-do [.description] -- -The networking mode for the RUN instructions during build - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_NETWORK+++[] endif::add-copy-button-to-env-var[] @@ -83,8 +75,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-do [.description] -- -Name of binary used to execute the docker commands. This setting can override the global container runtime detection. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_EXECUTABLE_NAME+++[] endif::add-copy-button-to-env-var[] @@ -100,8 +90,6 @@ a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-do [.description] -- -Additional arbitrary arguments passed to the executable when building the container image. - ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[] endif::add-copy-button-to-env-var[] @@ -112,18 +100,16 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-docker-build-args-arg-name]]`link:#quarkus-docker-docker-config_quarkus-docker-build-args-arg-name[quarkus.docker.build-args."arg-name"]` +a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus-docker-build-args-build-args]]`link:#quarkus-docker-docker-config_quarkus-docker-build-args-build-args[quarkus.docker.build-args."build-args"]` [.description] -- -Build args passed to docker via `--build-arg` - ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++` +Environment variable: `+++QUARKUS_DOCKER_BUILD_ARGS__BUILD_ARGS_+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] diff --git a/_generated-doc/latest/config/quarkus-grpc-config-group-config-grpc-client-configuration.adoc b/_generated-doc/latest/config/quarkus-grpc-config-group-config-grpc-client-configuration.adoc index 97ff1b29d7b..94a7e27c354 100644 --- a/_generated-doc/latest/config/quarkus-grpc-config-group-config-grpc-client-configuration.adoc +++ b/_generated-doc/latest/config/quarkus-grpc-config-group-config-grpc-client-configuration.adoc @@ -299,6 +299,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-grpc-config-group-config-grpc-client-configuration_quarkus-grpc-clients-client-name-tls-configuration-name]]`link:#quarkus-grpc-config-group-config-grpc-client-configuration_quarkus-grpc-clients-client-name-tls-configuration-name[quarkus.grpc.clients."client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used. + +Important: This is only supported when using the Quarkus (Vert.x-based) gRPC client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-grpc-config-group-config-grpc-client-configuration_quarkus-grpc-clients-client-name-tls-enabled]]`link:#quarkus-grpc-config-group-config-grpc-client-configuration_quarkus-grpc-clients-client-name-tls-enabled[quarkus.grpc.clients."client-name".tls.enabled]` diff --git a/_generated-doc/latest/config/quarkus-grpc-config-grpc-configuration.adoc b/_generated-doc/latest/config/quarkus-grpc-config-grpc-configuration.adoc index c726db2e712..55bfa60a350 100644 --- a/_generated-doc/latest/config/quarkus-grpc-config-grpc-configuration.adoc +++ b/_generated-doc/latest/config/quarkus-grpc-config-grpc-configuration.adoc @@ -299,6 +299,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-grpc-config-grpc-configuration_quarkus-grpc-clients-client-name-tls-configuration-name]]`link:#quarkus-grpc-config-grpc-configuration_quarkus-grpc-clients-client-name-tls-configuration-name[quarkus.grpc.clients."client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used. + +Important: This is only supported when using the Quarkus (Vert.x-based) gRPC client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-grpc-config-grpc-configuration_quarkus-grpc-clients-client-name-tls-enabled]]`link:#quarkus-grpc-config-grpc-configuration_quarkus-grpc-clients-client-name-tls-enabled[quarkus.grpc.clients."client-name".tls.enabled]` diff --git a/_generated-doc/latest/config/quarkus-grpc-general-config-items.adoc b/_generated-doc/latest/config/quarkus-grpc-general-config-items.adoc index d1f359a2714..a15364c785b 100644 --- a/_generated-doc/latest/config/quarkus-grpc-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-grpc-general-config-items.adoc @@ -321,6 +321,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-grpc-general-config-items_quarkus-grpc-clients-client-name-tls-configuration-name]]`link:#quarkus-grpc-general-config-items_quarkus-grpc-clients-client-name-tls-configuration-name[quarkus.grpc.clients."client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used. + +Important: This is only supported when using the Quarkus (Vert.x-based) gRPC client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-grpc-general-config-items_quarkus-grpc-clients-client-name-tls-enabled]]`link:#quarkus-grpc-general-config-items_quarkus-grpc-clients-client-name-tls-enabled[quarkus.grpc.clients."client-name".tls.enabled]` diff --git a/_generated-doc/latest/config/quarkus-grpc.adoc b/_generated-doc/latest/config/quarkus-grpc.adoc index af6d8d22375..88265404ad6 100644 --- a/_generated-doc/latest/config/quarkus-grpc.adoc +++ b/_generated-doc/latest/config/quarkus-grpc.adoc @@ -414,6 +414,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-grpc_quarkus-grpc-clients-client-name-tls-configuration-name]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-tls-configuration-name[quarkus.grpc.clients."client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.grpc.clients.$client-name.tls` will be used. + +Important: This is only supported when using the Quarkus (Vert.x-based) gRPC client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-grpc_quarkus-grpc-clients-client-name-tls-enabled]]`link:#quarkus-grpc_quarkus-grpc-clients-client-name-tls-enabled[quarkus.grpc.clients."client-name".tls.enabled]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc index b8c998ab97b..b063044a18b 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc @@ -58,10 +58,10 @@ a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibe [.description] -- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. +Paths to files containing the SQL statements to execute when Hibernate ORM starts. -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). +The files are retrieved from the classpath resources, +so they must be located in the resources directory (e.g. `src/main/resources`). The default value for this setting differs depending on the Quarkus launch mode: @@ -98,7 +98,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] --|list of link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] -|`import.sql in DEV, TEST ; no-file otherwise` +|`import.sql in dev and test modes ; no-file otherwise` a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-physical-naming-strategy]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-physical-naming-strategy[quarkus.hibernate-orm.physical-naming-strategy]` @@ -277,25 +277,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-multitenant-schema-datasource]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm.multitenant-schema-datasource]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm."persistence-unit-name".multitenant-schema-datasource]` - - -[.description] --- -Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-validate-in-dev-mode]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm.validate-in-dev-mode]` `link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm."persistence-unit-name".validate-in-dev-mode]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log.adoc index f815ab86281..5617f90d387 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log.adoc @@ -50,6 +50,25 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` + +`link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` + + +[.description] +-- +Highlight the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` `link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit-hibernate-orm-config-persistence-unit-log_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit.adoc index 84a39aa9e83..2fac57509c2 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit.adoc @@ -282,6 +282,25 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` + +`link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` + + +[.description] +-- +Highlight the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` `link:#quarkus-hibernate-orm-config-group-hibernate-orm-runtime-config-persistence-unit_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm-general-config-items.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm-general-config-items.adoc index 362962de789..8517a73401f 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm-general-config-items.adoc @@ -92,10 +92,10 @@ a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-it [.description] -- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. +Paths to files containing the SQL statements to execute when Hibernate ORM starts. -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). +The files are retrieved from the classpath resources, +so they must be located in the resources directory (e.g. `src/main/resources`). The default value for this setting differs depending on the Quarkus launch mode: @@ -132,7 +132,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] --|list of link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] -|`import.sql in DEV, TEST ; no-file otherwise` +|`import.sql in dev and test modes ; no-file otherwise` a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-physical-naming-strategy]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-physical-naming-strategy[quarkus.hibernate-orm.physical-naming-strategy]` @@ -311,25 +311,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-multitenant-schema-datasource]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm.multitenant-schema-datasource]` - -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm."persistence-unit-name".multitenant-schema-datasource]` - - -[.description] --- -Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-validate-in-dev-mode]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm.validate-in-dev-mode]` `link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm."persistence-unit-name".validate-in-dev-mode]` @@ -1090,6 +1071,25 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` + + +[.description] +-- +Highlight the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` `link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-config.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-config.adoc index 39f95a26c27..07fe0c35b53 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-config.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-config.adoc @@ -147,10 +147,10 @@ a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-hibernate-orm-con [.description] -- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. +Paths to files containing the SQL statements to execute when Hibernate ORM starts. -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). +The files are retrieved from the classpath resources, +so they must be located in the resources directory (e.g. `src/main/resources`). The default value for this setting differs depending on the Quarkus launch mode: @@ -187,7 +187,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] --|list of link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] -|`import.sql in DEV, TEST ; no-file otherwise` +|`import.sql in dev and test modes ; no-file otherwise` a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-physical-naming-strategy]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-physical-naming-strategy[quarkus.hibernate-orm.physical-naming-strategy]` @@ -366,25 +366,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-multitenant-schema-datasource]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm.multitenant-schema-datasource]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm."persistence-unit-name".multitenant-schema-datasource]` - - -[.description] --- -Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-validate-in-dev-mode]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm.validate-in-dev-mode]` `link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm."persistence-unit-name".validate-in-dev-mode]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-runtime-config.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-runtime-config.adoc index b44dc9fae03..82cb4be8d5d 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm-hibernate-orm-runtime-config.adoc @@ -282,6 +282,25 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm-hibernate-orm-runtime-config_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-hibernate-orm-runtime-config_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` + +`link:#quarkus-hibernate-orm-hibernate-orm-runtime-config_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` + + +[.description] +-- +Highlight the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-hibernate-orm-hibernate-orm-runtime-config_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm-hibernate-orm-runtime-config_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` `link:#quarkus-hibernate-orm-hibernate-orm-runtime-config_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm.adoc index 9384d2868e5..87e821163b4 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm.adoc @@ -147,10 +147,10 @@ a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate [.description] -- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. +Paths to files containing the SQL statements to execute when Hibernate ORM starts. -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). +The files are retrieved from the classpath resources, +so they must be located in the resources directory (e.g. `src/main/resources`). The default value for this setting differs depending on the Quarkus launch mode: @@ -187,7 +187,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] --|list of link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] -|`import.sql in DEV, TEST ; no-file otherwise` +|`import.sql in dev and test modes ; no-file otherwise` a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-physical-naming-strategy]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-physical-naming-strategy[quarkus.hibernate-orm.physical-naming-strategy]` @@ -366,25 +366,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-multitenant-schema-datasource]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm.multitenant-schema-datasource]` - -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-multitenant-schema-datasource[quarkus.hibernate-orm."persistence-unit-name".multitenant-schema-datasource]` - - -[.description] --- -Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-validate-in-dev-mode]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm.validate-in-dev-mode]` `link:#quarkus-hibernate-orm_quarkus-hibernate-orm-validate-in-dev-mode[quarkus.hibernate-orm."persistence-unit-name".validate-in-dev-mode]` @@ -1145,6 +1126,25 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` + + +[.description] +-- +Highlight the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` `link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` diff --git a/_generated-doc/latest/config/quarkus-http-http-build-time-config.adoc b/_generated-doc/latest/config/quarkus-http-http-build-time-config.adoc index 91d7047568d..a649b1a4b00 100644 --- a/_generated-doc/latest/config/quarkus-http-http-build-time-config.adoc +++ b/_generated-doc/latest/config/quarkus-http-http-build-time-config.adoc @@ -217,6 +217,25 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_quarkus-http-compressors]]`link:#quarkus-http-http-build-time-config_quarkus-http-compressors[quarkus.http.compressors]` + + +[.description] +-- +If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project. + +Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_COMPRESSORS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`gzip,deflate` + + a|icon:lock[title=Fixed at build time] [[quarkus-http-http-build-time-config_quarkus-http-compress-media-types]]`link:#quarkus-http-http-build-time-config_quarkus-http-compress-media-types[quarkus.http.compress-media-types]` diff --git a/_generated-doc/latest/config/quarkus-http-http-configuration.adoc b/_generated-doc/latest/config/quarkus-http-http-configuration.adoc index 96777d3efe2..faeb2f11954 100644 --- a/_generated-doc/latest/config/quarkus-http-http-configuration.adoc +++ b/_generated-doc/latest/config/quarkus-http-http-configuration.adoc @@ -10,14 +10,36 @@ h|[[quarkus-http-http-configuration_configuration]]link:#quarkus-http-http-confi h|Type h|Default +a| [[quarkus-http-http-configuration_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-http-http-configuration_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]` + + +[.description] +-- +Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are: + + - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported. + - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name. + - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI). + - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++` +endif::add-copy-button-to-env-var[] +--|string +|`CN` + + a| [[quarkus-http-http-configuration_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-http-http-configuration_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]` [.description] -- -Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. +Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. -Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8. +Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[] @@ -979,6 +1001,27 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-http-http-configuration_quarkus-http-tls-configuration-name]]`link:#quarkus-http-http-configuration_quarkus-http-tls-configuration-name[quarkus.http.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.http.ssl` will be used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-http-http-configuration_quarkus-http-static-resources-index-page]]`link:#quarkus-http-http-configuration_quarkus-http-static-resources-index-page[quarkus.http.static-resources.index-page]` diff --git a/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration.adoc b/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration.adoc index 30a5ddeed39..4f2a8adc136 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration.adoc @@ -177,40 +177,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-devservices-tracing-enabled[quarkus.infinispan-client.devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-devservices-config-files]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-devservices-config-files[quarkus.infinispan-client.devservices.config-files]` @@ -413,40 +379,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config-dev-service-configuration_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name[quarkus.infinispan-client."named-infinispan-clients".devservices.container-env."environment-variable-name"]` diff --git a/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config.adoc b/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config.adoc index e9a264bacd5..68bded45b82 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client-config-group-infinispan-client-build-time-config.adoc @@ -194,40 +194,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-devservices-tracing-enabled[quarkus.infinispan-client.devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-devservices-config-files]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-devservices-config-files[quarkus.infinispan-client.devservices.config-files]` @@ -481,40 +447,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name]]`link:#quarkus-infinispan-client-config-group-infinispan-client-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name[quarkus.infinispan-client."named-infinispan-clients".devservices.container-env."environment-variable-name"]` diff --git a/_generated-doc/latest/config/quarkus-infinispan-client-general-config-items.adoc b/_generated-doc/latest/config/quarkus-infinispan-client-general-config-items.adoc index 3606278496c..704e163ad26 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client-general-config-items.adoc @@ -194,40 +194,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-devservices-tracing-enabled[quarkus.infinispan-client.devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-devservices-config-files]]`link:#quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-devservices-config-files[quarkus.infinispan-client.devservices.config-files]` @@ -787,40 +753,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name]]`link:#quarkus-infinispan-client-general-config-items_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name[quarkus.infinispan-client."named-infinispan-clients".devservices.container-env."environment-variable-name"]` diff --git a/_generated-doc/latest/config/quarkus-infinispan-client-infinispan-clients-build-time-config.adoc b/_generated-doc/latest/config/quarkus-infinispan-client-infinispan-clients-build-time-config.adoc index 9442361fa6d..79e48784095 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client-infinispan-clients-build-time-config.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client-infinispan-clients-build-time-config.adoc @@ -194,40 +194,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-devservices-tracing-enabled[quarkus.infinispan-client.devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-devservices-config-files]]`link:#quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-devservices-config-files[quarkus.infinispan-client.devservices.config-files]` @@ -500,40 +466,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled]]`link:#quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name]]`link:#quarkus-infinispan-client-infinispan-clients-build-time-config_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name[quarkus.infinispan-client."named-infinispan-clients".devservices.container-env."environment-variable-name"]` diff --git a/_generated-doc/latest/config/quarkus-infinispan-client.adoc b/_generated-doc/latest/config/quarkus-infinispan-client.adoc index 53a4322b8ba..fb84c3f10c0 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client.adoc @@ -194,40 +194,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-enabled]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-enabled[quarkus.infinispan-client.devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client.devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-devservices-config-files]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-devservices-config-files[quarkus.infinispan-client.devservices.config-files]` @@ -823,40 +789,6 @@ endif::add-copy-button-to-env-var[] | -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-enabled[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.enabled]` - - -[.description] --- -Runs the Infinispan Server container with tracing enabled. Traces are disabled by default - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-tracing-exporter-otlp-endpoint[quarkus.infinispan-client."named-infinispan-clients".devservices.tracing.exporter.otlp.endpoint]` - - -[.description] --- -Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INFINISPAN_CLIENT__NAMED_INFINISPAN_CLIENTS__DEVSERVICES_TRACING_EXPORTER_OTLP_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://localhost:4317` - - a|icon:lock[title=Fixed at build time] [[quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name]]`link:#quarkus-infinispan-client_quarkus-infinispan-client-named-infinispan-clients-devservices-container-env-environment-variable-name[quarkus.infinispan-client."named-infinispan-clients".devservices.container-env."environment-variable-name"]` diff --git a/_generated-doc/latest/config/quarkus-jfr-config-jfr-runtime-config.adoc b/_generated-doc/latest/config/quarkus-jfr-config-jfr-runtime-config.adoc new file mode 100644 index 00000000000..1a92ea90993 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-jfr-config-jfr-runtime-config.adoc @@ -0,0 +1,46 @@ + +:summaryTableId: quarkus-jfr-config-jfr-runtime-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-jfr-config-jfr-runtime-config_configuration]]link:#quarkus-jfr-config-jfr-runtime-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-jfr-config-jfr-runtime-config_quarkus-jfr-enabled]]`link:#quarkus-jfr-config-jfr-runtime-config_quarkus-jfr-enabled[quarkus.jfr.enabled]` + + +[.description] +-- +If false, only quarkus-jfr events are not recorded even if JFR is enabled. In this case, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JFR_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_JFR_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-jfr-config-jfr-runtime-config_quarkus-jfr-rest-enabled]]`link:#quarkus-jfr-config-jfr-runtime-config_quarkus-jfr-rest-enabled[quarkus.jfr.rest.enabled]` + + +[.description] +-- +If false, only REST events in quarkus-jfr are not recorded even if JFR is enabled. In this case, other quarkus-jfr, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JFR_REST_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_JFR_REST_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jfr.adoc b/_generated-doc/latest/config/quarkus-jfr.adoc new file mode 100644 index 00000000000..46754a1fd96 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-jfr.adoc @@ -0,0 +1,46 @@ + +:summaryTableId: quarkus-jfr +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-jfr_configuration]]link:#quarkus-jfr_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-jfr_quarkus-jfr-enabled]]`link:#quarkus-jfr_quarkus-jfr-enabled[quarkus.jfr.enabled]` + + +[.description] +-- +If false, only quarkus-jfr events are not recorded even if JFR is enabled. In this case, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JFR_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_JFR_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-jfr_quarkus-jfr-rest-enabled]]`link:#quarkus-jfr_quarkus-jfr-rest-enabled[quarkus.jfr.rest.enabled]` + + +[.description] +-- +If false, only REST events in quarkus-jfr are not recorded even if JFR is enabled. In this case, other quarkus-jfr, Java standard API and virtual machine information will be recorded according to the setting. Default value is `true` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JFR_REST_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_JFR_REST_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-keycloak-devservices-keycloak-keycloak-build-time-config.adoc b/_generated-doc/latest/config/quarkus-keycloak-devservices-keycloak-keycloak-build-time-config.adoc index 51ff10aa3a7..ba7e0dce65d 100644 --- a/_generated-doc/latest/config/quarkus-keycloak-devservices-keycloak-keycloak-build-time-config.adoc +++ b/_generated-doc/latest/config/quarkus-keycloak-devservices-keycloak-keycloak-build-time-config.adoc @@ -41,7 +41,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] --|string -|`quay.io/keycloak/keycloak:23.0.7` +|`quay.io/keycloak/keycloak:24.0.4` a|icon:lock[title=Fixed at build time] [[quarkus-keycloak-devservices-keycloak-keycloak-build-time-config_quarkus-keycloak-devservices-keycloak-x-image]]`link:#quarkus-keycloak-devservices-keycloak-keycloak-build-time-config_quarkus-keycloak-devservices-keycloak-x-image[quarkus.keycloak.devservices.keycloak-x-image]` diff --git a/_generated-doc/latest/config/quarkus-kotlin-serialization-kotlin-serialization-config.adoc b/_generated-doc/latest/config/quarkus-kotlin-serialization-kotlin-serialization-config.adoc index 3786b307aa5..f61c7b07cad 100644 --- a/_generated-doc/latest/config/quarkus-kotlin-serialization-kotlin-serialization-config.adoc +++ b/_generated-doc/latest/config/quarkus-kotlin-serialization-kotlin-serialization-config.adoc @@ -283,4 +283,21 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-kotlin-serialization-kotlin-serialization-config_quarkus-kotlin-serialization-json-allow-comments]]`link:#quarkus-kotlin-serialization-kotlin-serialization-config_quarkus-kotlin-serialization-json-allow-comments[quarkus.kotlin-serialization.json.allow-comments]` + + +[.description] +-- +Allows parser to accept C/Java-style comments in JSON input. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + |=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding.adoc b/_generated-doc/latest/config/quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding.adoc new file mode 100644 index 00000000000..2ad26abb18a --- /dev/null +++ b/_generated-doc/latest/config/quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding_configuration]]link:#quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding_quarkus-load-shedding-priority-enabled]]`link:#quarkus-load-shedding-config-group-load-shedding-runtime-config-priority-load-shedding_quarkus-load-shedding-priority-enabled[quarkus.load-shedding.priority.enabled]` + + +[.description] +-- +Whether priority load shedding should be enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-load-shedding-general-config-items.adoc b/_generated-doc/latest/config/quarkus-load-shedding-general-config-items.adoc new file mode 100644 index 00000000000..e0b303050c3 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-load-shedding-general-config-items.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-load-shedding-general-config-items +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-load-shedding-general-config-items_configuration]]link:#quarkus-load-shedding-general-config-items_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-load-shedding-general-config-items_quarkus-load-shedding-priority-enabled]]`link:#quarkus-load-shedding-general-config-items_quarkus-load-shedding-priority-enabled[quarkus.load-shedding.priority.enabled]` + + +[.description] +-- +Whether priority load shedding should be enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-load-shedding-load-shedding-runtime-config.adoc b/_generated-doc/latest/config/quarkus-load-shedding-load-shedding-runtime-config.adoc new file mode 100644 index 00000000000..73e0842590b --- /dev/null +++ b/_generated-doc/latest/config/quarkus-load-shedding-load-shedding-runtime-config.adoc @@ -0,0 +1,131 @@ + +:summaryTableId: quarkus-load-shedding-load-shedding-runtime-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-load-shedding-load-shedding-runtime-config_configuration]]link:#quarkus-load-shedding-load-shedding-runtime-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-enabled]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-enabled[quarkus.load-shedding.enabled]` + + +[.description] +-- +Whether load shedding should be enabled. Currently, this only applies to incoming HTTP requests. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-max-limit]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-max-limit[quarkus.load-shedding.max-limit]` + + +[.description] +-- +The maximum number of concurrent requests allowed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_MAX_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_MAX_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-alpha-factor]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-alpha-factor[quarkus.load-shedding.alpha-factor]` + + +[.description] +-- +The `alpha` factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|int +|`3` + + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-beta-factor]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-beta-factor[quarkus.load-shedding.beta-factor]` + + +[.description] +-- +The `beta` factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_BETA_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_BETA_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|int +|`6` + + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-probe-factor]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-probe-factor[quarkus.load-shedding.probe-factor]` + + +[.description] +-- +The probe factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PROBE_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PROBE_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|double +|`30.0` + + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-initial-limit]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-initial-limit[quarkus.load-shedding.initial-limit]` + + +[.description] +-- +The initial limit of concurrent requests allowed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +a| [[quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-priority-enabled]]`link:#quarkus-load-shedding-load-shedding-runtime-config_quarkus-load-shedding-priority-enabled[quarkus.load-shedding.priority.enabled]` + + +[.description] +-- +Whether priority load shedding should be enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-load-shedding.adoc b/_generated-doc/latest/config/quarkus-load-shedding.adoc new file mode 100644 index 00000000000..aa8c5de6fc4 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-load-shedding.adoc @@ -0,0 +1,131 @@ + +:summaryTableId: quarkus-load-shedding +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-load-shedding_configuration]]link:#quarkus-load-shedding_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-load-shedding_quarkus-load-shedding-enabled]]`link:#quarkus-load-shedding_quarkus-load-shedding-enabled[quarkus.load-shedding.enabled]` + + +[.description] +-- +Whether load shedding should be enabled. Currently, this only applies to incoming HTTP requests. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-max-limit]]`link:#quarkus-load-shedding_quarkus-load-shedding-max-limit[quarkus.load-shedding.max-limit]` + + +[.description] +-- +The maximum number of concurrent requests allowed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_MAX_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_MAX_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-alpha-factor]]`link:#quarkus-load-shedding_quarkus-load-shedding-alpha-factor[quarkus.load-shedding.alpha-factor]` + + +[.description] +-- +The `alpha` factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|int +|`3` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-beta-factor]]`link:#quarkus-load-shedding_quarkus-load-shedding-beta-factor[quarkus.load-shedding.beta-factor]` + + +[.description] +-- +The `beta` factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_BETA_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_BETA_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|int +|`6` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-probe-factor]]`link:#quarkus-load-shedding_quarkus-load-shedding-probe-factor[quarkus.load-shedding.probe-factor]` + + +[.description] +-- +The probe factor of the Vegas overload detection algorithm. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PROBE_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PROBE_FACTOR+++` +endif::add-copy-button-to-env-var[] +--|double +|`30.0` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-initial-limit]]`link:#quarkus-load-shedding_quarkus-load-shedding-initial-limit[quarkus.load-shedding.initial-limit]` + + +[.description] +-- +The initial limit of concurrent requests allowed. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +a| [[quarkus-load-shedding_quarkus-load-shedding-priority-enabled]]`link:#quarkus-load-shedding_quarkus-load-shedding-priority-enabled[quarkus.load-shedding.priority.enabled]` + + +[.description] +-- +Whether priority load shedding should be enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-lra-lra-build-time-configuration.adoc b/_generated-doc/latest/config/quarkus-lra-lra-build-time-configuration.adoc new file mode 100644 index 00000000000..7518473e023 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-lra-lra-build-time-configuration.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-lra-lra-build-time-configuration +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-lra-lra-build-time-configuration_configuration]]link:#quarkus-lra-lra-build-time-configuration_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-lra-lra-build-time-configuration_quarkus-lra-openapi-included]]`link:#quarkus-lra-lra-build-time-configuration_quarkus-lra-openapi-included[quarkus.lra.openapi.included]` + + +[.description] +-- +Whether to include LRA proxy endpoints in the generated OpenAPI document + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LRA_OPENAPI_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LRA_OPENAPI_INCLUDED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mailer-config-group-mailer-runtime-config.adoc b/_generated-doc/latest/config/quarkus-mailer-config-group-mailer-runtime-config.adoc index 1d696711970..cbd26de8bdd 100644 --- a/_generated-doc/latest/config/quarkus-mailer-config-group-mailer-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-mailer-config-group-mailer-runtime-config.adoc @@ -85,7 +85,9 @@ a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-port]]`lin [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_PORT+++[] @@ -131,35 +133,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-ssl]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-ssl[quarkus.mailer.ssl]` +a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-tls-configuration-name]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-tls-configuration-name[quarkus.mailer.tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_SSL+++` +Environment variable: `+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-trust-all]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-trust-all[quarkus.mailer.trust-all]` +a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-tls]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-tls[quarkus.mailer.tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER_TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -221,7 +231,9 @@ a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-disable-es [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_DISABLE_ESMTP+++[] @@ -483,7 +495,9 @@ a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-auth-metho [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_AUTH_METHODS+++[] @@ -495,59 +509,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-truststore-password]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-truststore-password[quarkus.mailer.truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-truststore-paths]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-truststore-paths[quarkus.mailer.truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-truststore-type]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-truststore-type[quarkus.mailer.truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-multi-part-only]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-multi-part-only[quarkus.mailer.multi-part-only]` @@ -788,7 +749,9 @@ a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-nam [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__PORT+++[] @@ -834,35 +797,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-ssl]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-ssl[quarkus.mailer."mailer-name".ssl]` +a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-tls-configuration-name]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-tls-configuration-name[quarkus.mailer."mailer-name".tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__SSL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-trust-all]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-trust-all[quarkus.mailer."mailer-name".trust-all]` +a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-tls]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-tls[quarkus.mailer."mailer-name".tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -924,7 +895,9 @@ a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-nam [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP+++[] @@ -1186,7 +1159,9 @@ a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-nam [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS+++[] @@ -1198,59 +1173,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-truststore-password]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-truststore-password[quarkus.mailer."mailer-name".truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-truststore-paths]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-truststore-paths[quarkus.mailer."mailer-name".truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-truststore-type]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-truststore-type[quarkus.mailer."mailer-name".truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-multi-part-only]]`link:#quarkus-mailer-config-group-mailer-runtime-config_quarkus-mailer-mailer-name-multi-part-only[quarkus.mailer."mailer-name".multi-part-only]` diff --git a/_generated-doc/latest/config/quarkus-mailer-config-group-trust-store-config.adoc b/_generated-doc/latest/config/quarkus-mailer-config-group-trust-store-config.adoc deleted file mode 100644 index b27aeb85d4b..00000000000 --- a/_generated-doc/latest/config/quarkus-mailer-config-group-trust-store-config.adoc +++ /dev/null @@ -1,118 +0,0 @@ - -:summaryTableId: quarkus-mailer-config-group-trust-store-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-mailer-config-group-trust-store-config_configuration]]link:#quarkus-mailer-config-group-trust-store-config_configuration[Configuration property] - -h|Type -h|Default - -a| [[quarkus-mailer-config-group-trust-store-config_quarkus-mailer-truststore-password]]`link:#quarkus-mailer-config-group-trust-store-config_quarkus-mailer-truststore-password[quarkus.mailer.truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-config-group-trust-store-config_quarkus-mailer-truststore-paths]]`link:#quarkus-mailer-config-group-trust-store-config_quarkus-mailer-truststore-paths[quarkus.mailer.truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-config-group-trust-store-config_quarkus-mailer-truststore-type]]`link:#quarkus-mailer-config-group-trust-store-config_quarkus-mailer-truststore-type[quarkus.mailer.truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-config-group-trust-store-config_quarkus-mailer-mailer-name-truststore-password]]`link:#quarkus-mailer-config-group-trust-store-config_quarkus-mailer-mailer-name-truststore-password[quarkus.mailer."mailer-name".truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-config-group-trust-store-config_quarkus-mailer-mailer-name-truststore-paths]]`link:#quarkus-mailer-config-group-trust-store-config_quarkus-mailer-mailer-name-truststore-paths[quarkus.mailer."mailer-name".truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-config-group-trust-store-config_quarkus-mailer-mailer-name-truststore-type]]`link:#quarkus-mailer-config-group-trust-store-config_quarkus-mailer-mailer-name-truststore-type[quarkus.mailer."mailer-name".truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - -|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mailer-general-config-items.adoc b/_generated-doc/latest/config/quarkus-mailer-general-config-items.adoc index e6b1d34c9c7..8c39ca54fed 100644 --- a/_generated-doc/latest/config/quarkus-mailer-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-mailer-general-config-items.adoc @@ -85,7 +85,9 @@ a| [[quarkus-mailer-general-config-items_quarkus-mailer-port]]`link:#quarkus-mai [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_PORT+++[] @@ -131,35 +133,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-general-config-items_quarkus-mailer-ssl]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-ssl[quarkus.mailer.ssl]` +a| [[quarkus-mailer-general-config-items_quarkus-mailer-tls-configuration-name]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-tls-configuration-name[quarkus.mailer.tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_SSL+++` +Environment variable: `+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer-general-config-items_quarkus-mailer-trust-all]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-trust-all[quarkus.mailer.trust-all]` +a| [[quarkus-mailer-general-config-items_quarkus-mailer-tls]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-tls[quarkus.mailer.tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER_TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -221,7 +231,9 @@ a| [[quarkus-mailer-general-config-items_quarkus-mailer-disable-esmtp]]`link:#qu [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_DISABLE_ESMTP+++[] @@ -483,7 +495,9 @@ a| [[quarkus-mailer-general-config-items_quarkus-mailer-auth-methods]]`link:#qua [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_AUTH_METHODS+++[] @@ -495,59 +509,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-general-config-items_quarkus-mailer-truststore-password]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-truststore-password[quarkus.mailer.truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-general-config-items_quarkus-mailer-truststore-paths]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-truststore-paths[quarkus.mailer.truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-general-config-items_quarkus-mailer-truststore-type]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-truststore-type[quarkus.mailer.truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer-general-config-items_quarkus-mailer-multi-part-only]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-multi-part-only[quarkus.mailer.multi-part-only]` @@ -788,7 +749,9 @@ a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-port]]`link: [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__PORT+++[] @@ -834,35 +797,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-ssl]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-ssl[quarkus.mailer."mailer-name".ssl]` +a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-tls-configuration-name]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-tls-configuration-name[quarkus.mailer."mailer-name".tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__SSL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-trust-all]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-trust-all[quarkus.mailer."mailer-name".trust-all]` +a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-tls]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-tls[quarkus.mailer."mailer-name".tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -924,7 +895,9 @@ a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-disable-esmt [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP+++[] @@ -1186,7 +1159,9 @@ a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-auth-methods [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS+++[] @@ -1198,59 +1173,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-truststore-password]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-truststore-password[quarkus.mailer."mailer-name".truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-truststore-paths]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-truststore-paths[quarkus.mailer."mailer-name".truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-truststore-type]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-truststore-type[quarkus.mailer."mailer-name".truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-multi-part-only]]`link:#quarkus-mailer-general-config-items_quarkus-mailer-mailer-name-multi-part-only[quarkus.mailer."mailer-name".multi-part-only]` diff --git a/_generated-doc/latest/config/quarkus-mailer-mailers-runtime-config.adoc b/_generated-doc/latest/config/quarkus-mailer-mailers-runtime-config.adoc index 53279378a47..4d9bdf5e150 100644 --- a/_generated-doc/latest/config/quarkus-mailer-mailers-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-mailer-mailers-runtime-config.adoc @@ -85,7 +85,9 @@ a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-port]]`link:#quarkus-m [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_PORT+++[] @@ -131,35 +133,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-ssl]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-ssl[quarkus.mailer.ssl]` +a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-tls-configuration-name]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-tls-configuration-name[quarkus.mailer.tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_SSL+++` +Environment variable: `+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-trust-all]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-trust-all[quarkus.mailer.trust-all]` +a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-tls]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-tls[quarkus.mailer.tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER_TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -221,7 +231,9 @@ a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-disable-esmtp]]`link:# [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_DISABLE_ESMTP+++[] @@ -483,7 +495,9 @@ a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-auth-methods]]`link:#q [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_AUTH_METHODS+++[] @@ -495,59 +509,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-truststore-password]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-truststore-password[quarkus.mailer.truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-truststore-paths]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-truststore-paths[quarkus.mailer.truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-truststore-type]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-truststore-type[quarkus.mailer.truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-multi-part-only]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-multi-part-only[quarkus.mailer.multi-part-only]` @@ -788,7 +749,9 @@ a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-port]]`lin [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__PORT+++[] @@ -834,35 +797,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-ssl]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-ssl[quarkus.mailer."mailer-name".ssl]` +a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-tls-configuration-name]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-tls-configuration-name[quarkus.mailer."mailer-name".tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__SSL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-trust-all]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-trust-all[quarkus.mailer."mailer-name".trust-all]` +a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-tls]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-tls[quarkus.mailer."mailer-name".tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -924,7 +895,9 @@ a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-disable-es [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP+++[] @@ -1186,7 +1159,9 @@ a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-auth-metho [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS+++[] @@ -1198,59 +1173,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-truststore-password]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-truststore-password[quarkus.mailer."mailer-name".truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-truststore-paths]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-truststore-paths[quarkus.mailer."mailer-name".truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-truststore-type]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-truststore-type[quarkus.mailer."mailer-name".truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-multi-part-only]]`link:#quarkus-mailer-mailers-runtime-config_quarkus-mailer-mailer-name-multi-part-only[quarkus.mailer."mailer-name".multi-part-only]` diff --git a/_generated-doc/latest/config/quarkus-mailer.adoc b/_generated-doc/latest/config/quarkus-mailer.adoc index a91ab004a20..4344b787334 100644 --- a/_generated-doc/latest/config/quarkus-mailer.adoc +++ b/_generated-doc/latest/config/quarkus-mailer.adoc @@ -102,7 +102,9 @@ a| [[quarkus-mailer_quarkus-mailer-port]]`link:#quarkus-mailer_quarkus-mailer-po [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_PORT+++[] @@ -148,35 +150,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-ssl]]`link:#quarkus-mailer_quarkus-mailer-ssl[quarkus.mailer.ssl]` +a| [[quarkus-mailer_quarkus-mailer-tls-configuration-name]]`link:#quarkus-mailer_quarkus-mailer-tls-configuration-name[quarkus.mailer.tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_SSL+++` +Environment variable: `+++QUARKUS_MAILER_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer_quarkus-mailer-trust-all]]`link:#quarkus-mailer_quarkus-mailer-trust-all[quarkus.mailer.trust-all]` +a| [[quarkus-mailer_quarkus-mailer-tls]]`link:#quarkus-mailer_quarkus-mailer-tls[quarkus.mailer.tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER_TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -238,7 +248,9 @@ a| [[quarkus-mailer_quarkus-mailer-disable-esmtp]]`link:#quarkus-mailer_quarkus- [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_DISABLE_ESMTP+++[] @@ -500,7 +512,9 @@ a| [[quarkus-mailer_quarkus-mailer-auth-methods]]`link:#quarkus-mailer_quarkus-m [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_AUTH_METHODS+++[] @@ -512,59 +526,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-truststore-password]]`link:#quarkus-mailer_quarkus-mailer-truststore-password[quarkus.mailer.truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer_quarkus-mailer-truststore-paths]]`link:#quarkus-mailer_quarkus-mailer-truststore-paths[quarkus.mailer.truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer_quarkus-mailer-truststore-type]]`link:#quarkus-mailer_quarkus-mailer-truststore-type[quarkus.mailer.truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER_TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer_quarkus-mailer-multi-part-only]]`link:#quarkus-mailer_quarkus-mailer-multi-part-only[quarkus.mailer.multi-part-only]` @@ -805,7 +766,9 @@ a| [[quarkus-mailer_quarkus-mailer-mailer-name-port]]`link:#quarkus-mailer_quark [.description] -- -The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. +The SMTP port. The default value depends on the configuration. The port 25 is used as default when `ssl` is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when `ssl` is enabled. It ensures that email is submitted securely. + +Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__PORT+++[] @@ -851,35 +814,43 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-mailer-name-ssl]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-ssl[quarkus.mailer."mailer-name".ssl]` +a| [[quarkus-mailer_quarkus-mailer-mailer-name-tls-configuration-name]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-tls-configuration-name[quarkus.mailer."mailer-name".tls-configuration-name]` [.description] -- -Enables or disables the TLS/SSL. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, the specific TLS configuration (from `quarkus.mailer.++*++`) will be used. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__SSL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__SSL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-mailer_quarkus-mailer-mailer-name-trust-all]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-trust-all[quarkus.mailer."mailer-name".trust-all]` +a| [[quarkus-mailer_quarkus-mailer-mailer-name-tls]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-tls[quarkus.mailer."mailer-name".tls]` [.description] -- -Set whether all server certificates should be trusted. This option is only used when `ssl` is enabled. +Whether the connection should be secured using TLS. + +SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to `false` and `start-tls` to `REQUIRED` Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to `false` is required to not establish a connection with TLS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUST_ALL+++` +Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TLS+++` endif::add-copy-button-to-env-var[] --|boolean | @@ -941,7 +912,9 @@ a| [[quarkus-mailer_quarkus-mailer-mailer-name-disable-esmtp]]`link:#quarkus-mai [.description] -- -Disable ESMTP. 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. +Disable ESMTP. + +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. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP+++[] @@ -1203,7 +1176,9 @@ a| [[quarkus-mailer_quarkus-mailer-mailer-name-auth-methods]]`link:#quarkus-mail [.description] -- -Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. +Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used. + +The list is given as a space separated list, such as `DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS+++[] @@ -1215,59 +1190,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-mailer_quarkus-mailer-mailer-name-truststore-password]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-truststore-password[quarkus.mailer."mailer-name".truststore.password]` - - -[.description] --- -Sets the trust store password if any. Note that the password is only used for JKS and PCK++#++12 trust stores. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-mailer_quarkus-mailer-mailer-name-truststore-paths]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-truststore-paths[quarkus.mailer."mailer-name".truststore.paths]` - - -[.description] --- -Sets the location of the trust store files. If you use JKS or PCK++#++12, only one path is allowed. If you use PEM files, you can specify multiple paths. - -The relative paths are relative to the application working directly. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_PATHS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-mailer_quarkus-mailer-mailer-name-truststore-type]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-truststore-type[quarkus.mailer."mailer-name".truststore.type]` - - -[.description] --- -Sets the trust store type. By default, it guesses the type from the file name extension. For instance, `truststore.pem` will be seen as a PEM file, while `truststore.jks` will be seen as a JKS file. `truststore.p12` and `truststore.pfx` will both be seen as PKCS++#++12 files. Accepted values are: `JKS`, `PEM`, `PKCS`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__TRUSTSTORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-mailer_quarkus-mailer-mailer-name-multi-part-only]]`link:#quarkus-mailer_quarkus-mailer-mailer-name-multi-part-only[quarkus.mailer."mailer-name".multi-part-only]` diff --git a/_generated-doc/latest/config/quarkus-management-management-management-interface-configuration.adoc b/_generated-doc/latest/config/quarkus-management-management-management-interface-configuration.adoc index faeb77b7df0..bda922e7a59 100644 --- a/_generated-doc/latest/config/quarkus-management-management-management-interface-configuration.adoc +++ b/_generated-doc/latest/config/quarkus-management-management-management-interface-configuration.adoc @@ -49,7 +49,11 @@ a| [[quarkus-management-management-management-interface-configuration_quarkus-ma [.description] -- -The HTTP host Defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. +The HTTP host + +Defaults to 0.0.0.0 + +Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_HOST+++[] @@ -486,6 +490,27 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-management-management-management-interface-configuration_quarkus-management-tls-configuration-name]]`link:#quarkus-management-management-management-interface-configuration_quarkus-management-tls-configuration-name[quarkus.management.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.management.ssl` will be used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-management-management-management-interface-configuration_quarkus-management-handle-100-continue-automatically]]`link:#quarkus-management-management-management-interface-configuration_quarkus-management-handle-100-continue-automatically[quarkus.management.handle-100-continue-automatically]` diff --git a/_generated-doc/latest/config/quarkus-maven-plugin-goals.adoc b/_generated-doc/latest/config/quarkus-maven-plugin-goals.adoc index bfc007d20da..d0f584865aa 100644 --- a/_generated-doc/latest/config/quarkus-maven-plugin-goals.adoc +++ b/_generated-doc/latest/config/quarkus-maven-plugin-goals.adoc @@ -3083,6 +3083,159 @@ a| [[quarkus-maven-plugin-goal-list-platforms-repos]]`link:#quarkus-maven-plugin a| [[quarkus-maven-plugin-goal-list-platforms-session]]`link:#quarkus-maven-plugin-goal-list-platforms-session[session]` +[.description] +-- + +--|MavenSession +|`${session}` + +|=== += quarkus:native-image-agent + +Post-processes native image agent generated configuration to trim any unnecessary configuration. + +:summaryTableId: quarkus-maven-plugin-goals +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-maven-plugin-goal-native-image-agent-parameter-parameter]]link:#quarkus-maven-plugin-goal-native-image-agent-parameter-parameter[Parameter] + +h|Type +h|Default + +a| [[quarkus-maven-plugin-goal-native-image-agent-appartifact]]`link:#quarkus-maven-plugin-goal-native-image-agent-appartifact[appArtifact]` + + +[.description] +-- +Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type. +--|String +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-bootstrapid]]`link:#quarkus-maven-plugin-goal-native-image-agent-bootstrapid[bootstrapId]` + + +[.description] +-- +Application bootstrap provider ID. This parameter is not supposed to be configured by the user. To be able to re-use an application bootstrapped in one phase in a later phase, there needs to be a way to identify the correct instance of the bootstrapped application (in case there are more than one) in each Mojo. A bootstrap ID serves this purpose. This parameter is is set in DevMojo invoking generate-code and generate-code-tests goals. If this parameter is not configured, a Mojo execution ID will be used as the bootstrap ID. +--|String +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-builddir]]`link:#quarkus-maven-plugin-goal-native-image-agent-builddir[buildDir]` + + +[.description] +-- + +--|File +|`${project.build.directory}` + + +a| [[quarkus-maven-plugin-goal-native-image-agent-quarkusclosebootstrappedapp]]`link:#quarkus-maven-plugin-goal-native-image-agent-quarkusclosebootstrappedapp[quarkusCloseBootstrappedApp]` + + +[.description] +-- +Whether to close the bootstrapped applications after the execution +--|boolean +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-finalname]]`link:#quarkus-maven-plugin-goal-native-image-agent-finalname[finalName]` + + +[.description] +-- + +--|String +|`${project.build.finalName}` + + +a| [[quarkus-maven-plugin-goal-native-image-agent-ignoredentries]]`link:#quarkus-maven-plugin-goal-native-image-agent-ignoredentries[ignoredEntries]` + + +[.description] +-- +When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA +--|java.lang.String[] +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-manifestentries]]`link:#quarkus-maven-plugin-goal-native-image-agent-manifestentries[manifestEntries]` + + +[.description] +-- +The list of main manifest attributes +--|Map +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-manifestsections]]`link:#quarkus-maven-plugin-goal-native-image-agent-manifestsections[manifestSections]` + + +[.description] +-- +The list of manifest sections +--|List +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-mojoexecution]]`link:#quarkus-maven-plugin-goal-native-image-agent-mojoexecution[mojoExecution]` + + +[.description] +-- +The context of the execution of the plugin. +--|MojoExecution +|`${mojoExecution}` + + +a| [[quarkus-maven-plugin-goal-native-image-agent-project]]`link:#quarkus-maven-plugin-goal-native-image-agent-project[project]` + + +[.description] +-- + +--|MavenProject +|`${project}` + + +a| [[quarkus-maven-plugin-goal-native-image-agent-properties]]`link:#quarkus-maven-plugin-goal-native-image-agent-properties[properties]` + + +[.description] +-- +The properties of the plugin. +--|Map +| + + +a| [[quarkus-maven-plugin-goal-native-image-agent-reposession]]`link:#quarkus-maven-plugin-goal-native-image-agent-reposession[repoSession]` + + +[.description] +-- +The current repository/network configuration of Maven. +--|RepositorySystemSession +|`${repositorySystemSession}` + + +a| [[quarkus-maven-plugin-goal-native-image-agent-repos]]`link:#quarkus-maven-plugin-goal-native-image-agent-repos[repos]` + + +[.description] +-- +The project's remote repositories to use for the resolution of artifacts and their dependencies. +--|List +|`${project.remoteProjectRepositories}` + + +a| [[quarkus-maven-plugin-goal-native-image-agent-session]]`link:#quarkus-maven-plugin-goal-native-image-agent-session[session]` + + [.description] -- diff --git a/_generated-doc/latest/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc b/_generated-doc/latest/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc index 637c577fcd5..e43e5946a9e 100644 --- a/_generated-doc/latest/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc @@ -15,7 +15,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-config-group-dev-servic [.description] -- -If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_ENABLED+++[] @@ -63,6 +65,44 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-config-group-dev-services-build-time-config_quarkus-mongodb-devservices-shared]]`link:#quarkus-mongodb-config-group-dev-services-build-time-config_quarkus-mongodb-devservices-shared[quarkus.mongodb.devservices.shared]` + + +[.description] +-- +Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container. + +The discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-config-group-dev-services-build-time-config_quarkus-mongodb-devservices-service-name]]`link:#quarkus-mongodb-config-group-dev-services-build-time-config_quarkus-mongodb-devservices-service-name[quarkus.mongodb.devservices.service-name]` + + +[.description] +-- +The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`mongodb` + + a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-config-group-dev-services-build-time-config_quarkus-mongodb-devservices-properties-property-key]]`link:#quarkus-mongodb-config-group-dev-services-build-time-config_quarkus-mongodb-devservices-properties-property-key[quarkus.mongodb.devservices.properties."property-key"]` diff --git a/_generated-doc/latest/config/quarkus-mongodb-general-config-items.adoc b/_generated-doc/latest/config/quarkus-mongodb-general-config-items.adoc index 1785df2002d..13586b03168 100644 --- a/_generated-doc/latest/config/quarkus-mongodb-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb-general-config-items.adoc @@ -15,7 +15,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-general-config-items_qu [.description] -- -If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_ENABLED+++[] @@ -63,6 +65,44 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-general-config-items_quarkus-mongodb-devservices-shared]]`link:#quarkus-mongodb-general-config-items_quarkus-mongodb-devservices-shared[quarkus.mongodb.devservices.shared]` + + +[.description] +-- +Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container. + +The discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-general-config-items_quarkus-mongodb-devservices-service-name]]`link:#quarkus-mongodb-general-config-items_quarkus-mongodb-devservices-service-name[quarkus.mongodb.devservices.service-name]` + + +[.description] +-- +The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`mongodb` + + a| [[quarkus-mongodb-general-config-items_quarkus-mongodb-connection-string]]`link:#quarkus-mongodb-general-config-items_quarkus-mongodb-connection-string[quarkus.mongodb.connection-string]` diff --git a/_generated-doc/latest/config/quarkus-mongodb-mongo-client-build-time-config.adoc b/_generated-doc/latest/config/quarkus-mongodb-mongo-client-build-time-config.adoc index e3c283d603e..c41462ca54c 100644 --- a/_generated-doc/latest/config/quarkus-mongodb-mongo-client-build-time-config.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb-mongo-client-build-time-config.adoc @@ -83,7 +83,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-mongo-client-build-time [.description] -- -If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_ENABLED+++[] @@ -131,6 +133,44 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-mongo-client-build-time-config_quarkus-mongodb-devservices-shared]]`link:#quarkus-mongodb-mongo-client-build-time-config_quarkus-mongodb-devservices-shared[quarkus.mongodb.devservices.shared]` + + +[.description] +-- +Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container. + +The discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-mongo-client-build-time-config_quarkus-mongodb-devservices-service-name]]`link:#quarkus-mongodb-mongo-client-build-time-config_quarkus-mongodb-devservices-service-name[quarkus.mongodb.devservices.service-name]` + + +[.description] +-- +The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`mongodb` + + a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-mongo-client-build-time-config_quarkus-mongodb-devservices-properties-property-key]]`link:#quarkus-mongodb-mongo-client-build-time-config_quarkus-mongodb-devservices-properties-property-key[quarkus.mongodb.devservices.properties."property-key"]` diff --git a/_generated-doc/latest/config/quarkus-mongodb.adoc b/_generated-doc/latest/config/quarkus-mongodb.adoc index 0a7df29ed66..56ca7ec2742 100644 --- a/_generated-doc/latest/config/quarkus-mongodb.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb.adoc @@ -83,7 +83,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-mongodb_quarkus-mongodb-devserv [.description] -- -If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_ENABLED+++[] @@ -131,6 +133,44 @@ endif::add-copy-button-to-env-var[] | +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb_quarkus-mongodb-devservices-shared]]`link:#quarkus-mongodb_quarkus-mongodb-devservices-shared[quarkus.mongodb.devservices.shared]` + + +[.description] +-- +Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container. + +The discovery uses the `quarkus-dev-service-mongodb` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-mongodb_quarkus-mongodb-devservices-service-name]]`link:#quarkus-mongodb_quarkus-mongodb-devservices-service-name[quarkus.mongodb.devservices.service-name]` + + +[.description] +-- +The value of the `quarkus-dev-service-mongodb` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for MongoDB looks for a container with the `quarkus-dev-service-mongodb` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-mongodb` label set to the specified value. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`mongodb` + + a| [[quarkus-mongodb_quarkus-mongodb-connection-string]]`link:#quarkus-mongodb_quarkus-mongodb-connection-string[quarkus.mongodb.connection-string]` diff --git a/_generated-doc/latest/config/quarkus-narayana-lra.adoc b/_generated-doc/latest/config/quarkus-narayana-lra.adoc index 0e78aab29d1..c874f268039 100644 --- a/_generated-doc/latest/config/quarkus-narayana-lra.adoc +++ b/_generated-doc/latest/config/quarkus-narayana-lra.adoc @@ -10,6 +10,23 @@ h|[[quarkus-narayana-lra_configuration]]link:#quarkus-narayana-lra_configuration h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-narayana-lra_quarkus-lra-openapi-included]]`link:#quarkus-narayana-lra_quarkus-lra-openapi-included[quarkus.lra.openapi.included]` + + +[.description] +-- +Whether to include LRA proxy endpoints in the generated OpenAPI document + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LRA_OPENAPI_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LRA_OPENAPI_INCLUDED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a| [[quarkus-narayana-lra_quarkus-lra-coordinator-url]]`link:#quarkus-narayana-lra_quarkus-lra-coordinator-url[quarkus.lra.coordinator-url]` diff --git a/_generated-doc/latest/config/quarkus-native-pkg-native-config.adoc b/_generated-doc/latest/config/quarkus-native-pkg-native-config.adoc index 4e6fda53961..61848c1310d 100644 --- a/_generated-doc/latest/config/quarkus-native-pkg-native-config.adoc +++ b/_generated-doc/latest/config/quarkus-native-pkg-native-config.adoc @@ -677,4 +677,23 @@ endif::add-copy-button-to-env-var[] --|list of string | + +a|icon:lock[title=Fixed at build time] [[quarkus-native-pkg-native-config_quarkus-native-agent-configuration-apply]]`link:#quarkus-native-pkg-native-config_quarkus-native-agent-configuration-apply[quarkus.native.agent-configuration-apply]` + + +[.description] +-- +Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process. + +Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + |=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-config-group-devservices-keycloak-dev-services-config.adoc b/_generated-doc/latest/config/quarkus-oidc-config-group-devservices-keycloak-dev-services-config.adoc index 4a648c9acb9..33e223e7a09 100644 --- a/_generated-doc/latest/config/quarkus-oidc-config-group-devservices-keycloak-dev-services-config.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-config-group-devservices-keycloak-dev-services-config.adoc @@ -41,7 +41,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] --|string -|`quay.io/keycloak/keycloak:23.0.7` +|`quay.io/keycloak/keycloak:24.0.4` a|icon:lock[title=Fixed at build time] [[quarkus-oidc-config-group-devservices-keycloak-dev-services-config_quarkus-keycloak-devservices-keycloak-x-image]]`link:#quarkus-oidc-config-group-devservices-keycloak-dev-services-config_quarkus-keycloak-devservices-keycloak-x-image[quarkus.keycloak.devservices.keycloak-x-image]` diff --git a/_generated-doc/latest/config/quarkus-oidc-general-config-items.adoc b/_generated-doc/latest/config/quarkus-oidc-general-config-items.adoc index 6e0e864dc61..cba32c52614 100644 --- a/_generated-doc/latest/config/quarkus-oidc-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-general-config-items.adoc @@ -41,7 +41,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] --|string -|`quay.io/keycloak/keycloak:23.0.7` +|`quay.io/keycloak/keycloak:24.0.4` a|icon:lock[title=Fixed at build time] [[quarkus-oidc-general-config-items_quarkus-keycloak-devservices-keycloak-x-image]]`link:#quarkus-oidc-general-config-items_quarkus-keycloak-devservices-keycloak-x-image[quarkus.keycloak.devservices.keycloak-x-image]` diff --git a/_generated-doc/latest/config/quarkus-oidc.adoc b/_generated-doc/latest/config/quarkus-oidc.adoc index 86bdb75bbea..b7d89b34e88 100644 --- a/_generated-doc/latest/config/quarkus-oidc.adoc +++ b/_generated-doc/latest/config/quarkus-oidc.adoc @@ -41,7 +41,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] --|string -|`quay.io/keycloak/keycloak:23.0.7` +|`quay.io/keycloak/keycloak:24.0.4` a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image]]`link:#quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image[quarkus.keycloak.devservices.keycloak-x-image]` diff --git a/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-build-traces-build-config.adoc b/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-build-traces-build-config.adoc index df17c69345b..91174b6da05 100644 --- a/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-build-traces-build-config.adoc +++ b/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-build-traces-build-config.adoc @@ -51,4 +51,21 @@ endif::add-copy-button-to-env-var[] --|string |`parentbased_always_on` + +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry-config-group-config-build-traces-build-config_quarkus-otel-traces-eusp-enabled]]`link:#quarkus-opentelemetry-config-group-config-build-traces-build-config_quarkus-otel-traces-eusp-enabled[quarkus.otel.traces.eusp.enabled]` + + +[.description] +-- +If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + |=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config.adoc b/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config.adoc index 02a10fe27ae..87db55ddb77 100644 --- a/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config.adoc +++ b/_generated-doc/latest/config/quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config.adoc @@ -152,6 +152,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config_quarkus-otel-exporter-otlp-traces-tls-configuration-name]]`link:#quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config_quarkus-otel-exporter-otlp-traces-tls-configuration-name[quarkus.otel.exporter.otlp.traces.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]]`link:#quarkus-opentelemetry-config-group-config-runtime-exporter-otlp-exporter-traces-config_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[quarkus.otel.exporter.otlp.traces.proxy-options.enabled]` diff --git a/_generated-doc/latest/config/quarkus-opentelemetry-general-config-items.adoc b/_generated-doc/latest/config/quarkus-opentelemetry-general-config-items.adoc index c4b8a15ede2..8e86959a48b 100644 --- a/_generated-doc/latest/config/quarkus-opentelemetry-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-opentelemetry-general-config-items.adoc @@ -52,6 +52,23 @@ endif::add-copy-button-to-env-var[] |`parentbased_always_on` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry-general-config-items_quarkus-otel-traces-eusp-enabled]]`link:#quarkus-opentelemetry-general-config-items_quarkus-otel-traces-eusp-enabled[quarkus.otel.traces.eusp.enabled]` + + +[.description] +-- +If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry-general-config-items_quarkus-otel-instrument-grpc]]`link:#quarkus-opentelemetry-general-config-items_quarkus-otel-instrument-grpc[quarkus.otel.instrument.grpc]` @@ -639,6 +656,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-opentelemetry-general-config-items_quarkus-otel-exporter-otlp-traces-tls-configuration-name]]`link:#quarkus-opentelemetry-general-config-items_quarkus-otel-exporter-otlp-traces-tls-configuration-name[quarkus.otel.exporter.otlp.traces.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-opentelemetry-general-config-items_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]]`link:#quarkus-opentelemetry-general-config-items_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[quarkus.otel.exporter.otlp.traces.proxy-options.enabled]` diff --git a/_generated-doc/latest/config/quarkus-opentelemetry.adoc b/_generated-doc/latest/config/quarkus-opentelemetry.adoc index 5874b9cc74a..77324da8deb 100644 --- a/_generated-doc/latest/config/quarkus-opentelemetry.adoc +++ b/_generated-doc/latest/config/quarkus-opentelemetry.adoc @@ -52,6 +52,23 @@ endif::add-copy-button-to-env-var[] |`parentbased_always_on` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled]]`link:#quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled[quarkus.otel.traces.eusp.enabled]` + + +[.description] +-- +If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-metrics-exporter]]`link:#quarkus-opentelemetry_quarkus-otel-metrics-exporter[quarkus.otel.metrics.exporter]` @@ -843,6 +860,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name]]`link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name[quarkus.otel.exporter.otlp.traces.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]]`link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[quarkus.otel.exporter.otlp.traces.proxy-options.enabled]` diff --git a/_generated-doc/latest/config/quarkus-otel-config-build-o-tel-build-config.adoc b/_generated-doc/latest/config/quarkus-otel-config-build-o-tel-build-config.adoc index e63dcba83f2..42147b1164e 100644 --- a/_generated-doc/latest/config/quarkus-otel-config-build-o-tel-build-config.adoc +++ b/_generated-doc/latest/config/quarkus-otel-config-build-o-tel-build-config.adoc @@ -52,6 +52,23 @@ endif::add-copy-button-to-env-var[] |`parentbased_always_on` +a|icon:lock[title=Fixed at build time] [[quarkus-otel-config-build-o-tel-build-config_quarkus-otel-traces-eusp-enabled]]`link:#quarkus-otel-config-build-o-tel-build-config_quarkus-otel-traces-eusp-enabled[quarkus.otel.traces.eusp.enabled]` + + +[.description] +-- +If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + a|icon:lock[title=Fixed at build time] [[quarkus-otel-config-build-o-tel-build-config_quarkus-otel-metrics-exporter]]`link:#quarkus-otel-config-build-o-tel-build-config_quarkus-otel-metrics-exporter[quarkus.otel.metrics.exporter]` diff --git a/_generated-doc/latest/config/quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config.adoc b/_generated-doc/latest/config/quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config.adoc index 3098fadb1bf..01e7fe1cba7 100644 --- a/_generated-doc/latest/config/quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config.adoc @@ -169,6 +169,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config_quarkus-otel-exporter-otlp-traces-tls-configuration-name]]`link:#quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config_quarkus-otel-exporter-otlp-traces-tls-configuration-name[quarkus.otel.exporter.otlp.traces.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]]`link:#quarkus-otel-exporter-otlp-config-runtime-exporter-otlp-exporter-runtime-config_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[quarkus.otel.exporter.otlp.traces.proxy-options.enabled]` diff --git a/_generated-doc/latest/config/quarkus-podman-podman-config.adoc b/_generated-doc/latest/config/quarkus-podman-podman-config.adoc new file mode 100644 index 00000000000..372d95e93cd --- /dev/null +++ b/_generated-doc/latest/config/quarkus-podman-podman-config.adoc @@ -0,0 +1,135 @@ + +:summaryTableId: quarkus-podman-podman-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-podman-podman-config_configuration]]link:#quarkus-podman-podman-config_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-dockerfile-jvm-path]]`link:#quarkus-podman-podman-config_quarkus-podman-dockerfile-jvm-path[quarkus.podman.dockerfile-jvm-path]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-dockerfile-native-path]]`link:#quarkus-podman-podman-config_quarkus-podman-dockerfile-native-path[quarkus.podman.dockerfile-native-path]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-cache-from]]`link:#quarkus-podman-podman-config_quarkus-podman-cache-from[quarkus.podman.cache-from]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_CACHE_FROM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_CACHE_FROM+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-network]]`link:#quarkus-podman-podman-config_quarkus-podman-network[quarkus.podman.network]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_NETWORK+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_NETWORK+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-executable-name]]`link:#quarkus-podman-podman-config_quarkus-podman-executable-name[quarkus.podman.executable-name]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_EXECUTABLE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_EXECUTABLE_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-additional-args]]`link:#quarkus-podman-podman-config_quarkus-podman-additional-args[quarkus.podman.additional-args]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-platform]]`link:#quarkus-podman-podman-config_quarkus-podman-platform[quarkus.podman.platform]` + + +[.description] +-- +Which platform(s) to target during the build. See https://docs.podman.io/en/latest/markdown/podman-build.1.html++#++platform-os-arch-variant + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_PLATFORM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_PLATFORM+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-podman-podman-config_quarkus-podman-build-args-build-args]]`link:#quarkus-podman-podman-config_quarkus-podman-build-args-build-args[quarkus.podman.build-args."build-args"]` + + +[.description] +-- +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_BUILD_ARGS__BUILD_ARGS_+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-client-config-redis-config.adoc b/_generated-doc/latest/config/quarkus-redis-client-config-redis-config.adoc index 5604fa98f8d..12017ad8baf 100644 --- a/_generated-doc/latest/config/quarkus-redis-client-config-redis-config.adoc +++ b/_generated-doc/latest/config/quarkus-redis-client-config-redis-config.adoc @@ -357,6 +357,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-client-config-redis-config_quarkus-redis-tls-configuration-name]]`link:#quarkus-redis-client-config-redis-config_quarkus-redis-tls-configuration-name[quarkus.redis.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-redis-client-config-redis-config_quarkus-redis-redis-client-name-hosts]]`link:#quarkus-redis-client-config-redis-config_quarkus-redis-redis-client-name-hosts[quarkus.redis."redis-client-name".hosts]` @@ -704,6 +727,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-client-config-redis-config_quarkus-redis-redis-client-name-tls-configuration-name]]`link:#quarkus-redis-client-config-redis-config_quarkus-redis-redis-client-name-tls-configuration-name[quarkus.redis."redis-client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-redis-client-config-redis-config_quarkus-redis-tcp-tcp-config]]link:#quarkus-redis-client-config-redis-config_quarkus-redis-tcp-tcp-config[TCP config] h|Type diff --git a/_generated-doc/latest/config/quarkus-redis-config-group-client-config-redis-client-config.adoc b/_generated-doc/latest/config/quarkus-redis-config-group-client-config-redis-client-config.adoc index 8339574d03a..acc422ee41d 100644 --- a/_generated-doc/latest/config/quarkus-redis-config-group-client-config-redis-client-config.adoc +++ b/_generated-doc/latest/config/quarkus-redis-config-group-client-config-redis-client-config.adoc @@ -357,6 +357,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-tls-configuration-name]]`link:#quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-tls-configuration-name[quarkus.redis.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-redis-client-name-hosts]]`link:#quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-redis-client-name-hosts[quarkus.redis."redis-client-name".hosts]` @@ -704,6 +727,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-redis-client-name-tls-configuration-name]]`link:#quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-redis-client-name-tls-configuration-name[quarkus.redis."redis-client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-tcp-tcp-config]]link:#quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-tcp-tcp-config[TCP config] h|Type diff --git a/_generated-doc/latest/config/quarkus-redis-general-config-items.adoc b/_generated-doc/latest/config/quarkus-redis-general-config-items.adoc index 5dea3bc8434..e3a4165b823 100644 --- a/_generated-doc/latest/config/quarkus-redis-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-redis-general-config-items.adoc @@ -509,6 +509,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-general-config-items_quarkus-redis-tls-configuration-name]]`link:#quarkus-redis-general-config-items_quarkus-redis-tls-configuration-name[quarkus.redis.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-redis-general-config-items_quarkus-redis-redis-client-name-load-script]]`link:#quarkus-redis-general-config-items_quarkus-redis-redis-client-name-load-script[quarkus.redis."redis-client-name".load-script]` @@ -1044,6 +1067,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis-general-config-items_quarkus-redis-redis-client-name-tls-configuration-name]]`link:#quarkus-redis-general-config-items_quarkus-redis-redis-client-name-tls-configuration-name[quarkus.redis."redis-client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-redis-general-config-items_quarkus-redis-tcp-tcp-config]]link:#quarkus-redis-general-config-items_quarkus-redis-tcp-tcp-config[TCP config] h|Type diff --git a/_generated-doc/latest/config/quarkus-redis.adoc b/_generated-doc/latest/config/quarkus-redis.adoc index 4022e68fc00..cff363b33a8 100644 --- a/_generated-doc/latest/config/quarkus-redis.adoc +++ b/_generated-doc/latest/config/quarkus-redis.adoc @@ -526,6 +526,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis_quarkus-redis-tls-configuration-name]]`link:#quarkus-redis_quarkus-redis-tls-configuration-name[quarkus.redis.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-redis_quarkus-redis-redis-client-name-load-script]]`link:#quarkus-redis_quarkus-redis-redis-client-name-load-script[quarkus.redis."redis-client-name".load-script]` @@ -1061,6 +1084,29 @@ endif::add-copy-button-to-env-var[] |`1S` +a| [[quarkus-redis_quarkus-redis-redis-client-name-tls-configuration-name]]`link:#quarkus-redis_quarkus-redis-redis-client-name-tls-configuration-name[quarkus.redis."redis-client-name".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration name is set then, `quarkus.redis.$client-name.tls` will be used. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-redis_quarkus-redis-tcp-tcp-config]]link:#quarkus-redis_quarkus-redis-tcp-tcp-config[TCP config] h|Type diff --git a/_generated-doc/latest/config/quarkus-rest-client-restclient-config-rest-clients-config.adoc b/_generated-doc/latest/config/quarkus-rest-client-restclient-config-rest-clients-config.adoc index 10ef8287158..f4fb4875219 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-restclient-config-rest-clients-config.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-restclient-config-rest-clients-config.adoc @@ -546,6 +546,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-tls-configuration-name]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-tls-configuration-name[quarkus.rest-client.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-http2]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-http2[quarkus.rest-client.http2]` @@ -967,6 +990,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-tls-configuration-name]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-tls-configuration-name[quarkus.rest-client."config-key".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-connection-ttl]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-connection-ttl[quarkus.rest-client."config-key".connection-ttl]` diff --git a/_generated-doc/latest/config/quarkus-restclient-config-general-config-items.adoc b/_generated-doc/latest/config/quarkus-restclient-config-general-config-items.adoc index a832353c4c3..2f28b880c05 100644 --- a/_generated-doc/latest/config/quarkus-restclient-config-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-restclient-config-general-config-items.adoc @@ -422,6 +422,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-tls-configuration-name]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-tls-configuration-name[quarkus.rest-client."config-key".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-connection-ttl]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-connection-ttl[quarkus.rest-client."config-key".connection-ttl]` diff --git a/_generated-doc/latest/config/quarkus-restclient-config-rest-client-config.adoc b/_generated-doc/latest/config/quarkus-restclient-config-rest-client-config.adoc index 59f8c591e7a..186ea283e4b 100644 --- a/_generated-doc/latest/config/quarkus-restclient-config-rest-client-config.adoc +++ b/_generated-doc/latest/config/quarkus-restclient-config-rest-client-config.adoc @@ -361,6 +361,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-restclient-config-rest-client-config_quarkus-rest-client-config-key-tls-configuration-name]]`link:#quarkus-restclient-config-rest-client-config_quarkus-rest-client-config-key-tls-configuration-name[quarkus.rest-client."config-key".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-restclient-config-rest-client-config_quarkus-rest-client-config-key-connection-ttl]]`link:#quarkus-restclient-config-rest-client-config_quarkus-rest-client-config-key-connection-ttl[quarkus.rest-client."config-key".connection-ttl]` diff --git a/_generated-doc/latest/config/quarkus-restclient-config.adoc b/_generated-doc/latest/config/quarkus-restclient-config.adoc index 4f9bd0151ee..672f6c0ed28 100644 --- a/_generated-doc/latest/config/quarkus-restclient-config.adoc +++ b/_generated-doc/latest/config/quarkus-restclient-config.adoc @@ -546,6 +546,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-restclient-config_quarkus-rest-client-tls-configuration-name]]`link:#quarkus-restclient-config_quarkus-rest-client-tls-configuration-name[quarkus.rest-client.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-restclient-config_quarkus-rest-client-http2]]`link:#quarkus-restclient-config_quarkus-rest-client-http2[quarkus.rest-client.http2]` @@ -984,6 +1007,29 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-restclient-config_quarkus-rest-client-config-key-tls-configuration-name]]`link:#quarkus-restclient-config_quarkus-rest-client-config-key-tls-configuration-name[quarkus.rest-client."config-key".tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used. + +This property is not applicable to the RESTEasy Client. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-restclient-config_quarkus-rest-client-config-key-connection-ttl]]`link:#quarkus-restclient-config_quarkus-rest-client-config-key-connection-ttl[quarkus.rest-client."config-key".connection-ttl]` diff --git a/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-common-config-group-json-config.adoc b/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-common-config-group-json-config.adoc index 7ccea568a14..6ab2f4ccc77 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-common-config-group-json-config.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-common-config-group-json-config.adoc @@ -283,4 +283,21 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-resteasy-reactive-kotlin-serialization-common-config-group-json-config_quarkus-kotlin-serialization-json-allow-comments]]`link:#quarkus-resteasy-reactive-kotlin-serialization-common-config-group-json-config_quarkus-kotlin-serialization-json-allow-comments[quarkus.kotlin-serialization.json.allow-comments]` + + +[.description] +-- +Allows parser to accept C/Java-style comments in JSON input. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + |=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-general-config-items.adoc b/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-general-config-items.adoc index 3eed94c1705..e42cd72b286 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization-general-config-items.adoc @@ -283,4 +283,21 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-resteasy-reactive-kotlin-serialization-general-config-items_quarkus-kotlin-serialization-json-allow-comments]]`link:#quarkus-resteasy-reactive-kotlin-serialization-general-config-items_quarkus-kotlin-serialization-json-allow-comments[quarkus.kotlin-serialization.json.allow-comments]` + + +[.description] +-- +Allows parser to accept C/Java-style comments in JSON input. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + |=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization.adoc b/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization.adoc index 4e141580e23..b30bb937f1d 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-reactive-kotlin-serialization.adoc @@ -283,4 +283,21 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-resteasy-reactive-kotlin-serialization_quarkus-kotlin-serialization-json-allow-comments]]`link:#quarkus-resteasy-reactive-kotlin-serialization_quarkus-kotlin-serialization-json-allow-comments[quarkus.kotlin-serialization.json.allow-comments]` + + +[.description] +-- +Allows parser to accept C/Java-style comments in JSON input. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + |=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc b/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc index 792b01e70cf..acb4ceef63d 100644 --- a/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc +++ b/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc @@ -61,6 +61,23 @@ endif::add-copy-button-to-env-var[] |`http://localhost:8888` +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name]]`link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name[quarkus.spring-cloud-config.name]` + + +[.description] +-- +Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma) + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`${quarkus.application.name:}` + + a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label]]`link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label[quarkus.spring-cloud-config.label]` diff --git a/_generated-doc/latest/config/quarkus-spring-cloud-config-spring-cloud-config-client-config.adoc b/_generated-doc/latest/config/quarkus-spring-cloud-config-spring-cloud-config-client-config.adoc index d993c9f8991..0df7fe5a31a 100644 --- a/_generated-doc/latest/config/quarkus-spring-cloud-config-spring-cloud-config-client-config.adoc +++ b/_generated-doc/latest/config/quarkus-spring-cloud-config-spring-cloud-config-client-config.adoc @@ -61,6 +61,23 @@ endif::add-copy-button-to-env-var[] |`http://localhost:8888` +a| [[quarkus-spring-cloud-config-spring-cloud-config-client-config_quarkus-spring-cloud-config-name]]`link:#quarkus-spring-cloud-config-spring-cloud-config-client-config_quarkus-spring-cloud-config-name[quarkus.spring-cloud-config.name]` + + +[.description] +-- +Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma) + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`${quarkus.application.name:}` + + a| [[quarkus-spring-cloud-config-spring-cloud-config-client-config_quarkus-spring-cloud-config-label]]`link:#quarkus-spring-cloud-config-spring-cloud-config-client-config_quarkus-spring-cloud-config-label[quarkus.spring-cloud-config.label]` diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-jks-key-store-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-jks-key-store-config.adoc new file mode 100644 index 00000000000..7499b823343 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-jks-key-store-config.adoc @@ -0,0 +1,182 @@ + +:summaryTableId: quarkus-tls-config-group-config-jks-key-store-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-jks-key-store-config_configuration]]link:#quarkus-tls-config-group-config-jks-key-store-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-jks-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-jks-trust-store-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-jks-trust-store-config.adoc new file mode 100644 index 00000000000..a221f94708a --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-jks-trust-store-config.adoc @@ -0,0 +1,148 @@ + +:summaryTableId: quarkus-tls-config-group-config-jks-trust-store-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-jks-trust-store-config_configuration]]link:#quarkus-tls-config-group-config-jks-trust-store-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-jks-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-key-store-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-key-store-config.adoc new file mode 100644 index 00000000000..492f6b9c8c3 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-key-store-config.adoc @@ -0,0 +1,913 @@ + +:summaryTableId: quarkus-tls-config-group-config-key-store-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-key-store-config_configuration]]link:#quarkus-tls-config-group-config-key-store-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-sni]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-sni[quarkus.tls.key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-name[quarkus.tls.key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-bean-name[quarkus.tls.key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-password-key[quarkus.tls.key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-credentials-provider-alias-password-key[quarkus.tls.key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +h|[[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-key-store-config_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-p12-key-store-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-p12-key-store-config.adoc new file mode 100644 index 00000000000..edfc8ac20e1 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-p12-key-store-config.adoc @@ -0,0 +1,182 @@ + +:summaryTableId: quarkus-tls-config-group-config-p12-key-store-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-p12-key-store-config_configuration]]link:#quarkus-tls-config-group-config-p12-key-store-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-p12-key-store-config_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-p12-trust-store-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-p12-trust-store-config.adoc new file mode 100644 index 00000000000..84c13b23de7 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-p12-trust-store-config.adoc @@ -0,0 +1,148 @@ + +:summaryTableId: quarkus-tls-config-group-config-p12-trust-store-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-p12-trust-store-config_configuration]]link:#quarkus-tls-config-group-config-p12-trust-store-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-p12-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-pem-certs-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-pem-certs-config.adoc new file mode 100644 index 00000000000..d2faa5eafba --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-pem-certs-config.adoc @@ -0,0 +1,46 @@ + +:summaryTableId: quarkus-tls-config-group-config-pem-certs-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-pem-certs-config_configuration]]link:#quarkus-tls-config-group-config-pem-certs-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-pem-certs-config_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-pem-certs-config_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-group-config-pem-certs-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-pem-certs-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-pem-key-cert-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-pem-key-cert-config.adoc new file mode 100644 index 00000000000..41d3b502c0d --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-pem-key-cert-config.adoc @@ -0,0 +1,118 @@ + +:summaryTableId: quarkus-tls-config-group-config-pem-key-cert-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-pem-key-cert-config_configuration]]link:#quarkus-tls-config-group-config-pem-key-cert-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-config-group-config-pem-key-cert-config_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-tls-bucket-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-tls-bucket-config.adoc new file mode 100644 index 00000000000..73bb632a8fa --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-tls-bucket-config.adoc @@ -0,0 +1,2008 @@ + +:summaryTableId: quarkus-tls-config-group-config-tls-bucket-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-tls-bucket-config_configuration]]link:#quarkus-tls-config-group-config-tls-bucket-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-cipher-suites]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-cipher-suites[quarkus.tls."tls-bucket-name".cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-protocols]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-protocols[quarkus.tls."tls-bucket-name".protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-handshake-timeout]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-handshake-timeout[quarkus.tls."tls-bucket-name".handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-alpn]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-alpn[quarkus.tls."tls-bucket-name".alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-certificate-revocation-list]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-certificate-revocation-list[quarkus.tls."tls-bucket-name".certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-all]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-all[quarkus.tls."tls-bucket-name".trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-hostname-verification-algorithm]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-hostname-verification-algorithm[quarkus.tls."tls-bucket-name".hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration[The default TLS bucket configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-cipher-suites]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-cipher-suites[quarkus.tls.cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-protocols]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-protocols[quarkus.tls.protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-handshake-timeout]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-handshake-timeout[quarkus.tls.handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-alpn]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-alpn[quarkus.tls.alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-certificate-revocation-list]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-certificate-revocation-list[quarkus.tls.certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-all]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-all[quarkus.tls.trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-hostname-verification-algorithm]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-hostname-verification-algorithm[quarkus.tls.hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-the-key-store-configuration]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-the-key-store-configuration[The key store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-sni]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-sni[quarkus.tls.key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-name[quarkus.tls.key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-bean-name[quarkus.tls.key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-password-key[quarkus.tls.key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-credentials-provider-alias-password-key[quarkus.tls.key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-the-trust-store-configuration]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-the-trust-store-configuration[The trust store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-credentials-provider-name[quarkus.tls.trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-credentials-provider-bean-name[quarkus.tls.trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-credentials-provider-password-key[quarkus.tls.trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-the-key-store-configuration]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-the-key-store-configuration[The key store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-the-trust-store-configuration]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-the-trust-store-configuration[The trust store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-tls-bucket-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[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`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-tls-config-group-config-trust-store-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-group-config-trust-store-config.adoc new file mode 100644 index 00000000000..86b6c5d6acf --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-group-config-trust-store-config.adoc @@ -0,0 +1,619 @@ + +:summaryTableId: quarkus-tls-config-group-config-trust-store-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-group-config-trust-store-config_configuration]]link:#quarkus-tls-config-group-config-trust-store-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-credentials-provider-name[quarkus.tls.trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-credentials-provider-bean-name[quarkus.tls.trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-credentials-provider-password-key[quarkus.tls.trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-config-group-config-trust-store-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-config-tls-config.adoc b/_generated-doc/latest/config/quarkus-tls-config-tls-config.adoc new file mode 100644 index 00000000000..0b363c8edbf --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-config-tls-config.adoc @@ -0,0 +1,1432 @@ + +:summaryTableId: quarkus-tls-config-tls-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-config-tls-config_configuration]]link:#quarkus-tls-config-tls-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-cipher-suites]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-cipher-suites[quarkus.tls."tls-bucket-name".cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-protocols]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-protocols[quarkus.tls."tls-bucket-name".protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-handshake-timeout]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-handshake-timeout[quarkus.tls."tls-bucket-name".handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-alpn]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-alpn[quarkus.tls."tls-bucket-name".alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-certificate-revocation-list]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-certificate-revocation-list[quarkus.tls."tls-bucket-name".certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-all]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-all[quarkus.tls."tls-bucket-name".trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-hostname-verification-algorithm]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-hostname-verification-algorithm[quarkus.tls."tls-bucket-name".hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration]]link:#quarkus-tls-config-tls-config_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration[The default TLS bucket configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-cipher-suites]]`link:#quarkus-tls-config-tls-config_quarkus-tls-cipher-suites[quarkus.tls.cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-protocols]]`link:#quarkus-tls-config-tls-config_quarkus-tls-protocols[quarkus.tls.protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-handshake-timeout]]`link:#quarkus-tls-config-tls-config_quarkus-tls-handshake-timeout[quarkus.tls.handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-alpn]]`link:#quarkus-tls-config-tls-config_quarkus-tls-alpn[quarkus.tls.alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-certificate-revocation-list]]`link:#quarkus-tls-config-tls-config_quarkus-tls-certificate-revocation-list[quarkus.tls.certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-all]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-all[quarkus.tls.trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-hostname-verification-algorithm]]`link:#quarkus-tls-config-tls-config_quarkus-tls-hostname-verification-algorithm[quarkus.tls.hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-key-store-the-key-store-configuration]]link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-the-key-store-configuration[The key store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-sni]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-sni[quarkus.tls.key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-name[quarkus.tls.key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-bean-name[quarkus.tls.key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-password-key[quarkus.tls.key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-credentials-provider-alias-password-key[quarkus.tls.key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-trust-store-the-trust-store-configuration]]link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-the-trust-store-configuration[The trust store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-credentials-provider-name[quarkus.tls.trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-credentials-provider-bean-name[quarkus.tls.trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-credentials-provider-password-key[quarkus.tls.trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-config-tls-config_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[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`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-tls-general-config-items.adoc b/_generated-doc/latest/config/quarkus-tls-general-config-items.adoc new file mode 100644 index 00000000000..79699b827cb --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls-general-config-items.adoc @@ -0,0 +1,1432 @@ + +:summaryTableId: quarkus-tls-general-config-items +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls-general-config-items_configuration]]link:#quarkus-tls-general-config-items_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-cipher-suites]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-cipher-suites[quarkus.tls."tls-bucket-name".cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-protocols]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-protocols[quarkus.tls."tls-bucket-name".protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-handshake-timeout]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-handshake-timeout[quarkus.tls."tls-bucket-name".handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-alpn]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-alpn[quarkus.tls."tls-bucket-name".alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-certificate-revocation-list]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-certificate-revocation-list[quarkus.tls."tls-bucket-name".certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-all]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-all[quarkus.tls."tls-bucket-name".trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-hostname-verification-algorithm]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-hostname-verification-algorithm[quarkus.tls."tls-bucket-name".hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration]]link:#quarkus-tls-general-config-items_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration[The default TLS bucket configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-cipher-suites]]`link:#quarkus-tls-general-config-items_quarkus-tls-cipher-suites[quarkus.tls.cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-protocols]]`link:#quarkus-tls-general-config-items_quarkus-tls-protocols[quarkus.tls.protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-handshake-timeout]]`link:#quarkus-tls-general-config-items_quarkus-tls-handshake-timeout[quarkus.tls.handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-alpn]]`link:#quarkus-tls-general-config-items_quarkus-tls-alpn[quarkus.tls.alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-certificate-revocation-list]]`link:#quarkus-tls-general-config-items_quarkus-tls-certificate-revocation-list[quarkus.tls.certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-all]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-all[quarkus.tls.trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-hostname-verification-algorithm]]`link:#quarkus-tls-general-config-items_quarkus-tls-hostname-verification-algorithm[quarkus.tls.hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-key-store-the-key-store-configuration]]link:#quarkus-tls-general-config-items_quarkus-tls-key-store-the-key-store-configuration[The key store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-sni]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-sni[quarkus.tls.key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-name[quarkus.tls.key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-bean-name[quarkus.tls.key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-password-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-password-key[quarkus.tls.key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-credentials-provider-alias-password-key[quarkus.tls.key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +h|[[quarkus-tls-general-config-items_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls-general-config-items_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls-general-config-items_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls-general-config-items_quarkus-tls-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-trust-store-the-trust-store-configuration]]link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-the-trust-store-configuration[The trust store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-credentials-provider-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-credentials-provider-name[quarkus.tls.trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-credentials-provider-bean-name[quarkus.tls.trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-credentials-provider-password-key[quarkus.tls.trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls-general-config-items_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls-general-config-items_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[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`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-tls-tls-config.adoc b/_generated-doc/latest/config/quarkus-tls-tls-config.adoc deleted file mode 100644 index 2814c87ce25..00000000000 --- a/_generated-doc/latest/config/quarkus-tls-tls-config.adoc +++ /dev/null @@ -1,29 +0,0 @@ - -:summaryTableId: quarkus-tls-tls-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-tls-tls-config_configuration]]link:#quarkus-tls-tls-config_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-tls-tls-config_quarkus-tls-trust-all]]`link:#quarkus-tls-tls-config_quarkus-tls-trust-all[quarkus.tls.trust-all]` - - -[.description] --- -Enable trusting all certificates. Disable by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - -|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls.adoc b/_generated-doc/latest/config/quarkus-tls.adoc new file mode 100644 index 00000000000..cae5af1031c --- /dev/null +++ b/_generated-doc/latest/config/quarkus-tls.adoc @@ -0,0 +1,1432 @@ + +:summaryTableId: quarkus-tls +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-tls_configuration]]link:#quarkus-tls_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-cipher-suites]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-cipher-suites[quarkus.tls."tls-bucket-name".cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-protocols]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-protocols[quarkus.tls."tls-bucket-name".protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-handshake-timeout]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-handshake-timeout[quarkus.tls."tls-bucket-name".handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-alpn]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-alpn[quarkus.tls."tls-bucket-name".alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-certificate-revocation-list]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-certificate-revocation-list[quarkus.tls."tls-bucket-name".certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-all]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-all[quarkus.tls."tls-bucket-name".trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-hostname-verification-algorithm]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-hostname-verification-algorithm[quarkus.tls."tls-bucket-name".hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration]]link:#quarkus-tls_quarkus-tls-default-certificate-config-the-default-tls-bucket-configuration[The default TLS bucket configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-cipher-suites]]`link:#quarkus-tls_quarkus-tls-cipher-suites[quarkus.tls.cipher-suites]` + + +[.description] +-- +Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers. + +When suites are set, it takes precedence over the default suite defined by the `SSLEngineOptions` in use. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CIPHER_SUITES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CIPHER_SUITES+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls_quarkus-tls-protocols]]`link:#quarkus-tls_quarkus-tls-protocols[quarkus.tls.protocols]` + + +[.description] +-- +Sets the ordered list of enabled TLS protocols. + +If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`. + +Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol. + +Also, setting this replaces the default list of protocols. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`TLSv1.3,TLSv1.2` + + +a| [[quarkus-tls_quarkus-tls-handshake-timeout]]`link:#quarkus-tls_quarkus-tls-handshake-timeout[quarkus.tls.handshake-timeout]` + + +[.description] +-- +The timeout for the TLS handshake phase. + +If not set, it defaults to 10 seconds. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-tls_quarkus-tls-alpn]]`link:#quarkus-tls_quarkus-tls-alpn[quarkus.tls.alpn]` + + +[.description] +-- +Enables the Application-Layer Protocol Negotiation (ALPN). + +Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_ALPN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_ALPN+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-tls_quarkus-tls-certificate-revocation-list]]`link:#quarkus-tls_quarkus-tls-certificate-revocation-list[quarkus.tls.certificate-revocation-list]` + + +[.description] +-- +Sets the list of revoked certificates (paths to files). + +A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +Two formats are allowed: DER and PKCS++#++7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS++#++7 format, you must pass PKCS++#++7 `SignedData` object, with the only significant field being `crls`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls_quarkus-tls-trust-all]]`link:#quarkus-tls_quarkus-tls-trust-all[quarkus.tls.trust-all]` + + +[.description] +-- +If set to `true`, the server trusts all certificates. + +This is useful for testing, but should not be used in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_ALL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls_quarkus-tls-hostname-verification-algorithm]]`link:#quarkus-tls_quarkus-tls-hostname-verification-algorithm[quarkus.tls.hostname-verification-algorithm]` + + +[.description] +-- +The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`. + +If set to `NONE`, it does not verify the hostname. + +If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS". + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls_quarkus-tls-key-store-the-key-store-configuration]]link:#quarkus-tls_quarkus-tls-key-store-the-key-store-configuration[The key store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-key-store-sni]]`link:#quarkus-tls_quarkus-tls-key-store-sni[quarkus.tls.key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls_quarkus-tls-key-store-credentials-provider-name]]`link:#quarkus-tls_quarkus-tls-key-store-credentials-provider-name[quarkus.tls.key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-credentials-provider-bean-name]]`link:#quarkus-tls_quarkus-tls-key-store-credentials-provider-bean-name[quarkus.tls.key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-credentials-provider-password-key]]`link:#quarkus-tls_quarkus-tls-key-store-credentials-provider-password-key[quarkus.tls.key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls_quarkus-tls-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls_quarkus-tls-key-store-credentials-provider-alias-password-key[quarkus.tls.key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-sni]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-sni[quarkus.tls."tls-bucket-name".key-store.sni]` + + +[.description] +-- +Enables Server Name Indication (SNI). + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate. + +When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the `password` and `alias-password` properties. Do not set the `alias` property. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the key store password. + +If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-credentials-provider-alias-password-key[quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key]` + + +[.description] +-- +The key used to retrieve the key store alias password. + +If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias `private key` from the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`alias-password` + + +h|[[quarkus-tls_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair]]link:#quarkus-tls_quarkus-tls-key-store-pem-configures-the-pem-key-certificate-pair[Configures the PEM key/certificate pair] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-key-store-pem-order]]`link:#quarkus-tls_quarkus-tls-key-store-pem-order[quarkus.tls.key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-pem-key-certs-key]]`link:#quarkus-tls_quarkus-tls-key-store-pem-key-certs-key[quarkus.tls.key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-key-store-pem-key-certs-cert]]`link:#quarkus-tls_quarkus-tls-key-store-pem-key-certs-cert[quarkus.tls.key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-key[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key]` + + +[.description] +-- +The path to the key file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-pem-key-certs-cert[quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert]` + + +[.description] +-- +The path to the certificate file (in PEM format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-pem-order]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-pem-order[quarkus.tls."tls-bucket-name".key-store.pem.order]` + + +[.description] +-- +The order of the key/cert files, based on the names in the `keyCerts` map. + +By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER+++` +endif::add-copy-button-to-env-var[] +--|list of string +| + + +h|[[quarkus-tls_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store]]link:#quarkus-tls_quarkus-tls-key-store-p12-configure-the-pkcs12-key-store[Configure the PKCS12 key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-key-store-p12-path]]`link:#quarkus-tls_quarkus-tls-key-store-p12-path[quarkus.tls.key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-key-store-p12-password]]`link:#quarkus-tls_quarkus-tls-key-store-p12-password[quarkus.tls.key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-p12-alias]]`link:#quarkus-tls_quarkus-tls-key-store-p12-alias[quarkus.tls.key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-p12-alias-password]]`link:#quarkus-tls_quarkus-tls-key-store-p12-alias-password[quarkus.tls.key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-p12-provider]]`link:#quarkus-tls_quarkus-tls-key-store-p12-provider[quarkus.tls.key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-path]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-path[quarkus.tls."tls-bucket-name".key-store.p12.path]` + + +[.description] +-- +Path to the key store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-password]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-password[quarkus.tls."tls-bucket-name".key-store.p12.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-alias]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-alias[quarkus.tls."tls-bucket-name".key-store.p12.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-alias-password]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-alias-password[quarkus.tls."tls-bucket-name".key-store.p12.alias-password]` + + +[.description] +-- +Password of the alias in the key store. If not set, the password will be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-provider]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-p12-provider[quarkus.tls."tls-bucket-name".key-store.p12.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls_quarkus-tls-key-store-jks-configure-the-jks-key-store]]link:#quarkus-tls_quarkus-tls-key-store-jks-configure-the-jks-key-store[Configure the JKS key store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-key-store-jks-path]]`link:#quarkus-tls_quarkus-tls-key-store-jks-path[quarkus.tls.key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-key-store-jks-password]]`link:#quarkus-tls_quarkus-tls-key-store-jks-password[quarkus.tls.key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-jks-alias]]`link:#quarkus-tls_quarkus-tls-key-store-jks-alias[quarkus.tls.key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-jks-alias-password]]`link:#quarkus-tls_quarkus-tls-key-store-jks-alias-password[quarkus.tls.key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-key-store-jks-provider]]`link:#quarkus-tls_quarkus-tls-key-store-jks-provider[quarkus.tls.key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-path]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-path[quarkus.tls."tls-bucket-name".key-store.jks.path]` + + +[.description] +-- +Path to the keystore file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-password]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-password[quarkus.tls."tls-bucket-name".key-store.jks.password]` + + +[.description] +-- +Password of the key store. When not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-alias]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-alias[quarkus.tls."tls-bucket-name".key-store.jks.alias]` + + +[.description] +-- +Alias of the private key and certificate in the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-alias-password]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-alias-password[quarkus.tls."tls-bucket-name".key-store.jks.alias-password]` + + +[.description] +-- +Password of the alias in the key store. When not set, the password may be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-provider]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-key-store-jks-provider[quarkus.tls."tls-bucket-name".key-store.jks.provider]` + + +[.description] +-- +Provider of the key store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls_quarkus-tls-trust-store-the-trust-store-configuration]]link:#quarkus-tls_quarkus-tls-trust-store-the-trust-store-configuration[The trust store configuration] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-trust-store-credentials-provider-name]]`link:#quarkus-tls_quarkus-tls-trust-store-credentials-provider-name[quarkus.tls.trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls_quarkus-tls-trust-store-credentials-provider-bean-name[quarkus.tls.trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-trust-store-credentials-provider-password-key]]`link:#quarkus-tls_quarkus-tls-trust-store-credentials-provider-password-key[quarkus.tls.trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name]` + + +[.description] +-- +The name of the "credential" bucket (map key -> passwords) to retrieve from the `io.quarkus.credentials.CredentialsProvider`. If not set, the credential provider will not be used. + +A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-bean-name[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name]` + + +[.description] +-- +The name of the bean providing the credential provider. + +The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the `@Named` annotation set to the configured name to be selected. + +If not set, the default credential provider is used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-credentials-provider-password-key[quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key]` + + +[.description] +-- +The key used to retrieve the trust store password. + +If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY+++` +endif::add-copy-button-to-env-var[] +--|string +|`password` + + +h|[[quarkus-tls_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates]]link:#quarkus-tls_quarkus-tls-trust-store-pem-configures-the-list-of-trusted-certificates[Configures the list of trusted certificates] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-trust-store-pem-certs]]`link:#quarkus-tls_quarkus-tls-trust-store-pem-certs[quarkus.tls.trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-pem-certs]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-pem-certs[quarkus.tls."tls-bucket-name".trust-store.pem.certs]` + + +[.description] +-- +List of the trusted cert paths (Pem format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS+++` +endif::add-copy-button-to-env-var[] +--|list of path +| + + +h|[[quarkus-tls_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store]]link:#quarkus-tls_quarkus-tls-trust-store-p12-configure-the-pkcs12-trust-store[Configure the PKCS12 trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-trust-store-p12-path]]`link:#quarkus-tls_quarkus-tls-trust-store-p12-path[quarkus.tls.trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-trust-store-p12-password]]`link:#quarkus-tls_quarkus-tls-trust-store-p12-password[quarkus.tls.trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-trust-store-p12-alias]]`link:#quarkus-tls_quarkus-tls-trust-store-p12-alias[quarkus.tls.trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-trust-store-p12-provider]]`link:#quarkus-tls_quarkus-tls-trust-store-p12-provider[quarkus.tls.trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-path]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-path[quarkus.tls."tls-bucket-name".trust-store.p12.path]` + + +[.description] +-- +Path to the trust store file (P12 / PFX format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-password]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-password[quarkus.tls."tls-bucket-name".trust-store.p12.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-alias]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-alias[quarkus.tls."tls-bucket-name".trust-store.p12.alias]` + + +[.description] +-- +Alias of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-provider]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-p12-provider[quarkus.tls."tls-bucket-name".trust-store.p12.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-tls_quarkus-tls-trust-store-jks-configure-the-jks-trust-store]]link:#quarkus-tls_quarkus-tls-trust-store-jks-configure-the-jks-trust-store[Configure the JKS trust store] +This configuration section is optional +h|Type +h|Default + +a| [[quarkus-tls_quarkus-tls-trust-store-jks-path]]`link:#quarkus-tls_quarkus-tls-trust-store-jks-path[quarkus.tls.trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-trust-store-jks-password]]`link:#quarkus-tls_quarkus-tls-trust-store-jks-password[quarkus.tls.trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-trust-store-jks-alias]]`link:#quarkus-tls_quarkus-tls-trust-store-jks-alias[quarkus.tls.trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-trust-store-jks-provider]]`link:#quarkus-tls_quarkus-tls-trust-store-jks-provider[quarkus.tls.trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-path]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-path[quarkus.tls."tls-bucket-name".trust-store.jks.path]` + + +[.description] +-- +Path to the trust store file (JKS format). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH+++` +endif::add-copy-button-to-env-var[] +--|path +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-password]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-password[quarkus.tls."tls-bucket-name".trust-store.jks.password]` + + +[.description] +-- +Password of the trust store. If not set, the password must be retrieved from the credential provider. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-alias]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-alias[quarkus.tls."tls-bucket-name".trust-store.jks.alias]` + + +[.description] +-- +Alias of the key in the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-provider]]`link:#quarkus-tls_quarkus-tls-tls-bucket-name-trust-store-jks-provider[quarkus.tls."tls-bucket-name".trust-store.jks.provider]` + + +[.description] +-- +Provider of the trust store. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[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`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-vertx-http-config-group-auth-runtime-config.adoc b/_generated-doc/latest/config/quarkus-vertx-http-config-group-auth-runtime-config.adoc index ca3f2b07f79..296e2703eb9 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http-config-group-auth-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http-config-group-auth-runtime-config.adoc @@ -10,14 +10,36 @@ h|[[quarkus-vertx-http-config-group-auth-runtime-config_configuration]]link:#qua h|Type h|Default +a| [[quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]` + + +[.description] +-- +Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are: + + - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported. + - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name. + - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI). + - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++` +endif::add-copy-button-to-env-var[] +--|string +|`CN` + + a| [[quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]` [.description] -- -Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. +Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. -Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8. +Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[] diff --git a/_generated-doc/latest/config/quarkus-vertx-http-general-config-items.adoc b/_generated-doc/latest/config/quarkus-vertx-http-general-config-items.adoc index 7c7c9213d1b..85bc1aab2c2 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http-general-config-items.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http-general-config-items.adoc @@ -78,14 +78,36 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]` + + +[.description] +-- +Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are: + + - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported. + - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name. + - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI). + - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++` +endif::add-copy-button-to-env-var[] +--|string +|`CN` + + a| [[quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]` [.description] -- -Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. +Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. -Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8. +Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[] diff --git a/_generated-doc/latest/config/quarkus-vertx-http.adoc b/_generated-doc/latest/config/quarkus-vertx-http.adoc index 6256906248c..4eeb73b4f67 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http.adoc @@ -217,6 +217,25 @@ endif::add-copy-button-to-env-var[] |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compressors]]`link:#quarkus-vertx-http_quarkus-http-compressors[quarkus.http.compressors]` + + +[.description] +-- +If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project. + +Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_COMPRESSORS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`gzip,deflate` + + a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compress-media-types]]`link:#quarkus-vertx-http_quarkus-http-compress-media-types[quarkus.http.compress-media-types]` @@ -251,14 +270,36 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]` + + +[.description] +-- +Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are: + + - RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported. + - 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name. + - 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI). + - 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++` +endif::add-copy-button-to-env-var[] +--|string +|`CN` + + a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]` [.description] -- -Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. +Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`. -Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8. +Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[] @@ -1220,6 +1261,27 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-vertx-http_quarkus-http-tls-configuration-name]]`link:#quarkus-vertx-http_quarkus-http-tls-configuration-name[quarkus.http.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.http.ssl` will be used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-vertx-http_quarkus-http-static-resources-index-page]]`link:#quarkus-vertx-http_quarkus-http-static-resources-index-page[quarkus.http.static-resources.index-page]` @@ -3036,7 +3098,11 @@ a| [[quarkus-vertx-http_quarkus-management-host]]`link:#quarkus-vertx-http_quark [.description] -- -The HTTP host Defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. +The HTTP host + +Defaults to 0.0.0.0 + +Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_HOST+++[] @@ -3473,6 +3539,27 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-vertx-http_quarkus-management-tls-configuration-name]]`link:#quarkus-vertx-http_quarkus-management-tls-configuration-name[quarkus.management.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +If no TLS configuration is set, and `quarkus.tls.++*++` is not configured, then, `quarkus.management.ssl` will be used. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-vertx-http_quarkus-management-handle-100-continue-automatically]]`link:#quarkus-vertx-http_quarkus-management-handle-100-continue-automatically[quarkus.management.handle-100-continue-automatically]` diff --git a/_generated-doc/latest/config/quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config.adoc b/_generated-doc/latest/config/quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config.adoc index 0d88b55fc08..7b7a908a40a 100644 --- a/_generated-doc/latest/config/quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config.adoc @@ -102,6 +102,61 @@ endif::add-copy-button-to-env-var[] `close`, `log`, `noop` |`close` + +a| [[quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config_quarkus-websockets-next-client-tls-configuration-name]]`link:#quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config_quarkus-websockets-next-client-tls-configuration-name[quarkus.websockets-next.client.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config_quarkus-websockets-next-client-traffic-logging-enabled]]`link:#quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config_quarkus-websockets-next-client-traffic-logging-enabled[quarkus.websockets-next.client.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config_quarkus-websockets-next-client-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next-client-websockets-next-web-sockets-client-runtime-config_quarkus-websockets-next-client-traffic-logging-text-payload-limit[quarkus.websockets-next.client.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + |=== ifndef::no-duration-note[] [NOTE] diff --git a/_generated-doc/latest/config/quarkus-websockets-next-general-config-items.adoc b/_generated-doc/latest/config/quarkus-websockets-next-general-config-items.adoc new file mode 100644 index 00000000000..2e5172e2794 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-websockets-next-general-config-items.adoc @@ -0,0 +1,97 @@ + +:summaryTableId: quarkus-websockets-next-general-config-items +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-websockets-next-general-config-items_configuration]]link:#quarkus-websockets-next-general-config-items_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-websockets-next-general-config-items_quarkus-websockets-next-client-traffic-logging-enabled]]`link:#quarkus-websockets-next-general-config-items_quarkus-websockets-next-client-traffic-logging-enabled[quarkus.websockets-next.client.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next-general-config-items_quarkus-websockets-next-client-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next-general-config-items_quarkus-websockets-next-client-traffic-logging-text-payload-limit[quarkus.websockets-next.client.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +a| [[quarkus-websockets-next-general-config-items_quarkus-websockets-next-server-security-auth-failure-redirect-url]]`link:#quarkus-websockets-next-general-config-items_quarkus-websockets-next-server-security-auth-failure-redirect-url[quarkus.websockets-next.server.security.auth-failure-redirect-url]` + + +[.description] +-- +Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next-general-config-items_quarkus-websockets-next-server-traffic-logging-enabled]]`link:#quarkus-websockets-next-general-config-items_quarkus-websockets-next-server-traffic-logging-enabled[quarkus.websockets-next.server.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next-general-config-items_quarkus-websockets-next-server-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next-general-config-items_quarkus-websockets-next-server-traffic-logging-text-payload-limit[quarkus.websockets-next.server.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config.adoc b/_generated-doc/latest/config/quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config.adoc index c23d7307e40..1a49a42ad3f 100644 --- a/_generated-doc/latest/config/quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config.adoc @@ -119,6 +119,57 @@ endif::add-copy-button-to-env-var[] `close`, `log`, `noop` |`close` + +a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-security-auth-failure-redirect-url]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-security-auth-failure-redirect-url[quarkus.websockets-next.server.security.auth-failure-redirect-url]` + + +[.description] +-- +Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-traffic-logging-enabled]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-traffic-logging-enabled[quarkus.websockets-next.server.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-traffic-logging-text-payload-limit[quarkus.websockets-next.server.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + |=== ifndef::no-duration-note[] [NOTE] diff --git a/_generated-doc/latest/config/quarkus-websockets-next-traffic-logging-config.adoc b/_generated-doc/latest/config/quarkus-websockets-next-traffic-logging-config.adoc new file mode 100644 index 00000000000..8fc3d9d8ac3 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-websockets-next-traffic-logging-config.adoc @@ -0,0 +1,80 @@ + +:summaryTableId: quarkus-websockets-next-traffic-logging-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-websockets-next-traffic-logging-config_configuration]]link:#quarkus-websockets-next-traffic-logging-config_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-client-traffic-logging-enabled]]`link:#quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-client-traffic-logging-enabled[quarkus.websockets-next.client.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-client-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-client-traffic-logging-text-payload-limit[quarkus.websockets-next.client.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + +a| [[quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-server-traffic-logging-enabled]]`link:#quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-server-traffic-logging-enabled[quarkus.websockets-next.server.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-server-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next-traffic-logging-config_quarkus-websockets-next-server-traffic-logging-text-payload-limit[quarkus.websockets-next.server.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-next-web-sockets-server-runtime-config-security.adoc b/_generated-doc/latest/config/quarkus-websockets-next-web-sockets-server-runtime-config-security.adoc new file mode 100644 index 00000000000..f56e9073043 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-websockets-next-web-sockets-server-runtime-config-security.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-websockets-next-web-sockets-server-runtime-config-security +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-websockets-next-web-sockets-server-runtime-config-security_configuration]]link:#quarkus-websockets-next-web-sockets-server-runtime-config-security_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-websockets-next-web-sockets-server-runtime-config-security_quarkus-websockets-next-server-security-auth-failure-redirect-url]]`link:#quarkus-websockets-next-web-sockets-server-runtime-config-security_quarkus-websockets-next-server-security-auth-failure-redirect-url[quarkus.websockets-next.server.security.auth-failure-redirect-url]` + + +[.description] +-- +Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++` +endif::add-copy-button-to-env-var[] +--|string +| + +|=== \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-next.adoc b/_generated-doc/latest/config/quarkus-websockets-next.adoc index 3f58259f64c..9587255cd40 100644 --- a/_generated-doc/latest/config/quarkus-websockets-next.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-next.adoc @@ -103,6 +103,61 @@ endif::add-copy-button-to-env-var[] |`close` +a| [[quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name[quarkus.websockets-next.client.tls-configuration-name]` + + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-enabled]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-enabled[quarkus.websockets-next.client.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next_quarkus-websockets-next-client-traffic-logging-text-payload-limit[quarkus.websockets-next.client.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[quarkus.websockets-next.server.supported-subprotocols]` @@ -212,6 +267,57 @@ endif::add-copy-button-to-env-var[] `close`, `log`, `noop` |`close` + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url[quarkus.websockets-next.server.security.auth-failure-redirect-url]` + + +[.description] +-- +Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-enabled]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-enabled[quarkus.websockets-next.server.traffic-logging.enabled]` + + +[.description] +-- +If set to true then binary/text messages received/sent are logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-text-payload-limit]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-traffic-logging-text-payload-limit[quarkus.websockets-next.server.traffic-logging.text-payload-limit]` + + +[.description] +-- +The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + |=== ifndef::no-duration-note[] [NOTE] diff --git a/_guides/_attributes.adoc b/_guides/_attributes.adoc index 3c6ce8885de..174cd882d6d 100644 --- a/_guides/_attributes.adoc +++ b/_guides/_attributes.adoc @@ -1,16 +1,16 @@ // Common attributes. // --> No blank lines (it ends the document header) :project-name: Quarkus -:quarkus-version: 3.11.3 +:quarkus-version: 3.12.0 :quarkus-platform-groupid: io.quarkus.platform // . -:maven-version: 3.9.6 +:maven-version: 3.9.7 :graalvm-version: for JDK 21 :graalvm-docs-version: jdk21 :graalvm-flavor: jdk-21 :mandrel-flavor: jdk-21 :surefire-version: 3.2.5 -:gradle-version: 8.7 +:gradle-version: 8.8 :elasticsearch-version: 8.13.2 :elasticsearch-image: docker.io/elastic/elasticsearch:8.13.2 :opensearch-image: docker.io/opensearchproject/opensearch:2.13.0 @@ -18,15 +18,17 @@ :infinispan-protostream-version: ${infinispan.protostream.version} :logstash-image: docker.io/elastic/logstash:8.13.2 :kibana-image: docker.io/elastic/kibana:8.13.2 -:keycloak-docker-image: quay.io/keycloak/keycloak:23.0.7 -:jandex-version: 3.1.8 +:keycloak-docker-image: quay.io/keycloak/keycloak:24.0.4 +:jandex-version: 3.2.0 :jandex-gradle-plugin-version: 1.0.0 -:kotlin-version: 1.9.23 -:grpc-version: 1.63.0 +:kotlin-version: 2.0.0 +:grpc-version: 1.64.0 :protoc-version: 3.25.0 :gcf-invoker-version: 1.3.0 -:hibernate-orm-version: 6.5 -:hibernate-search-version: 7.1 +// Cannot simply use the name 'hibernate-*-version' here as it somehow gets +// overridden to the full version, at least when building locally. +:hibernate-orm-version-major-minor: 6.5 +:hibernate-search-version-major-minor: 7.1 // . :quarkus-home-url: https://quarkus.io :quarkus-org-url: https://github.com/quarkusio @@ -49,8 +51,8 @@ :quickstarts-blob-url: https://github.com/quarkusio/quarkus-quickstarts/blob/main :quickstarts-tree-url: https://github.com/quarkusio/quarkus-quickstarts/tree/main // . -:hibernate-orm-docs-url: https://docs.jboss.org/hibernate/orm/{hibernate-orm-version}/userguide/html_single/Hibernate_User_Guide.html -:hibernate-search-docs-url: https://docs.jboss.org/hibernate/search/{hibernate-search-version}/reference/en-US/html_single/ +:hibernate-orm-docs-url: https://docs.jboss.org/hibernate/orm/{hibernate-orm-version-major-minor}/userguide/html_single/Hibernate_User_Guide.html +:hibernate-search-docs-url: https://docs.jboss.org/hibernate/search/{hibernate-search-version-major-minor}/reference/en-US/html_single/ // . :amazon-services-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-amazon-services/dev/index.html :config-consul-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-config-extensions/dev/consul.html diff --git a/_guides/building-my-first-extension.adoc b/_guides/building-my-first-extension.adoc index fcc64b2a35b..ef66e3d96ad 100644 --- a/_guides/building-my-first-extension.adoc +++ b/_guides/building-my-first-extension.adoc @@ -171,7 +171,7 @@ Your extension is a multi-module project. So let's start by checking out the par runtime - 3.12.1 + 3.13.0 ${surefire-plugin.version} 17 UTF-8 @@ -883,7 +883,7 @@ $ mvn clean compile quarkus:dev [INFO] Using 'UTF-8' encoding to copy filtered resources. [INFO] Copying 1 resource [INFO] -[INFO] --- maven-compiler-plugin:3.12.1:compile (default-compile) @ greeting-app --- +[INFO] --- maven-compiler-plugin:3.13.0:compile (default-compile) @ greeting-app --- [INFO] Nothing to compile - all classes are up to date [INFO] [INFO] --- quarkus-maven-plugin:{quarkus-version}:dev (default-cli) @ greeting-app --- diff --git a/_guides/container-image.adoc b/_guides/container-image.adoc index 2ec5a802577..b08fcf1ab84 100644 --- a/_guides/container-image.adoc +++ b/_guides/container-image.adoc @@ -6,14 +6,15 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc = Container Images include::_attributes.adoc[] :categories: cloud -:summary: Learn how to build and push container images with Jib, OpenShift or Docker as part of the Quarkus build. +:summary: Learn how to build and push container images with Jib, OpenShift, Docker, or Podman as part of the Quarkus build. :topics: devops,cloud -:extensions: io.quarkus:quarkus-container-image-openshift,io.quarkus:quarkus-container-image-jib,io.quarkus:quarkus-container-image-docker,io.quarkus:quarkus-container-image-buildpack +:extensions: io.quarkus:quarkus-container-image-openshift,io.quarkus:quarkus-container-image-jib,io.quarkus:quarkus-container-image-docker,io.quarkus:quarkus-container-image-podman,io.quarkus:quarkus-container-image-buildpack Quarkus provides extensions for building (and pushing) container images. Currently, it supports: - <<#jib,Jib>> - <<#docker,Docker>> +- <<#podman,Podman>> - <<#openshift,OpenShift>> - <<#buildpack,Buildpack>> @@ -120,6 +121,16 @@ The `quarkus-container-image-docker` extension is capable of https://docs.docker NOTE: `docker buildx build` ONLY supports https://docs.docker.com/engine/reference/commandline/buildx_build/#load[loading the result of a build] to `docker images` when building for a single platform. Therefore, if you specify more than one argument in the `quarkus.docker.buildx.platform` property, the resulting images will not be loaded into `docker images`. If `quarkus.docker.buildx.platform` is omitted or if only a single platform is specified, it will then be loaded into `docker images`. +[[podman]] +=== Podman + +The extension `quarkus-container-image-podman` uses https://podman.io/[Podman] and the generated `Dockerfiles` under `src/main/docker` in order to perform container builds. + +To use this feature, add the following extension to your project. + +:add-extension-extensions: container-image-podman +include::{includes}/devtools/extension-add.adoc[] + [[openshift]] === OpenShift @@ -204,7 +215,7 @@ NOTE: If no registry is set (using `quarkus.container-image.registry`) then `doc It does not make sense to use multiple extension as part of the same build. When multiple container image extensions are present, an error will be raised to inform the user. The user can either remove the unneeded extensions or select one using `application.properties`. -For example, if both `container-image-docker` and `container-image-openshift` are present and the user needs to use `container-image-docker`: +For example, if both `container-image-docker` and `container-image-podman` are present and the user needs to use `container-image-docker`: [source,properties] ---- @@ -255,6 +266,13 @@ In addition to the generic container image options, the `container-image-docker` include::{generated-dir}/config/quarkus-container-image-docker.adoc[opts=optional, leveloffset=+1] +[[PodmanOptions]] +=== Podman Options + +In addition to the generic container image options, the `container-image-podman` also provides the following options: + +include::{generated-dir}/config/quarkus-container-image-podman.adoc[opts=optional, leveloffset=+1] + === OpenShift Options In addition to the generic container image options, the `container-image-openshift` also provides the following options: diff --git a/_guides/databases-dev-services.adoc b/_guides/databases-dev-services.adoc index 72e64e7afef..e8a640c5dd1 100644 --- a/_guides/databases-dev-services.adoc +++ b/_guides/databases-dev-services.adoc @@ -166,7 +166,7 @@ quarkus.datasource.db-kind=mysql quarkus.datasource.devservices.volumes."/local/test/data"=/var/lib/mysql ---- -When starting Dev Services (for example, in tests or in DEV mode), you will see that the folder "/local/test/data" will be created at your file sytem and that will contain all the database data. When rerunning again the same dev services, this data will contain all the data you might have created beforehand. +When starting Dev Services (for example, in tests or in dev mode), you will see that the folder "/local/test/data" will be created at your file sytem and that will contain all the database data. When rerunning again the same dev services, this data will contain all the data you might have created beforehand. [IMPORTANT] ==== diff --git a/_guides/datasource.adoc b/_guides/datasource.adoc index 3b8fcd73aa9..13829975487 100644 --- a/_guides/datasource.adoc +++ b/_guides/datasource.adoc @@ -101,7 +101,9 @@ For more information about pool size adjustment properties, see the < + enabled: true <2> + exporter-protocol: "OTLP" <3> + service-name: "infinispan-server" <4> + security: false <5> +---- +<1> Collector endpoint. Assuming a container service name 'jaeger' is running. +<2> Enables tracing. +<3> Exporter protocol. OLTP is the OpenTelemetry protocol. +<4> The service name that will be registered in the tracing collector, Jaeger in this case. +<5> Enables 'security' category tracing. + +See below the equivalent in XML and JSON. + +[source, xml] +---- + + + + + +---- + +[source, json] +---- +{ + "infinispan" : { + "cache-container" : { + "statistics" : true, + "tracing" : { + "collector-endpoint" : "http://jaeger:4318", + "enabled" : true, + "exporter-protocol" : "OTLP", + "service-name" : "infinispan-server", + "security" : false + } + } + } +} +---- + +You need to name the Jaeger service or get the IP running the following command to configure the exporter endpoint. [source,bash] ---- diff --git a/_guides/jfr.adoc b/_guides/jfr.adoc new file mode 100644 index 00000000000..9251fa3587a --- /dev/null +++ b/_guides/jfr.adoc @@ -0,0 +1,364 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += Using JDK Flight Recorder +include::_attributes.adoc[] +:categories: observability +:summary: This guide explains how JDK Flight Recorder can be extended to provide insight into your Quarkus application. +:topics: observability,jfr +:extensions: io.quarkus:quarkus-jfr + +This guide explains how https://openjdk.org/jeps/328[JDK Flight Recorder] (JFR) can be extended to provide insight into your Quarkus application. +insight into itself. +JFR records various information from the Java standard API and JVM as events. +By adding this extension, you can add custom Quarkus events to JFR. This will help you solve problems in your application. + +JFR can be preconfigured to dump a file, and when the application exits, JFR will output the file. +The file will contain the contents of the JFR event stream to which Quarkus custom events have also been added. +You can, of course, get this file at any time you want, even if your application exits unexpectedly. + +== Prerequisites + +:prerequisites: +include::{includes}/prerequisites.adoc[] + +== Architecture + +In this guide, we create a straightforward REST application to demonstrate JFR. + +== Creating the Maven project + +First, we need a new project. Create a new project with the following command: + +:create-app-artifact-id: jfr-quickstart +:create-app-extensions: quarkus-rest,quarkus-jfr +include::{includes}/devtools/create-app.adoc[] + +This command generates the Maven project and imports the `quarkus-jfr` extension, +which includes the default JFR support. + +If you already have your Quarkus project configured, you can add the `quarkus-jfr` extension +to your project by running the following command in your project base directory: + +:add-extension-extensions: quarkus-jfr +include::{includes}/devtools/extension-add.adoc[] + +This will add the following to your build file: + +[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] +.pom.xml +---- + + io.quarkus + quarkus-jfr + +---- + +[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] +.build.gradle +---- +implementation("io.quarkus:quarkus-jfr") +---- + +=== Examine the Jakarta REST resource + +Create a `src/main/java/org/acme/jfr/JfrResource.java` file with the following content: + +[source,java] +---- +package org.acme.jfr; + +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.core.MediaType; + +@Path("/hello") +public class JfrResource { + + @GET + @Produces(MediaType.TEXT_PLAIN) + public String hello() { + return "hello"; + } +} +---- + +Notice that there is no JFR specific code included in the application. By default, requests sent to this +endpoint will be recorded into JFR without any required code changes. + +=== Running Quarkus applications and JFR + +Now we are ready to run our application. +We can launch the application with JFR configured to be enabled from the startup of the Java Virtual Machine. + +:dev-additional-parameters: -Djvm.args="-XX:StartFlightRecording=name=quarkus,dumponexit=true,filename=myrecording.jfr" +include::{includes}/devtools/dev.adoc[] + +With the JDK Flight Recorder and the application running, we can make a request to the provided endpoint: + +[source,shell] +---- +$ curl http://localhost:8080/hello +hello +---- + +This is all that was needed to write the information to the JFR. + +=== Save the JFR to a file +As mentioned above,　the Quarkus application was configured to also start JFR at startup and dump it to a `myrecording.jfr` when it terminates. +So we can get the file when we hit `CTRL+C` or type `q` to stop the application. + +Or, we can also dump with the jcmd command. + +---- +jcmd JFR.dump name=quarkus filename=myrecording.jfr +---- + +[NOTE] +==== +Running jcmd command give us a list of running Java processes and the PID of each process. +==== + +== Open JFR dump file + +We can open a JFR dump using two tools: Jfr CLI and JDK Mission Control (JMC). +It is also possible to read them using JFR APIs, but we won't go into that here. + +=== jfr CLI + +The jfr CLI is a tool included in OpenJDK. The executable file is `$JAVA_HOME/bin/jfr`. +We can use the jfr CLI to see a list of events limited to those related to Quarkus in the dump file by doing the following. + +---- +jfr print --categories quarkus myrecording.jfr +---- + +=== JDK Mission Control + +JMC is essentially a GUI viewer for JFR. +Some distributions include JMC in OpenJDK binary, but if not, we need to download it manually. +To see a list of events using the JMC, first we load the JFR file in the JMC as follows. + +---- +jmc -open myrecording.jfr +---- + +After opening the JFR file, we have two options. +One is to view the events as a tabular list, and the other is to view the events on the threads in which they occurred, in chronological order. + +To view Quarkus events in tabular style, select the Event Browser on the left side of the JMC, then open the Quarkus event type tree on the right side of the JMC. + +image::jfr-event-browser.png[alt=JDK Mission Control Event Browser view,role="center"] + +To see Quarkus events in chronological order on a thread, select the `Java application` and `Threads` on the left side of the JMC. + +image::jfr-java-ap-thread.png[alt=JDK Mission Control thread view,role="center"] + +The standard configuration does not show Quarkus events. +We have to do three tasks to see the Quarkus events. + +1. Right-click and select `Edit Thread Activity Lanes...`. +2. Select the plus button to add a new lane on the left side, then check to display that lane. +3. Select Quarkus as the event type that lane will display and press OK. + +image::jfr-edit-thread-activity-lanes.png[alt=JDK Mission Control Edit Thread Activity Lanes,role="center"] + +Now we can see the Quarkus events per thread. + +image::jfr-thread.png[alt=JDK Mission Control thread view,role="center"] + +[NOTE] +==== +Non-blocking is where multiple processes are processed apparently simultaneously in a single thread. +Therefore, this extension records multiple JFR events concurrently, and a number of events might overlap on the JMC. +This could make it difficult for you to see the events you want to see. +To avoid this, we recommend to use xref:#identifying-requests[Request ID] to filter events so that you only see the information about the requests you want to see. +==== + +== Events + +=== Identifying Requests +This extension works with the OpenTelemetry extension. +The events recorded by this extension have a trace ID and a span ID. These are recorded with the OpenTelemetry IDs respectively. + +This means that after we identify the trace and span IDs of interest from the UI provided by the OpenTelemetry implementation, we can immediately jump to the details in JFR using those IDs. + +If we have not enabled the OpenTelemetry extension, this extension creates an ID for each request and links it to JFR events as a traceId. +In this case, the span ID will be null. + +For now, Quarkus only has REST events, but we plan to use this ID to link each event to each other as we add more events in the future. + +=== Event Implementation Policy +When JFR starts recording an event, the event does not record to JFR yet, but when it commits that event, the event is recorded. +Therefore, events that have started recording at dump time but have not yet been committed are not dumped. +This is unavoidable due to the design of JFR. +This means that events are not recorded forever if there are prolonged processing. +Therefore, you will not be aware of prolonged processing. + +To solve this problem, Quarkus can also record start and end events at the beginning and end of processing. +These events are disabled by default. +However, we can enable these events on JFR.(described below) + +=== REST API Event +This event is recorded when either `quarkus-rest` or `resteasy-classic` extension is enabled. +The following three JFR events are recorded as soon as REST server processing is complete. + +- REST +- REST Start +- REST End + +REST Event records the time period from the start of the REST process to the end of the REST server process. + +REST Start Event records the start of the REST server process. + +REST End Event records the end of the REST server process. + +These events have the following information. + +- HTTP Method +- URI +- Resource Class +- Resource Method +- Client + +HTTP Method records the HTTP Method accessed by the client. +This will record a string of HTTP methods such as GET, POST, DELETE, and other general HTTP methods. + +URI records the URI path accessed by the client. +This does not include host names or port numbers. + +Resource Class records the class that was executed. +We can check whether the Resource Class was executed as expected by the HTTP Method and URI. + +Resource Method records the method that was executed. +We can check if the Resource Method was executed as expected by the HTTP Method and URI. + +Client records information about the accessing client. + +=== Native Image +Native image supports JDK Flight Recorder. +This extension also supports native images. +To enable JFR on Native image, it is usually built with `--enable-monitoring`. +However, we can enable JFR in Quarkus Native images by adding `jfr` to the configuration `quarkus.native.monitoring`. +There are two ways to set up this configuration: by including it in `application.properties` or by specifying it at build time. + +The first method is to first configure settings in `application.properties`. + +application.properties +``` +quarkus.native.monitoring=jfr +``` +Next, simply build as `./mvnw package -Dnative`. + +The second way is to give `-Dquarkus.native.monitoring=jfr` at build time and build as `./mvnw package -Dnative -Dquarkus.native.monitoring=jfr`. + +Once we have finished building the Native image, we can run the native application with JFR as follows + +``` +target/your-application-runner -XX:StartFlightRecording=name=quarkus,dumponexit=true,filename=myrecording.jfr +``` + +[NOTE] +==== +Note that at this time, GraalVM is not possible to record JFR on Windows native images. +==== + +== JFR configuration + +We can use the JFR CLI to configure the events that JFR will record. +The configuration file, JFC file, is in XML format, so we can modify with a text editor. +However, we should use `jfr configure`, which is included in OpenJDK by default. + +Here we create a configuration file in which RestStart and RestEnd events are recorded, which are not recorded by default. +---- +jfr configure --input default.jfc +quarkus.RestStart#enabled=true +quarkus.RestEnd#enabled=true --output custom-rest.jfc +---- +This creates `custom-rest.jfc` as a configuration file with RestStart and RestEnd enabled. + +Now we are ready to run our application with new settings. We launch the application with JFR configured to be enabled from the startup of the Java Virtual Machine. + +:dev-additional-parameters: -Djvm.args="-XX:StartFlightRecording=name=quarkus,settings=./custom-rest.jfc,dumponexit=true,filename=myrecording.jfr" +include::{includes}/devtools/dev.adoc[] + + +== Developing new events into quarkus-jfr extension. + +This section is for those who would like to add new events with this extension. + +We recommend that new events be associated with existing events. +Associations are useful when looking at the details of a process that is taking a long time. +For example, a general REST application retrieves the data needed for processing from a data store. +If REST events are not associated with datastore events, it is impossible to know which datastore events were processed in each REST request. +When the two events are associated, we know immediately which datastore event was processed in each REST request. + +[NOTE] +==== +Data store events are not implemented yet. +==== + +The quarkus-jfr extension provides a Request ID for event association. +See Identifying Requests for more information on Request IDs. + +In specific code, the following two steps are required. +First, implement `traceId` and `spanId` on the new event as follows +The `@TraceIdRelational` and `@SpanIdRelational` attached to these events will provide the association. + +[source,java] +---- +import io.quarkus.jfr.runtime.SpanIdRelational; +import io.quarkus.jfr.runtime.TraceIdRelational; +import jdk.jfr.Description; +import jdk.jfr.Event; +import jdk.jfr.Label; + +public class NewEvent extends Event { + + @Label("Trace ID") + @Description("Trace ID to identify the request") + @TraceIdRelational + protected String traceId; + + @Label("Span ID") + @Description("Span ID to identify the request if necessary") + @SpanIdRelational + protected String spanId; + + // other properties which you want to add + // setters and getters +} +---- + +Then you get the information to store in them from the `IdProducer` object's `getTraceId()` and `getSpanId()`. + +[source,java] +---- +import io.quarkus.jfr.runtime.IdProducer; + +public class NewInterceptor { + + @Inject + IdProducer idProducer; + + private void recordedInvoke() { + NewEvent event = new NewEvent(); + event.begin(); + + // The process you want to measure + + event.end(); + if (endEvent.shouldCommit()) { + event.setTraceId(idProducer.getTraceId()); + event.setSpanId(idProducer.getSpanId()); + // call other setters which you want to add + endEvent.commit(); + } + } +} +---- + +== quarkus-jfr Configuration Reference + +include::{generated-dir}/config/quarkus-jfr.adoc[leveloffset=+1, opts=optional] diff --git a/_guides/jreleaser.adoc b/_guides/jreleaser.adoc index 19a0184157d..a1886cd6432 100644 --- a/_guides/jreleaser.adoc +++ b/_guides/jreleaser.adoc @@ -619,7 +619,7 @@ As a reference, these are the full contents of the `pom.xml`: ${project.build.directory}/distributions - 3.12.1 + 3.13.0 true 17 17 diff --git a/_guides/kafka-dev-services.adoc b/_guides/kafka-dev-services.adoc index 2937185d7bf..8b61148eaf3 100644 --- a/_guides/kafka-dev-services.adoc +++ b/_guides/kafka-dev-services.adoc @@ -82,7 +82,7 @@ For Strimzi, you can select any image with a Kafka version which has Kraft suppo [source, properties] ---- -quarkus.kafka.devservices.image-name=quay.io/strimzi-test-container/test-container:0.105.0-kafka-3.6.0 +quarkus.kafka.devservices.image-name=quay.io/strimzi-test-container/test-container:0.106.0-kafka-3.7.0 ---- == Configuring Kafka topics diff --git a/_guides/kafka-getting-started.adoc b/_guides/kafka-getting-started.adoc index 86c795b6e70..3e722be1774 100644 --- a/_guides/kafka-getting-started.adoc +++ b/_guides/kafka-getting-started.adoc @@ -408,7 +408,7 @@ version: '3.5' services: zookeeper: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/zookeeper-server-start.sh config/zookeeper.properties" @@ -421,7 +421,7 @@ services: - kafka-quickstart-network kafka: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/kafka-server-start.sh config/server.properties --override listeners=$${KAFKA_LISTENERS} --override advertised.listeners=$${KAFKA_ADVERTISED_LISTENERS} --override zookeeper.connect=$${KAFKA_ZOOKEEPER_CONNECT}" diff --git a/_guides/kafka-schema-registry-avro.adoc b/_guides/kafka-schema-registry-avro.adoc index 6a7766b8034..2800ef99f00 100644 --- a/_guides/kafka-schema-registry-avro.adoc +++ b/_guides/kafka-schema-registry-avro.adoc @@ -324,7 +324,7 @@ version: '2' services: zookeeper: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/zookeeper-server-start.sh config/zookeeper.properties" @@ -335,7 +335,7 @@ services: LOG_DIR: /tmp/logs kafka: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/kafka-server-start.sh config/server.properties --override listeners=$${KAFKA_LISTENERS} --override advertised.listeners=$${KAFKA_ADVERTISED_LISTENERS} --override zookeeper.connect=$${KAFKA_ZOOKEEPER_CONNECT}" diff --git a/_guides/kafka-schema-registry-json-schema.adoc b/_guides/kafka-schema-registry-json-schema.adoc index 63d540d191a..5dc85d8a6b3 100644 --- a/_guides/kafka-schema-registry-json-schema.adoc +++ b/_guides/kafka-schema-registry-json-schema.adoc @@ -352,7 +352,7 @@ version: '2' services: zookeeper: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/zookeeper-server-start.sh config/zookeeper.properties" @@ -363,7 +363,7 @@ services: LOG_DIR: /tmp/logs kafka: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/kafka-server-start.sh config/server.properties --override listeners=$${KAFKA_LISTENERS} --override advertised.listeners=$${KAFKA_ADVERTISED_LISTENERS} --override zookeeper.connect=$${KAFKA_ZOOKEEPER_CONNECT}" diff --git a/_guides/kafka-streams.adoc b/_guides/kafka-streams.adoc index db79bb2e955..1119b939acd 100644 --- a/_guides/kafka-streams.adoc +++ b/_guides/kafka-streams.adoc @@ -499,7 +499,7 @@ version: '3.5' services: zookeeper: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/zookeeper-server-start.sh config/zookeeper.properties" @@ -511,7 +511,7 @@ services: networks: - kafkastreams-network kafka: - image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1 + image: quay.io/strimzi/kafka:0.41.0-kafka-3.7.0 command: [ "sh", "-c", "bin/kafka-server-start.sh config/server.properties --override listeners=$${KAFKA_LISTENERS} --override advertised.listeners=$${KAFKA_ADVERTISED_LISTENERS} --override zookeeper.connect=$${KAFKA_ZOOKEEPER_CONNECT} --override num.partitions=$${KAFKA_NUM_PARTITIONS}" diff --git a/_guides/kafka.adoc b/_guides/kafka.adoc index 04b2d9cbd00..0abd8ab7adf 100644 --- a/_guides/kafka.adoc +++ b/_guides/kafka.adoc @@ -474,6 +474,12 @@ To use this failure handler, the bean must be exposed with the `@Identifier` qua The handler is called with details of the deserialization, including the action represented as `Uni`. On the deserialization `Uni` failure strategies like retry, providing a fallback value or applying timeout can be implemented. +If you don’t configure a deserialization failure handler and a deserialization failure happens, the application is marked unhealthy. +You can also ignore the failure, which will log the exception and produce a `null` value. +To enable this behavior, set the `mp.messaging.incoming.$channel.fail-on-deserialization-failure` attribute to `false`. + +If the `fail-on-deserialization-failure` attribute is set to `false` and the `failure-strategy` attribute is `dead-letter-queue` the failed record will be sent to the corresponding *dead letter queue* topic. + === Consumer Groups In Kafka, a consumer group is a set of consumers which cooperate to consume data from a topic. @@ -2425,7 +2431,7 @@ The configuration of the created Kafka broker can be customized using `@Resource [source,java] ---- @QuarkusTestResource(value = KafkaCompanionResource.class, initArgs = { - @ResourceArg(name = "strimzi.kafka.image", value = "quay.io/strimzi-test-container/test-container:0.105.0-kafka-3.6.0"), // Image name + @ResourceArg(name = "strimzi.kafka.image", value = "quay.io/strimzi-test-container/test-container:0.106.0-kafka-3.7.0"), // Image name @ResourceArg(name = "kafka.port", value = "9092"), // Fixed port for kafka, by default it will be exposed on a random port @ResourceArg(name = "kraft", value = "true"), // Enable Kraft mode @ResourceArg(name = "num.partitions", value = "3"), // Other custom broker configurations diff --git a/_guides/kotlin.adoc b/_guides/kotlin.adoc index eb2710ebd33..84e2e61be86 100644 --- a/_guides/kotlin.adoc +++ b/_guides/kotlin.adoc @@ -501,6 +501,9 @@ The following extensions provide support for Kotlin Coroutines by allowing the u |`quarkus-smallrye-fault-tolerance` |Support is provided for the declarative annotation-based API +|`quarkus-vertx` +|Support is provided for `@ConsumeEvent` methods + |=== === Kotlin coroutines and Mutiny diff --git a/_guides/load-shedding-reference.adoc b/_guides/load-shedding-reference.adoc new file mode 100644 index 00000000000..f5ac732d116 --- /dev/null +++ b/_guides/load-shedding-reference.adoc @@ -0,0 +1,150 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += Load Shedding reference guide +include::_attributes.adoc[] +:numbered: +:sectnums: +:categories: web +:topics: web,load-shedding +:extensions: io.quarkus:quarkus-load-shedding +:extension-status: experimental + +include::{includes}/extension-status.adoc[] + +Load shedding is the practice of detecting service overload and rejecting requests. + +In Quarkus, the `quarkus-load-shedding` extension provides a load shedding mechanism. + +== Use the Load Shedding extension + +To use the load shedding extension, you need to add the `io.quarkus:quarkus-load-shedding` extension to your project: + +[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] +.pom.xml +---- + + io.quarkus + quarkus-load-shedding + +---- + +[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] +.build.gradle +---- +implementation("io.quarkus:quarkus-load-shedding") +---- + +No configuration is required, though the possible configuration options are described below. + +== The load shedding algorithm + +The load shedding algorithm has 2 parts: + +* overload detection +* priority load shedding (optional) + +=== Overload detection + +To detect whether the current service is overloaded, an adaptation of TCP Vegas is used. + +The algorithm starts with 100 allowed concurrent requests. +For each request, it compares the number of current requests with the allowed limit and if the limit is exceeded, an overload situation is signalled. + +If the limit is not exceeded, or if priority load shedding determines that the request should not be rejected (see below), the request is allowed. +When it finishes, its duration is compared with the lowest duration seen so far to estimate a queue size. +If the queue size is lower than _alpha_, the current limit is increased, but only up to a given maximum, by default 1000. +If the queue size is greater than _beta_, the current limit is decreased. +Otherwise, the current limit is kept intact. + +Alpha and beta are computed by multiplying the configurable constants with a base 10 logarithm of the current limit. + +After some number of requests, which can be modified by configuring the _probe_ factor, the lowest duration seen is reset to the last seen duration of a request. + +=== Priority load shedding + +If an overload situation is signalled, priority load shedding is invoked. + +By default, priority load shedding is enabled, which means a request is only rejected if the current CPU load is high enough. +To determine whether a request should be rejected, 2 attributes are considered: + +* request priority +* request cohort + +There are 5 statically defined priorities and 128 cohorts, which amounts to 640 request groups in total. + +After both priority and cohort are assigned to a request, a request group number is computed: `group = priority * num_cohorts + cohort`. +Then, the group number is compared to a simple cubic function of current CPU load, where `load` is a number between 0 and 1: `num_groups * (1 - load^3)`. +If the group number is higher, the request is rejected, otherwise it is allowed even in an overload situation. + +If priority load shedding is disabled, all requests are rejected in an overload situation. + +==== Customizing request priority + +Priority is assigned by a `io.quarkus.load.shedding.RequestPrioritizer`. +There is 5 statically defined priorities in the `io.quarkus.load.shedding.RequestPriority` enum: `CRITICAL`, `IMPORTANT`, `NORMAL`, `BACKGROUND` and `DEGRADED`. +By default, if no request prioritizer applies, the priority is assumed to be `NORMAL`. + +There is one default prioritizer which assigns the priority of `CRITICAL` to requests to the non-application endpoints. +It declares no `@Priority`. + +It is possible to define custom implementations of the `RequestPrioritizer` interface. +The implementations must be CDI beans, otherwise they are ignored. +The CDI rules of typesafe resolution must be followed. +That is, if multiple implementations exist with a different `@Priority` value and some of them are ``@Alternative``s, only the alternatives with the highest priority value are retained. +If no implementation is an alternative, all implementations are retained and are sorted in descending `@Priority` order (highest priority value comes first). + +==== Customizing request cohort + +Cohort is assigned by a `io.quarkus.load.shedding.RequestClassifier`. +There is 128 statically defined cohorts, with the lowest number being 1 and highest number being 128. +The classifier should return a number in this interval; if it does not, the number is adjusted automatically. + +There is one default classifier which assigns a cohort based on a hash of the remote IP address and current time, such that an IP address changes its cohort roughly every hour. +It declares no `@Priority`. + +It is possible to define custom implementations of the `RequestClassifier` interface. +The implementations must be CDI beans, otherwise they are ignored. +The CDI rules of typesafe resolution must be followed. +That is, if multiple implementations exist with a different `@Priority` value and some of them are ``@Alternative``s, only the alternatives with the highest priority value are retained. +If no implementation is an alternative, all implementations are retained and are sorted in descending `@Priority` order (highest priority value comes first). + +== Limitations + +The load shedding extension currently only applies to HTTP requests, and is heavily skewed towards request/response network interactions. +This means that gRPC, WebSocket and other kinds of streaming over HTTP are not supported. +Other "entrypoints" to Quarkus applications, such as messaging, are not supported either. + +Further, the load shedding implementation is currently rather basic and not heavily tested in production. +Improvements may be necessary. + +== Configuration reference + +include::{generated-dir}/config/quarkus-load-shedding.adoc[opts=optional, leveloffset=+1] + +== Further reading + +Netflix Technology Blog: + +* https://netflixtechblog.medium.com/performance-under-load-3e6fa9a60581[Performance Under Load] +* https://netflixtechblog.com/keeping-netflix-reliable-using-prioritized-load-shedding-6cc827b02f94[Keeping Netflix Reliable Using Prioritized Load Shedding] + +Uber Engineering Blog: + +* https://www.uber.com/blog/cinnamon-using-century-old-tech-to-build-a-mean-load-shedder/[Cinnamon: Using Century Old Tech to Build a Mean Load Shedder] +* https://www.uber.com/blog/pid-controller-for-cinnamon/[PID Controller for Cinnamon] +* https://www.uber.com/blog/cinnamon-auto-tuner-adaptive-concurrency-in-the-wild/[Cinnamon Auto-Tuner: Adaptive Concurrency in the Wild] + +Amazon Builders' Library: + +* https://aws.amazon.com/builders-library/using-load-shedding-to-avoid-overload/[Using load shedding to avoid overload] + +Google Cloud Blog: + +* https://cloud.google.com/blog/products/gcp/using-load-shedding-to-survive-a-success-disaster-cre-life-lessons[Using load shedding to survive a success disaster] + +CodeReliant Blog: + +* https://www.codereliant.io/load-shedding/[Load Shedding for High Traffic Systems] diff --git a/_guides/mailer-reference.adoc b/_guides/mailer-reference.adoc index 93c24854938..f90c5ab62a8 100644 --- a/_guides/mailer-reference.adoc +++ b/_guides/mailer-reference.adoc @@ -362,28 +362,100 @@ More details about this extension and its configuration can be found in the http [TIP] For more information about the Mailer configuration please refer to the <>. -== Configuring a trust store +== Configuring TLS -If your SMTP requires a trust store, you can configure the trust store as follows: +SMTP provides various way to use TLS: + +- StartTLS: The client connects to the server using a plain connection and then upgrades to a secure connection. +- SSL/TLS: The client connects to the server using a secure connection from the start. + +=== Configuring STARTTLS + +To use `STARTTLS`, you need to configure the `start-tls` property to `REQUIRED` or `OPTIONAL` and set `tls` to `false`: + +[source, properties] +---- +quarkus.mailer.tls=false +quarkus.mailer.start-tls=REQUIRED +---- + +Setting `tls` to `false` ensure we connect using a plain connection and then upgrade to a secure connection using `STARTTLS`. + +To configure the trust store, you can use a _named_ TLS configuration stored in the xref:./tls-registry-reference.adoc[TLS registry]: + +[source, properties] +---- +quarkus.mailer.tls=false +quarkus.mailer.start-tls=REQUIRED +quarkus.mailer.tls-configuration-name=my-mailer # Reference the named configuration + +quarkus.tls.my-mailer.trust-store.pem.certs=server-cert.pem # Configure the trust store +---- + +While not recommended, you can trust all certificates by setting `quarkus.tls.trust-all` to `true`: + +[source, properties] +---- +quarkus.mailer.tls=false +quarkus.mailer.start-tls=REQUIRED +quarkus.mailer.tls-configuration-name=my-mailer # Reference the named configuration +quarkus.tls.my-mailer.trust-all=true +---- + +Alternatively, you can use the _deprecated_ `quarkus.mailer.trust-store.paths` and `quarkus.mailer.trust-all` properties: + +[source, properties] +---- +quarkus.mailer.tls=false +quarkus.mailer.start-tls=REQUIRED +quarkus.mailer.truststore.paths=target/certs/mailpit-ca.crt +---- [source, properties] ---- -quarkus.mailer.host=... -quarkus.mailer.port=... -quarkus.mailer.ssl=true -quarkus.mailer.trust-store.paths=truststore.jks # the path to your trust store -quarkus.mailer.trust-store.password=secret # the trust store password if any -quarkus.mailer.trust-store.type=JKS # the type of trust store if it can't be deduced from the file extension +quarkus.mailer.tls=false +quarkus.mailer.start-tls=REQUIRED +quarkus.mailer.trust-all=true ---- -Quarkus mailer supports JKS, PKCS#12 and PEM trust stores. -For PEM, you can configure multiple files. -For JKS and PKCS#12, you can configure the password if any. +=== Configuring SSL/TLS -`quarkus.mailer.trust-store.type` is optional and allows configuring the type of trust store (among `JKS`, `PEM` and `PKCS`). -When not set, Quarkus tries to deduce the type from the file name. +To establish a TLS connection, you need to configure a _named_ configuration using the xref:./tls-registry-reference.adoc[TLS registry]: -NOTE: You can also configure `quarkus.mailer.trust-all=true` to bypass the verification. +[source, properties] +---- +quarkus.tls.my-mailer.trust-store.p12.path=server-truststore.p12 +quarkus.tls.my-mailer.trust-store.p12.password=secret + +quarkus.mailer.tls-configuration-name=my-mailer # Reference the named configuration +---- + +WARNING: When using the mailer, using a _named_ configuration is required to avoid conflicts with other TLS configurations. +The mailer will not use the default TLS configuration. + +When you configure a _named_ TLS configuration, TLS is enabled by default. +If your SMTP server uses a valid (trusted) certificate, and thus do not require a specific TLS configuration, you need to enable TLS explicitly (as you do not have to configure a trust store): + +[source, properties] +---- +quarkus.mailer.tls=true +---- + + + +[IMPORTANT] +==== +When `quarkus.tls.trust-all` is set to `true`, the trust store configuration is ignored. This is not recommended for production. +Also, we recommend avoiding using `quarkus.tls.trust-all`, and use a named configuration instead if `trust-all` is required: + +[source, properties] +---- +quarkus.tls.my-mailer.trust-all=true +quarkus.mailer.tls-configuration-name=my-mailer # Reference the named configuration +---- + +You can also use the deprecated `quarkus.mailer.trust-all=true` property. +==== == Multiple mailer configurations @@ -476,7 +548,7 @@ You need to switch on 2-Step Verification at https://myaccount.google.com/securi When done, you can configure your Quarkus application by adding the following properties to your `application.properties`: -With TLS: +With `STARTTLS`: [source,properties] ---- @@ -491,7 +563,7 @@ quarkus.mailer.password=YOURGENERATEDAPPLICATIONPASSWORD quarkus.mailer.mock=false # In dev mode, prevent from using the mock SMTP server ---- -Or with SSL: +Or with TLS/SSL: [source,properties] ---- @@ -499,7 +571,7 @@ quarkus.mailer.auth-methods=DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGI quarkus.mailer.from=YOUREMAIL@gmail.com quarkus.mailer.host=smtp.gmail.com quarkus.mailer.port=465 -quarkus.mailer.ssl=true +quarkus.mailer.tls=true quarkus.mailer.username=YOUREMAIL@gmail.com quarkus.mailer.password=YOURGENERATEDAPPLICATIONPASSWORD @@ -532,6 +604,7 @@ ses.from=an email address from the verified domain quarkus.mailer.host=${ses.smtp} quarkus.mailer.port=587 +quarkus.mailer.tls=false quarkus.mailer.username=${ses.user} quarkus.mailer.password=${ses.password} quarkus.mailer.start-tls=REQUIRED @@ -565,7 +638,7 @@ quarkus.mailer.port=465 quarkus.mailer.username=${mailjet.api-key} quarkus.mailer.password=${mailjet.secret-key} quarkus.mailer.start-tls=OPTIONAL -quarkus.mailer.ssl=true +quarkus.mailer.tls=true quarkus.mailer.login=REQUIRED quarkus.mailer.from=${mailjet.from} @@ -591,13 +664,14 @@ quarkus.mailer.port=465 quarkus.mailer.username=${sendgrid.username} quarkus.mailer.password=${sendgrid.key} quarkus.mailer.start-tls=OPTIONAL -quarkus.mailer.ssl=true quarkus.mailer.login=REQUIRED quarkus.mailer.from=... +quarkus.mailer.tls=true quarkus.mailer.mock=false # In dev mode, prevent from using the mock SMTP server ---- + [[configuration-reference]] == Mailer Configuration Reference diff --git a/_guides/mongodb-dev-services.adoc b/_guides/mongodb-dev-services.adoc new file mode 100644 index 00000000000..95aad5adddc --- /dev/null +++ b/_guides/mongodb-dev-services.adoc @@ -0,0 +1,30 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += Dev Services for MongoDB + +Quarkus supports a feature called Dev Services that allows you to create various datasources without any config. In the case of MongoDB this support extends to the default MongoDB connection. +What that means practically, is that if you have not configured `quarkus.mongodb.connection-string`, Quarkus will automatically start a MongoDB container when running tests or in dev mode, +and automatically configure the connection. + +MongoDB Dev Services is based on link:https://www.testcontainers.org/modules/databases/mongodb/[Testcontainers MongoDB module] that will start a single node replicaset. + +When running the production version of the application, the MongoDB connection need to be configured as normal, so if you want to include a production database config in your +`application.properties` and continue to use Dev Services we recommend that you use the `%prod.` profile to define your MongoDB settings. + + +== Shared server + +Most of the time you need to share the server between applications. +Dev Services for MongoDB implements a _service discovery_ mechanism for your multiple Quarkus applications running in _dev_ mode to share a single server. + +NOTE: Dev Services for MongoDB starts the container with the `quarkus-dev-service-mongodb` label which is used to identify the container. + +If you need multiple (shared) servers, you can configure the `quarkus.mongodb.devservices.service-name` attribute and indicate the server name. +It looks for a container with the same value, or starts a new one if none can be found. +The default service name is `mongodb`. + +Sharing is enabled by default in dev mode, but disabled in test mode. +You can disable the sharing with `quarkus.mongodb.devservices.shared=false`. diff --git a/_guides/mongodb.adoc b/_guides/mongodb.adoc index cd069975a52..94998df1eb0 100644 --- a/_guides/mongodb.adoc +++ b/_guides/mongodb.adoc @@ -241,18 +241,9 @@ WARNING: By default, Quarkus will restrict the use of JNDI within an application Because the `mongo+srv` protocol often used to connect to MongoDB requires JNDI, this protection is automatically disabled when using the MongoDB client extension. [[dev-services]] -=== Dev Services (Configuration Free Databases) +=== Use the MongoDB Dev Services -Quarkus supports a feature called Dev Services that allows you to create various datasources without any config. In the case of MongoDB this support extends to the default MongoDB connection. -What that means practically, is that if you have not configured `quarkus.mongodb.connection-string`, Quarkus will automatically start a MongoDB container when running tests or in dev mode, -and automatically configure the connection. - -MongoDB Dev Services is based on link:https://www.testcontainers.org/modules/databases/mongodb/[Testcontainers MongoDB module] that will start a single node replicaset. - -When running the production version of the application, the MongoDB connection need to be configured as normal, so if you want to include a production database config in your -`application.properties` and continue to use Dev Services we recommend that you use the `%prod.` profile to define your MongoDB settings. - -include::{generated-dir}/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc[opts=optional, leveloffset=+1] +See xref:mongodb-dev-services.adoc[MongoDB Dev Services]. == Multiple MongoDB Clients @@ -616,6 +607,18 @@ This behavior must first be enabled by setting the `quarkus.mongodb.metrics.enab So when you access the `/q/metrics` endpoint of your application you will have information about the connection pool status. When using xref:smallrye-metrics.adoc[SmallRye Metrics], connection pool metrics will be available under the `vendor` scope. + +== Tracing + +To use tracing with MongoDB, you need to add the xref:opentelemetry.adoc[`quarkus-opentelemetry`] extension to your project. + +Even with all the tracing infrastructure in place the mongodb tracing is not enabled by default, and you need to enable it by setting this property: +[source, properties] +---- +# enable tracing +quarkus.mongodb.tracing.enabled=true +---- + == Testing helpers xref:#dev-services[Dev Services for MongoDB] is your best option to start a MongoDB database for your unit tests. diff --git a/_guides/native-and-ssl.adoc b/_guides/native-and-ssl.adoc index 23e8bb07792..86e14bf5173 100644 --- a/_guides/native-and-ssl.adoc +++ b/_guides/native-and-ssl.adoc @@ -233,7 +233,7 @@ However, this comes with a few drawbacks: * If you use the same executable in all environments, and a certificate expires, the application needs to be rebuilt, and redeployed into production with the new certificate, which is an inconvenience. * Even worse, if a certificate gets revoked because of a security breach, all applications that embed this certificate need to be rebuilt and redeployed in a timely manner. - * This requires also to add into the application all certificates for all environments (e.g. DEV, TEST, PROD), which means that a certificate that is required for DEV but should not be used elsewhere, will make its way anyway in production. + * This requires also to add into the application all certificates for all environments (e.g. `dev`, `test`, `prod`), which means that a certificate that is required for dev mode but should not be used elsewhere, will make its way anyway in production. * Providing all certificates at build time complicates the CI, specifically in dynamic environments such as Kubernetes where valid certificates are provided by the platform in the `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` PEM file. * Lastly, this does not play well with third party software that do not provide a dedicated build for each customer environment. diff --git a/_guides/native-reference.adoc b/_guides/native-reference.adoc index 8c7d741a5a8..b28ec249a15 100644 --- a/_guides/native-reference.adoc +++ b/_guides/native-reference.adoc @@ -528,6 +528,283 @@ ${FG_HOME}/stackcollapse.pl < out.stacks | ${FG_HOME}/flamegraph.pl \ --color=mem --title="mmap munmap Flame Graph" --countname="calls" > out.svg ---- +[[native-image-agent-integration]] +== Native Image Tracing Agent Integration + +Quarkus users that want to integrate new libraries/components into native image process +(e.g. link:https://github.com/hierynomus/smbj[smbj]), +or want to use JDK APIs that require extensive native image configuration to work (e.g. graphical user interfaces), +face a considerable challenge coming up with the native image configuration to make their use cases work. +These users can tweak their applications to run in JVM mode with the native image agent in order to +auto-generate native image configuration that will help them get a head start getting applications to work as native executables. + +The native image tracing agent is a JVM tool interface (JVMTI) agent available within both GraalVM and Mandrel that +tracks all usages of dynamic features such as reflection, JNI, dynamic proxies, access classpath resources...etc, +during an application's regular JVM execution. +When the JVM stops, it dumps the information on the dynamic features used during the run +onto a collection of native image configuration files that can be used in subsequent native image builds. + +Using the agent and applying the generated data can be difficult for Quarkus users. +First, the agent can be cumbersome because it requires the JVM arguments to be modified, +and the generated configuration needs to be placed in a specific location such that the subsequent native image builds picks them up. +Secondly, the native image configuration produced contains a lot of superfluous configuration that the Quarkus integration takes care of. + +Native image tracing agent integration is included in Quarkus to make the agent easier to consume. +In this section you will learn about the integration and how to apply it to your Quarkus application. + +[NOTE] +==== +The integration is currently only available for Maven applications. +link:https://github.com/quarkusio/quarkus/issues/40361[Gradle integration] will follow up. +==== + +=== Integration Testing with the Tracing Agent + +Quarkus users can now run JVM mode integration tests on Quarkus Maven applications transparently with the native image tracing agent. +To do this make sure a container runtime is available, +because JVM mode integration tests will run using the JVM within the default Mandrel builder container image. +This image contains the agent libraries required to produce native image configuration, +hence avoiding the need for a local Mandrel or GraalVM installation. + +[TIP] +==== +It is highly recommended to align the Mandrel version used in integration testing +with the Mandrel version used to build native executables. +Doing in-container native builds with the default Mandrel builder image, +is the safest way to keep both versions aligned. +==== + +Additionally make sure that the `native-image-agent` goal is present in the `quarkus-maven-plugin` configuration: + +[source,bash] +---- + + ${quarkus.platform.group-id} + quarkus-maven-plugin + ... + + + + ... + native-image-agent + + + + +---- + +With a container runtime running, +invoke Maven's `verify` goal with `-DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent` to run the JVM mode integration tests and +generate the native image configuration. +For example: + +[source,bash] +---- +$ ./mvnw verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent +... +[INFO] --- failsafe:3.2.5:integration-test (default) @ new-project --- +... +[INFO] ------------------------------------------------------- +[INFO] T E S T S +[INFO] ------------------------------------------------------- +[INFO] Running org.acme.GreetingResourceIT +2024-05-14 16:29:53,941 INFO [io.qua.tes.com.DefaultDockerContainerLauncher] (main) Executing "podman run --name quarkus-integration-test-PodgW -i --rm --user 501:20 -p 8081:8081 -p 8444:8444 --entrypoint java -v /tmp/new-project/target:/project --env QUARKUS_LOG_CATEGORY__IO_QUARKUS__LEVEL=INFO --env QUARKUS_HTTP_PORT=8081 --env QUARKUS_HTTP_SSL_PORT=8444 --env TEST_URL=http://localhost:8081 --env QUARKUS_PROFILE=test-with-native-agent --env QUARKUS_TEST_INTEGRATION_TEST_PROFILE=test-with-native-agent quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21 -agentlib:native-image-agent=access-filter-file=quarkus-access-filter.json,caller-filter-file=quarkus-caller-filter.json,config-output-dir=native-image-agent-base-config, -jar quarkus-app/quarkus-run.jar" +... +[INFO] +[INFO] --- quarkus:{quarkus-version}:native-image-agent (default) @ new-project --- +[INFO] Discovered native image agent generated files in /tmp/new-project/target/native-image-agent-final-config +[INFO] +... +---- + +When the Maven invocation completes, +you can inspect the generated configuration in the `target/native-image-agent-final-config` folder: + +[source,bash] +---- +$ cat ./target/native-image-agent-final-config/reflect-config.json +[ +... +{ + "name":"org.acme.Alice", + "methods":[{"name":"","parameterTypes":[] }, {"name":"sayMyName","parameterTypes":[] }] +}, +{ + "name":"org.acme.Bob" +}, +... +] +---- + +=== Informative By Default + +By default the generated native image configuration files are not used by subsequent native image building processes. +This precaution is taken to avoid situations where seemingly unrelated actions have unintended consequences on the native executable produced, +e.g. disabling randomly failing tests. + +Quarkus users are free to copy the files from the folder reported in the build, +store them under source control and evolve as needed. +Ideally these files should be stored under the `src/main/resources/META-INF/native-image//`` folder, +in which case the native image process will automatically pick them up. + +[WARNING] +==== +If managing native image agent configuration files manually, +it is highly recommended to regenerate them each time a Mandrel version update occurs, +because the configuration necessary to make the application work might have varied due to internal Mandrel changes. +==== + +It is possible to instruct Quarkus to optionally apply the generated native image configuration files into subsequent native image processes, +by setting the -Dquarkus.native.agent-configuration-apply` property. +This can be useful to verify that the native integration tests work as expected, +assuming that the JVM unit tests have generated the correct native image configuration. +The typical workflow here would be to first run the integration tests with the native image agent as shown in the previous section: + +[source,bash] +---- +$ ./mvnw verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent +... +[INFO] --- quarkus:{quarkus-version}:native-image-agent (default) @ new-project --- +[INFO] Discovered native image agent generated files in /tmp/new-project/target/native-image-agent-final-config +---- + +And then request a native build passing in the configuration apply flag. +A message during the native build process will indicate that the native image agent generated configuration files are being applied: + +[source,bash] +---- +$ ./mvnw verify -Dnative -Dquarkus.native.agent-configuration-apply +... +[INFO] --- quarkus:{quarkus-version}:build (default) @ new-project --- +[INFO] [io.quarkus.deployment.pkg.steps.JarResultBuildStep] Building native image source jar: /tmp/new-project/target/new-project-1.0.0-SNAPSHOT-native-image-source-jar/new-project-1.0.0-SNAPSHOT-runner.jar +[INFO] [io.quarkus.deployment.steps.ApplyNativeImageAgentConfigStep] Applying native image agent generated files to current native executable build +---- + +=== Debugging the Tracing Agent Integration + +If the generated native image agent configuration is not satisfactory, +more information can be obtained using any of the following techniques: + +==== Debugging Filters + +Quarkus generates native image tracing agent configuration filters. +These filters exclude commonly used packages for which Quarkus already applies the necessary configuration. + +If native image agent is generating a configuration that it’s not working as expected, +you should check that the configuration files include the expected information. +For example, if some method happens to be accessed via reflection at runtime and you get an error, +you want to verify that the configuration file contains a reflection entry for that method. + +If the entry is missing, it could be that some call path is being filtered that maybe shouldn’t have been. +To verify that, inspect the contents of `target/quarkus-caller-filter.json` and `target/quarkus-access-filter.json` files, +and confirm that the class and/or package making the call or being accessed is not being filtered out. + +If the missing entry is related to some resource, +you should inspect the Quarkus build debug output and verify which resource patterns are being discarded, e.g. + +[source,bash] +---- +$ ./mvnw -X verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent +... +[INFO] --- quarkus:{quarkus-version}:native-image-agent (default) @ new-project --- +... +[DEBUG] Discarding resources from native image configuration that match the following regular expression: .*(application.properties|jakarta|jboss|logging.properties|microprofile|quarkus|slf4j|smallrye|vertx).* +[DEBUG] Discarded included resource with pattern: \\QMETA-INF/microprofile-config.properties\\E +[DEBUG] Discarded included resource with pattern: \\QMETA-INF/services/io.quarkus.arc.ComponentsProvider\\E +... +---- + +==== Tracing Agent Logging + +The native image tracing agent can log the method invocations that result in the generated configuration to a JSON file. +This can help understand why a configuration entry is generated. +To enable this logging, +`-Dquarkus.test.native.agent.output.property.name=trace-output` and +`-Dquarkus.test.native.agent.output.property.value=native-image-agent-trace-file.json` +system properties need to be added. +For example: + +[source,bash] +---- +$ ./mvnw verify -DskipITs=false \ + -Dquarkus.test.integration-test-profile=test-with-native-agent \ + -Dquarkus.test.native.agent.output.property.name=trace-output \ + -Dquarkus.test.native.agent.output.property.value=native-image-agent-trace-file.json +---- + +When trace output is configured, no native image configuration is generated, +and instead a `target/native-image-agent-trace-file.json` file is generated that contains trace information. +For example: + +[source,json] +---- +[ +{"tracer":"meta", "event":"initialization", "version":"1"}, +{"tracer":"meta", "event":"phase_change", "phase":"start"}, +{"tracer":"jni", "function":"FindClass", "caller_class":"java.io.ObjectStreamClass", "result":true, "args":["java/lang/NoSuchMethodError"]}, +... +{"tracer":"reflect", "function":"findConstructorHandle", "class":"io.vertx.core.impl.VertxImpl$1$1$$Lambda/0x000000f80125f4e8", "caller_class":"java.lang.invoke.InnerClassLambdaMetafactory", "result":true, "args":[["io.vertx.core.Handler"]]}, +{"tracer":"meta", "event":"phase_change", "phase":"dead"}, +{"tracer":"meta", "event":"phase_change", "phase":"unload"} +] +---- + +Unfortunately the trace output does not take into account the applied configuration filters, +so the output contains all configuration decisions made by the agent. +This is unlikely to change in the near future +(see link:https://github.com/oracle/graal/issues/7635[oracle/graal#7635]). + +==== Configuration With Origins (Experimental) + +Alternative to the trace output, +it is possible to configure the native image agent with an experimental flag that shows the origins of the configuration entries. +You can enable that with the following additional system property: + +[source,bash] +---- +$ ./mvnw verify -DskipITs=false \ + -Dquarkus.test.integration-test-profile=test-with-native-agent \ + -Dquarkus.test.native.agent.additional.args=experimental-configuration-with-origins +---- + +The origins of the configuration entries can be found in text files inside the `target/native-image-agent-base-config` folder. +For example: + +[source,bash] +---- +$ cat target/native-image-agent-base-config/reflect-origins.txt +root +├── java.lang.Thread#run() +│ └── java.lang.Thread#runWith(java.lang.Object,java.lang.Runnable) +│ └── io.netty.util.concurrent.FastThreadLocalRunnable#run() +│ └── org.jboss.threads.ThreadLocalResettingRunnable#run() +│ └── org.jboss.threads.DelegatingRunnable#run() +│ └── org.jboss.threads.EnhancedQueueExecutor$ThreadBody#run() +│ └── org.jboss.threads.EnhancedQueueExecutor$Task#run() +│ └── org.jboss.threads.EnhancedQueueExecutor$Task#doRunWith(java.lang.Runnable,java.lang.Object) +│ └── io.quarkus.vertx.core.runtime.VertxCoreRecorder$14#runWith(java.lang.Runnable,java.lang.Object) +│ └── org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext#run() +│ └── io.quarkus.resteasy.reactive.server.runtime.QuarkusResteasyReactiveRequestContext#invokeHandler(int) +│ └── org.jboss.resteasy.reactive.server.handlers.InvocationHandler#handle(org.jboss.resteasy.reactive.server.core.ResteasyReactiveRequestContext) +│ └── org.acme.GreetingResource$quarkusrestinvoker$greeting_709ef95cd764548a2bbac83843a7f4cdd8077016#invoke(java.lang.Object,java.lang.Object[]) +│ └── org.acme.GreetingResource#greeting(java.lang.String) +│ └── org.acme.GreetingService_ClientProxy#greeting(java.lang.String) +│ └── org.acme.GreetingService#greeting(java.lang.String) +│ ├── java.lang.Class#forName(java.lang.String) - [ { "name":"org.acme.Alice" }, { "name":"org.acme.Bob" } ] +│ ├── java.lang.Class#getDeclaredConstructor(java.lang.Class[]) - [ { "name":"org.acme.Alice", "methods":[{"name":"","parameterTypes":[] }] } ] +│ ├── java.lang.reflect.Constructor#newInstance(java.lang.Object[]) - [ { "name":"org.acme.Alice", "methods":[{"name":"","parameterTypes":[] }] } ] +│ ├── java.lang.reflect.Method#invoke(java.lang.Object,java.lang.Object[]) - [ { "name":"org.acme.Alice", "methods":[{"name":"sayMyName","parameterTypes":[] }] } ] +│ └── java.lang.Class#getMethod(java.lang.String,java.lang.Class[]) - [ { "name":"org.acme.Alice", "methods":[{"name":"sayMyName","parameterTypes":[] }] } ] +... +---- + +==== Debugging With GDB + +The native image agent itself is a native executable produced with GraalVM that uses JVMTI to intercept the calls that require native image configuration. +As a last resort, it is possible to debug the native image agent with GDB, +see link:https://github.com/oracle/graal/blob/master/substratevm/src/com.oracle.svm.agent/README.md[here] +for instructions on how to do that. + [[inspecting-and-debugging]] == Inspecting and Debugging Native Executables This debugging guide provides further details on debugging issues in Quarkus native executables that might arise during development or production. diff --git a/_guides/opentelemetry.adoc b/_guides/opentelemetry.adoc index 9244840ac8a..bc5cb1e2c72 100644 --- a/_guides/opentelemetry.adoc +++ b/_guides/opentelemetry.adoc @@ -398,6 +398,32 @@ public class CustomConfiguration { } ---- +==== End User attributes + +When enabled, Quarkus adds OpenTelemetry End User attributes as Span attributes. +Before you enable this feature, verify that Quarkus Security extension is present and configured. +More information about the Quarkus Security can be found in the xref:security-overview.adoc[Quarkus Security overview]. + +The attributes are only added when authentication has already happened on a best-efforts basis. +Whether the End User attributes are added as Span attributes depends on authentication and authorization configuration of your Quarkus application. +If you create custom Spans prior to the authentication, Quarkus cannot add the End User attributes to them. +Quarkus is only able to add the attributes to the Span that is current after the authentication has been finished. +Another important consideration regarding custom Spans is active CDI request context that is used to propagate Quarkus `SecurityIdentity`. +In principle, Quarkus is able to add the End User attributes when the CDI request context has been activated for you before the custom Spans are created. + +[source,application.properties] +---- +quarkus.otel.traces.eusp.enabled=true <1> +quarkus.http.auth.proactive=true <2> +---- +<1> Enable the End User Attributes feature so that the `SecurityIdentity` principal and roles are added as Span attributes. +The End User attributes are personally identifiable information, therefore make sure you want to export them before you enable this feature. +<2> Optionally enable proactive authentication. +The best possible results are achieved when proactive authentication is enabled because the authentication happens sooner. +A good way to determine whether proactive authentication should be enabled in your Quarkus application is to read the Quarkus xref:security-proactive-authentication.adoc[Proactive authentication] guide. + +IMPORTANT: This feature is not supported when a custom xref:security-customization.adoc#jaxrs-security-context[Jakarta REST SecurityContexts] is used. + [[sampler]] === Sampler A https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#sampling[sampler] decides whether a trace should be discarded or forwarded, effectively managing noise and reducing overhead by limiting the number of collected traces sent to the collector. @@ -658,6 +684,7 @@ Additional exporters will be available in the Quarkiverse https://docs.quarkiver * https://quarkus.io/guides/resteasy-client[`quarkus-resteasy-client`] * https://quarkus.io/guides/scheduler[`quarkus-scheduler`] * https://quarkus.io/guides/smallrye-graphql[`quarkus-smallrye-graphql`] +* https://quarkus.io/extensions/io.quarkus/quarkus-mongodb-client[`quarkus-mongodb-client`] * https://quarkus.io/extensions/io.quarkus/quarkus-messaging[`quarkus-messaging`] ** AMQP 1.0 ** RabbitMQ diff --git a/_guides/redis-reference.adoc b/_guides/redis-reference.adoc index 67bc15af547..0de838ec704 100644 --- a/_guides/redis-reference.adoc +++ b/_guides/redis-reference.adoc @@ -247,11 +247,23 @@ quarkus.redis.password= To use TLS, you need to: -1. Set the `quarkus.redis.tls.enabled=true` property +1. Set the `quarkus.redis.tls.enabled=true` property or use the xref:./tls-registry-reference.adoc[TLS registry] (recommended) 2. Make sure that your URL starts with `rediss://` (with two `s`) + +When using the TLS registry, you need to use a named configuration to avoid conflicts with other TLS configurations: + +[source,properties] +---- +quarkus.tls.redis.trust-store.p12.path=client.p12 +quarkus.tls.redis.trust-store.p12.password=secret + +quarkus.redis.tls-configuration-name=redis # Reference the named configuration +---- + IMPORTANT: The default hostname verifier is set to `NONE`, meaning it does not verify the host name. You can change this behavior by setting the `quarkus.redis.tls.hostname-verification-algorithm` property, to `HTTPS` for example. + === Configure the authentication The Redis password can be set in the `redis://` URL or with the `quarkus.redis.password` property. diff --git a/_guides/security-authentication-mechanisms.adoc b/_guides/security-authentication-mechanisms.adoc index 30425666b77..ead7ae4238a 100644 --- a/_guides/security-authentication-mechanisms.adoc +++ b/_guides/security-authentication-mechanisms.adoc @@ -35,13 +35,18 @@ The following table maps specific authentication requirements to a supported mec |Username and password |xref:security-basic-authentication.adoc[Basic], <> -|Bearer access token |xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication], xref:security-jwt.adoc[JWT], xref:security-oauth2.adoc[OAuth2] +|Bearer access token |xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication], xref:security-jwt.adoc[JWT] +ifndef::no-quarkus-elytron-security-oauth2[] +, xref:security-oauth2.adoc[OAuth2] +endif::no-quarkus-elytron-security-oauth2[] |Single sign-on (SSO) |xref:security-oidc-code-flow-authentication.adoc[OIDC Code Flow], <> |Client certificate |<> +ifndef::no-webauthn-authentication[] |WebAuthn |xref:security-webauthn.adoc[WebAuthn] +endif::no-webauthn-authentication[] |Kerberos ticket |link:https://quarkiverse.github.io/quarkiverse-docs/quarkus-kerberos/dev/index.html[Kerberos] |==== @@ -96,7 +101,7 @@ quarkus.http.auth.form.error-page= # Define testing user quarkus.security.users.embedded.enabled=true quarkus.security.users.embedded.plain-text=true -quarkus.security.users.embedded.users.alice=alice +quarkus.security.users.embedded.users.alice=alice quarkus.security.users.embedded.roles.alice=user ---- @@ -312,17 +317,23 @@ For more information about customizing `SecurityIdentity`, see the xref:security Quarkus Security also supports the following authentication mechanisms through extensions: +ifndef::no-webauthn-authentication[] * <> +endif::no-webauthn-authentication[] * <> * <> +ifndef::no-quarkus-elytron-security-oauth2[] * <> +endif::no-quarkus-elytron-security-oauth2[] +ifndef::no-webauthn-authentication[] [[webauthn-authentication]] === WebAuthn authentication https://webauthn.guide/[WebAuthn] is an authentication mechanism that replaces passwords. When you write a service for registering new users, or logging them in, instead of asking for a password, you can use WebAuthn, which replaces the password. For more information, see the xref:security-webauthn.adoc[Secure a Quarkus application by using the WebAuthn authentication mechanism] guide. +endif::no-webauthn-authentication[] [[openid-connect-authentication]] === OpenID Connect authentication @@ -357,7 +368,9 @@ For more information about OIDC authentication and authorization methods that yo |Multiple tenants that can support the Bearer token authentication or Authorization Code Flow mechanisms|xref:security-openid-connect-multitenancy.adoc[Using OpenID Connect (OIDC) multi-tenancy] |Securing Quarkus with commonly used OpenID Connect providers|xref:security-openid-connect-providers.adoc[Configuring well-known OpenID Connect providers] |Using Keycloak to centralize authorization |xref:security-keycloak-authorization.adoc[Using OpenID Connect (OIDC) and Keycloak to centralize authorization] +ifndef::no-quarkus-keycloak-admin-client[] |Configuring Keycloak programmatically |xref:security-keycloak-admin-client.adoc[Using the Keycloak admin client] +endif::no-quarkus-keycloak-admin-client[] |==== [NOTE] @@ -386,12 +399,15 @@ For example, it can be a public endpoint or be protected with mTLS. In this scenario, you do not need to protect your Quarkus endpoint by using the Quarkus OpenID Connect adapter. ==== +ifndef::no-quarkus-oidc-token-propagation[] The `quarkus-resteasy-client-oidc-token-propagation` extension requires the `quarkus-oidc` extension. It provides Jakarta REST `TokenCredentialRequestFilter`, which sets the OpenID Connect Bearer token or Authorization Code Flow access token as the `Bearer` scheme value of the HTTP `Authorization` header. This filter can be registered with MicroProfile REST client implementations injected into the current Quarkus endpoint, which must be protected by using the Quarkus OIDC adapter. This filter can propagate the access token to the downstream services. For more information, see the xref:security-openid-connect-client.adoc[OpenID Connect client and token propagation quickstart] and xref:security-openid-connect-client-reference.adoc[OpenID Connect (OIDC) and OAuth2 client and filters reference] guides. +endif::no-quarkus-oidc-token-propagation[] + [[smallrye-jwt-authentication]] === SmallRye JWT authentication @@ -404,6 +420,7 @@ It represents them as `org.eclipse.microprofile.jwt.JsonWebToken`. For more information, see the xref:security-jwt.adoc[Using JWT RBAC] guide. +ifndef::no-quarkus-elytron-security-oauth2[] [[oauth2-authentication]] === OAuth2 authentication @@ -411,6 +428,7 @@ For more information, see the xref:security-jwt.adoc[Using JWT RBAC] guide. `quarkus-elytron-security-oauth2` is based on `Elytron` and is primarily intended for introspecting opaque tokens remotely. For more information, see the Quarkus xref:security-oauth2.adoc[Using OAuth2] guide. +endif::no-quarkus-elytron-security-oauth2[] [[oidc-jwt-oauth2-comparison]] == Choosing between OpenID Connect, SmallRye JWT, and OAuth2 authentication mechanisms @@ -425,13 +443,20 @@ In both cases, `quarkus-oidc` requires a connection to the specified OpenID Conn * If the user authentication requires Authorization Code flow, or you need to support multiple tenants, use `quarkus-oidc`. `quarkus-oidc` can also request user information by using both Authorization Code Flow and Bearer access tokens. -* If your bearer tokens must be verified, use `quarkus-oidc`, `quarkus-smallrye-jwt`, or `quarkus-elytron-security-oauth2`. +ifndef::no-quarkus-elytron-security-oauth2[] +* If your bearer tokens must be verified, use `quarkus-oidc`, `quarkus-elytron-security-oauth2`, or `quarkus-smallrye-jwt`. +endif::no-quarkus-elytron-security-oauth2[] +ifdef::no-quarkus-elytron-security-oauth2[] +* If your bearer tokens must be verified, use `quarkus-oidc` or `quarkus-smallrye-jwt`. +endif::no-quarkus-elytron-security-oauth2[] * If your bearer tokens are in a JSON web token (JWT) format, you can use any extensions in the preceding list. Both `quarkus-oidc` and `quarkus-smallrye-jwt` support refreshing the `JsonWebKey` (JWK) set when the OpenID Connect provider rotates the keys. Therefore, if remote token introspection must be avoided or is unsupported by the providers, use `quarkus-oidc` or `quarkus-smallrye-jwt` to verify JWT tokens. -* To introspect the JWT tokens remotely, you can use either `quarkus-oidc` or `quarkus-elytron-security-oauth2` because they support verifying the opaque or binary tokens by using remote introspection. +* To introspect the JWT tokens remotely, you can use `quarkus-oidc` +ifndef::no-quarkus-elytron-security-oauth2[or `quarkus-elytron-security-oauth2`] +for verifying the opaque or binary tokens by using remote introspection. `quarkus-smallrye-jwt` does not support the remote introspection of both opaque or JWT tokens but instead relies on the locally available keys that are usually retrieved from the OpenID Connect provider. * `quarkus-oidc` and `quarkus-smallrye-jwt` support the JWT and opaque token injection into the endpoint code. @@ -442,9 +467,10 @@ All extensions can have the tokens injected as `Principal`. `quarkus-oidc` uses only the JWK-formatted keys that are part of a JWK set, whereas `quarkus-smallrye-jwt` supports PEM keys. * `quarkus-smallrye-jwt` handles locally signed, inner-signed-and-encrypted, and encrypted tokens. -In contrast, although `quarkus-oidc` and `quarkus-elytron-security-oauth2` can also verify such tokens, they treat them as opaque tokens and verify them through remote introspection. +ifndef::no-quarkus-elytron-security-oauth2[In contrast, although `quarkus-oidc` and `quarkus-elytron-security-oauth2` can also verify such tokens, they treat them as opaque tokens and verify them through remote introspection.] +ifdef::no-quarkus-elytron-security-oauth2[In contrast, although `quarkus-oidc` can also verify such tokens, it treats them as opaque tokens and verifies them through remote introspection.] -* If you need a lightweight library for the remote introspection of opaque or JWT tokens, use `quarkus-elytron-security-oauth2`. +ifndef::no-quarkus-elytron-security-oauth2[* If you need a lightweight library for the remote introspection of opaque or JWT tokens, use `quarkus-elytron-security-oauth2`.] [NOTE] ==== @@ -459,26 +485,80 @@ Nonetheless, the providers effectively delegate most of the token-associated sta [[table]] .Token authentication mechanism comparison |=== -^|Feature required 3+^| Authentication mechanism - -^| ^s|`quarkus-oidc` ^s|`quarkus-smallrye-jwt` ^s| `quarkus-elytron-security-oauth2` - -s|Bearer JWT verification ^|Local verification or introspection ^|Local verification ^|Introspection - -s|Bearer opaque token verification ^|Introspection ^|No ^|Introspection -s|Refreshing `JsonWebKey` set to verify JWT tokens ^|Yes ^|Yes ^|No -s|Represent token as `Principal` ^|Yes ^|Yes ^|Yes -s|Inject JWT as MP JWT ^|Yes ^|Yes ^|No - -s|Authorization code flow ^| Yes ^|No ^|No -s|Multi-tenancy ^| Yes ^|No ^|No -s|User information support ^| Yes ^|No ^|No -s|PEM key format support ^|No ^|Yes ^|No - -s|SecretKey support ^|No ^|In JSON Web Key (JWK) format ^|No -s|Inner-signed and encrypted or encrypted tokens ^|Introspection ^|Local verification ^|Introspection -s|Custom token verification ^|No ^|With injected JWT parser ^|No -s|JWT as a cookie support ^|No ^|Yes ^|Yes +// Display four columns +ifndef::no-quarkus-elytron-security-oauth2[ ^|Feature required 3+^| Authentication mechanism] +// Display three columns and hide the quarkus-elytron-security-oauth2 column. +ifdef::no-quarkus-elytron-security-oauth2[ ^|Feature required 2+^| Authentication mechanism] + +^| +^s|`quarkus-oidc` +^s|`quarkus-smallrye-jwt` +ifndef::no-quarkus-elytron-security-oauth2[ ^s|`quarkus-elytron-security-oauth2`] + +s|Bearer JWT verification +^|Local verification or introspection +^|Local verification +ifndef::no-quarkus-elytron-security-oauth2[ ^|Introspection] + +s|Bearer opaque token verification +^|Introspection +^|No +ifndef::no-quarkus-elytron-security-oauth2[ ^|Introspection] + +s|Refreshing `JsonWebKey` set to verify JWT tokens +^|Yes +^|Yes +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|Represent token as `Principal` +^|Yes +^|Yes +ifndef::no-quarkus-elytron-security-oauth2[ ^|Yes] + +s|Inject JWT as MP JWT +^|Yes +^|Yes +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|Authorization code flow +^| Yes +^|No +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|Multi-tenancy +^| Yes +^|No +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|User information support +^| Yes +^|No +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|PEM key format support +^|No +^|Yes +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|SecretKey support +^|No +^|In JSON Web Key (JWK) format +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|Inner-signed and encrypted or encrypted tokens +^|Introspection +^|Local verification +ifndef::no-quarkus-elytron-security-oauth2[ ^|Introspection] + +s|Custom token verification +^|No +^|With injected JWT parser +ifndef::no-quarkus-elytron-security-oauth2[ ^|No] + +s|JWT as a cookie support +^|No +^|Yes +ifndef::no-quarkus-elytron-security-oauth2[ ^|Yes] |=== [[combining-authentication-mechanisms]] @@ -560,13 +640,29 @@ public class HelloResource { |=== ^|Authentication mechanism^| Annotation -s|Basic authentication mechanism ^|`io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` -s|Form-based authentication mechanism ^|`io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` -s|Mutual TLS authentication mechanism ^|`io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` -s|WebAuthn authentication mechanism ^|`io.quarkus.security.webauthn.WebAuthn` -s|Bearer token authentication mechanism ^|`io.quarkus.oidc.BearerTokenAuthentication` -s|OIDC authorization code flow mechanism ^|`io.quarkus.oidc.AuthorizationCodeFlow` -s|SmallRye JWT authentication mechanism ^|`io.quarkus.smallrye.jwt.runtime.auth.BearerTokenAuthentication` +s|Basic authentication mechanism +^|`io.quarkus.vertx.http.runtime.security.annotation.BasicAuthentication` + +s|Form-based authentication mechanism +^|`io.quarkus.vertx.http.runtime.security.annotation.FormAuthentication` + +s|Mutual TLS authentication mechanism +^|`io.quarkus.vertx.http.runtime.security.annotation.MTLSAuthentication` + +ifndef::no-webauthn-authentication[] +s|WebAuthn authentication mechanism +^|`io.quarkus.security.webauthn.WebAuthn` +endif::no-webauthn-authentication[] + +s|Bearer token authentication mechanism +^|`io.quarkus.oidc.BearerTokenAuthentication` + +s|OIDC authorization code flow mechanism +^|`io.quarkus.oidc.AuthorizationCodeFlow` + +s|SmallRye JWT authentication mechanism +^|`io.quarkus.smallrye.jwt.runtime.auth.BearerTokenAuthentication` + |=== TIP: Quarkus automatically secures endpoints annotated with the authentication mechanism annotation. When no standard security annotation is present on the REST endpoint and resource, the `io.quarkus.security.Authenticated` annotation is added for you. diff --git a/_guides/security-authorize-web-endpoints-reference.adoc b/_guides/security-authorize-web-endpoints-reference.adoc index fdae898edb3..03e47b6313b 100644 --- a/_guides/security-authorize-web-endpoints-reference.adoc +++ b/_guides/security-authorize-web-endpoints-reference.adoc @@ -446,7 +446,7 @@ quarkus.http.auth.policy.role-policy3.roles-allowed=admin quarkus.http.auth.permission.roles3.paths=/secured/admin/* quarkus.http.auth.permission.roles3.policy=role-policy3 ---- -<1> Role `root` will be able to access `/secured/user/*` and `/secured/admin/*` paths. +<1> Role `root` will be able to access `/secured/user/\*` and `/secured/admin/*` paths. <2> The `/secured/*` path can only be accessed by authenticated users. This way, you have secured the `/secured/all` path and so on. <3> Shared permissions are always applied before unshared ones, therefore a `SecurityIdentity` with the `root` role will have the `user` role as well. @@ -460,11 +460,11 @@ based on the common security annotations `@RolesAllowed`, `@DenyAll`, `@PermitAl [options="header"] |=== s| Annotation type s| Description -s| @DenyAll | Specifies that no security roles are allowed to invoke the specified methods. -s| @PermitAll | Specifies that all security roles are allowed to invoke the specified methods. +s| `@DenyAll` | Specifies that no security roles are allowed to invoke the specified methods. +s| `@PermitAll` | Specifies that all security roles are allowed to invoke the specified methods. `@PermitAll` lets everybody in, even without authentication. -s| @RolesAllowed | Specifies the list of security roles allowed to access methods in an application. +s| `@RolesAllowed` | Specifies the list of security roles allowed to access methods in an application. As an equivalent to `@RolesAllowed("**")`, {project-name} also provides the `io.quarkus.security.Authenticated` annotation that permits any authenticated user to access the resource. |=== @@ -540,7 +540,6 @@ However, if that property is not specified, a role named `User` is required as a |=== .Example of a property expressions usage in the `@RolesAllowed` annotation - [source,properties] ---- admin=Administrator @@ -551,6 +550,8 @@ tester.role=Tester all-roles=Administrator,Software,Tester,User ---- +[[subject-access-control-example]] +.Subject access control example [source,java] ---- import java.security.Principal; diff --git a/_guides/security-basic-authentication-howto.adoc b/_guides/security-basic-authentication-howto.adoc index 015127dbfb4..e346a2f31d6 100644 --- a/_guides/security-basic-authentication-howto.adoc +++ b/_guides/security-basic-authentication-howto.adoc @@ -18,7 +18,12 @@ Enable xref:security-basic-authentication.adoc[Basic authentication] for your Qu * You have installed at least one extension that provides an `IdentityProvider` based on username and password. For example: -** xref:security-jpa.adoc[Quarkus Security Jakarta Persistence extensions (`security-jpa` or `security-jpa-reactive`)] +ifndef::no-quarkus-security-jpa-reactive[] +** xref:security-jpa.adoc[Quarkus Security Jakarta Persistence extensions (`quarkus-security-jpa` or `quarkus-security-jpa-reactive`)] +endif::no-quarkus-security-jpa-reactive[] +ifdef::no-quarkus-security-jpa-reactive[] +** xref:security-jpa.adoc[Quarkus Security Jakarta Persistence extension (`quarkus-security-jpa`)] +endif::no-quarkus-security-jpa-reactive[] ** xref:security-properties.adoc[Elytron security properties file extension `(quarkus-elytron-security-properties-file)`] ** xref:security-jdbc.adoc[Elytron security JDBC extension `(quarkus-elytron-security-jdbc)`] diff --git a/_guides/security-getting-started-tutorial.adoc b/_guides/security-getting-started-tutorial.adoc index 29311a068cf..5dcab363d53 100644 --- a/_guides/security-getting-started-tutorial.adoc +++ b/_guides/security-getting-started-tutorial.adoc @@ -54,12 +54,20 @@ You can find the solution in the `security-jpa-quickstart` link:{quickstarts-tre == Create and verify the Maven project -For Quarkus Security to be able to map your security source to Jakarta Persistence entities, ensure that the Maven project in this tutorial includes the `security-jpa` or `security-jpa-reactive` extension. +ifndef::no-quarkus-security-jpa-reactive[] +For Quarkus Security to be able to map your security source to Jakarta Persistence entities, ensure that the Maven project in this tutorial includes the `quarkus-security-jpa` or `quarkus-security-jpa-reactive` extension. +endif::no-quarkus-security-jpa-reactive[] +ifdef::no-quarkus-security-jpa-reactive[] +For Quarkus Security to be able to map your security source to Jakarta Persistence entities, ensure that the Maven project in this tutorial includes the `quarkus-security-jpa` extension. +endif::no-quarkus-security-jpa-reactive[] [NOTE] ==== -xref:hibernate-orm-panache.adoc[Hibernate ORM with Panache] is used to store your user identities, but you can also use xref:hibernate-orm.adoc[Hibernate ORM] with the `security-jpa` extension. -Both xref:hibernate-reactive.adoc[Hibernate Reactive] and xref:hibernate-reactive-panache.adoc[Hibernate Reactive with Panache] can be used with the `security-jpa-reactive` extension. +xref:hibernate-orm-panache.adoc[Hibernate ORM with Panache] is used to store your user identities, but you can also use xref:hibernate-orm.adoc[Hibernate ORM] with the `quarkus-security-jpa` extension. + +ifndef::no-quarkus-security-jpa-reactive[] +Both xref:hibernate-reactive.adoc[Hibernate Reactive] and xref:hibernate-reactive-panache.adoc[Hibernate Reactive with Panache] can be used with the `quarkus-security-jpa-reactive` extension. +endif::no-quarkus-security-jpa-reactive[] You must also add your preferred database connector library. The instructions in this example tutorial use a PostgreSQL database for the identity store. @@ -86,18 +94,20 @@ include::{includes}/devtools/create-app.adoc[] :add-extension-extensions: security-jpa include::{includes}/devtools/extension-add.adoc[] ==== +ifndef::no-quarkus-security-jpa-reactive[] ** To add the Security Jakarta Persistence extension to an existing Maven project with Hibernate Reactive, run the following command from your project base directory: + ==== :add-extension-extensions: security-jpa-reactive include::{includes}/devtools/extension-add.adoc[] ==== +endif::no-quarkus-security-jpa-reactive[] === Verify the quarkus-security-jpa dependency -After you have run either of the preceding commands to create the Maven project, verify that the `security-jpa` dependency was added to your project build XML file. +After you have run either of the preceding commands to create the Maven project, verify that the `quarkus-security-jpa` dependency was added to your project build XML file. -* To verify the `security-jpa` extension, check for the following configuration: +* To verify the `quarkus-security-jpa` extension, check for the following configuration: + ==== [source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] @@ -115,7 +125,8 @@ After you have run either of the preceding commands to create the Maven project, implementation("io.quarkus:quarkus-security-jpa") ---- ==== -* To verify the `security-jpa-reactive` extension, check for the following configuration: +ifndef::no-quarkus-security-jpa-reactive[] +* To verify the `quarkus-security-jpa-reactive` extension, check for the following configuration: + ==== [source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] @@ -133,6 +144,7 @@ implementation("io.quarkus:quarkus-security-jpa") implementation("io.quarkus:quarkus-security-jpa-reactive") ---- ==== +endif::no-quarkus-security-jpa-reactive[] == Write the application @@ -266,7 +278,7 @@ public class User extends PanacheEntity { ---- -The `security-jpa` extension only initializes if a single entity is annotated with `@UserDefinition`. +The `quarkus-security-jpa` extension only initializes if a single entity is annotated with `@UserDefinition`. <1> The `@UserDefinition` annotation must be present on a single entity, either a regular Hibernate ORM entity or a Hibernate ORM with Panache entity. <2> Indicates the field used for the username. @@ -280,12 +292,13 @@ You can configure it to use plain text or custom passwords. ==== Don’t forget to set up the Panache and PostgreSQL JDBC driver, please see xref:hibernate-orm-panache.adoc#setting-up-and-configuring-hibernate-orm-with-panache[Setting up and configuring Hibernate ORM with Panache] for more information. ==== - +ifndef::no-quarkus-security-jpa-reactive[] [NOTE] ==== Hibernate Reactive Panache uses `io.quarkus.hibernate.reactive.panache.PanacheEntity` instead of `io.quarkus.hibernate.orm.panache.PanacheEntity`. For more information, see link:{quickstarts-tree-url}/security-jpa-reactive-quickstart/src/main/java/org/acme/elytron/security/jpa/reactive/User.java[User file]. ==== +endif::no-quarkus-security-jpa-reactive[] == Configure the application @@ -299,7 +312,7 @@ When secure access is required, and no other authentication mechanisms are enabl Therefore, in this tutorial, you do not need to set the property `quarkus.http.auth.basic` to `true`. ==== + -. Configure at least one data source in the `application.properties` file so the `security-jpa` extension can access your database. +. Configure at least one data source in the `application.properties` file so the `quarkus-security-jpa` extension can access your database. For example: + ==== @@ -318,9 +331,10 @@ quarkus.hibernate-orm.database.generation=drop-and-create + . To initialize the database with users and roles, implement the `Startup` class, as outlined in the following code snippet: +ifndef::no-quarkus-security-jpa-reactive[] [NOTE] ==== -* The URLs of Reactive datasources that are used by the `security-jpa-reactive` extension are set with the `quarkus.datasource.reactive.url` +* The URLs of Reactive datasources that are used by the `quarkus-security-jpa-reactive` extension are set with the `quarkus.datasource.reactive.url` configuration property and not the `quarkus.datasource.jdbc.url` configuration property typically used by JDBC datasources. + [source,properties] @@ -333,6 +347,7 @@ link:https://hibernate.org/orm/[Hibernate ORM] automatically creates the databas This approach is suitable for development but is not recommended for production. Therefore, adjustments are needed in a production environment. ==== +endif::no-quarkus-security-jpa-reactive[] [source,java] ---- @@ -362,7 +377,7 @@ The preceding example demonstrates how the application can be protected and iden [IMPORTANT] ==== In a production environment, do not store plain text passwords. -As a result, the `security-jpa` defaults to using bcrypt-hashed passwords. +As a result, the `quarkus-security-jpa` defaults to using bcrypt-hashed passwords. ==== == Test your application by using Dev Services for PostgreSQL diff --git a/_guides/security-jpa.adoc b/_guides/security-jpa.adoc index d114c46cf96..0eefd1783de 100644 --- a/_guides/security-jpa.adoc +++ b/_guides/security-jpa.adoc @@ -78,12 +78,12 @@ public class User extends PanacheEntity { ---- -The `security-jpa` extension initializes only if a single entity is annotated with `@UserDefinition`. +The `quarkus-security-jpa` extension initializes only if a single entity is annotated with `@UserDefinition`. <1> The `@UserDefinition` annotation must be present on a single entity, either a regular Hibernate ORM entity or a Hibernate ORM with Panache entity. <2> Indicates the field used for the username. <3> Indicates the field used for the password. -By default, `security-jpa` uses bcrypt-hashed passwords, or you can configure plain text or custom passwords instead. +By default, `quarkus-security-jpa` uses bcrypt-hashed passwords, or you can configure plain text or custom passwords instead. <4> This indicates the comma-separated list of roles added to the target principal representation attributes. <5> This method lets you add users while hashing passwords with the proper `bcrypt` hash. diff --git a/_guides/security-oidc-auth0-tutorial.adoc b/_guides/security-oidc-auth0-tutorial.adoc index c44e4346d19..6e1ffbb1d99 100644 --- a/_guides/security-oidc-auth0-tutorial.adoc +++ b/_guides/security-oidc-auth0-tutorial.adoc @@ -887,6 +887,7 @@ Open a browser, access http://localhost:8080/hello and get the name displayed in To confirm the permission is correctly enforced, change it to `echo.name`: `@PermissionsAllowed("echo.name")`. Clear the browser cache, access http://localhost:8080/hello again and you will get `403` reported by `ApiEchoService`. Now revert it back to `@PermissionsAllowed("echo:name")`. +ifndef::no-deprecated-test-resource[] == Integration testing You have already used OIDC DevUI SPA to login to Auth0 and test the Quarkus endpoint with the access token, updating the endpoint code along the way. @@ -1035,6 +1036,7 @@ image::auth0-test-success.png[Auth0 test success] By the way, if you like, you can run the tests in Continuous mode directly from DevUI: image::auth0-continuous-testing.png[Auth0 Continuous testing] +endif::no-deprecated-test-resource[] [[production-mode]] == Production mode diff --git a/_guides/security-oidc-bearer-token-authentication-tutorial.adoc b/_guides/security-oidc-bearer-token-authentication-tutorial.adoc index 6b2f9b06a89..67717da4065 100644 --- a/_guides/security-oidc-bearer-token-authentication-tutorial.adoc +++ b/_guides/security-oidc-bearer-token-authentication-tutorial.adoc @@ -228,13 +228,14 @@ docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=ad For more information, see the Keycloak documentation about link:https://www.keycloak.org/docs/latest/server_admin/index.html#configuring-realms[creating and configuring a new realm]. - +ifndef::no-quarkus-keycloak-admin-client[] [NOTE] ==== If you want to use the Keycloak Admin Client to configure your server from your application, you need to include either the `quarkus-keycloak-admin-rest-client` or the `quarkus-keycloak-admin-resteasy-client` (if the application uses `quarkus-rest-client`) extension. For more information, see the xref:security-keycloak-admin-client.adoc[Quarkus Keycloak Admin Client] guide. - ==== +endif::no-quarkus-keycloak-admin-client[] + [[keycloak-dev-mode]] @@ -367,4 +368,6 @@ For information about writing integration tests that depend on `Dev Services for * xref:security-jwt-build.adoc[Sign and encrypt JWT tokens with SmallRye JWT Build] * xref:security-authentication-mechanisms.adoc#combining-authentication-mechanisms[Combining authentication mechanisms] * xref:security-overview.adoc[Quarkus Security overview] +ifndef::no-quarkus-keycloak-admin-client[] * xref:security-keycloak-admin-client.adoc[Quarkus Keycloak Admin Client] +endif::no-quarkus-keycloak-admin-client[] diff --git a/_guides/security-oidc-bearer-token-authentication.adoc b/_guides/security-oidc-bearer-token-authentication.adoc index b1c4bd9180b..577ca170699 100644 --- a/_guides/security-oidc-bearer-token-authentication.adoc +++ b/_guides/security-oidc-bearer-token-authentication.adoc @@ -855,6 +855,7 @@ public class NativeBearerTokenAuthenticationIT extends BearerTokenAuthentication For more information about initializing and configuring Dev Services for Keycloak, see the xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] guide. +ifndef::no-deprecated-test-resource[] [[integration-testing-keycloak]] ==== `KeycloakTestResourceLifecycleManager` @@ -957,6 +958,7 @@ By default: By default, `KeycloakTestResourceLifecycleManager` uses HTTPS to initialize a Keycloak instance, and this can be disabled by using `keycloak.use.https=false`. The default realm name is `quarkus`, and the client id is `quarkus-service-app`. If you want to customize these values, set the `keycloak.realm` and `keycloak.service.client` system properties. +endif::no-deprecated-test-resource[] [[integration-testing-public-key]] ==== Local public key @@ -1295,7 +1297,7 @@ import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; import io.quarkus.oidc.AccessTokenCredential; -import io.quarkus.oidc.TenantFeature; +import io.quarkus.oidc.Tenant; import io.quarkus.oidc.TenantIdentityProvider; import io.quarkus.security.identity.SecurityIdentity; import io.quarkus.vertx.ConsumeEvent; @@ -1304,7 +1306,7 @@ import io.smallrye.common.annotation.Blocking; @ApplicationScoped public class OrderService { - @TenantFeature("tenantId") + @Tenant("tenantId") @Inject TenantIdentityProvider identityProvider; @@ -1321,14 +1323,14 @@ public class OrderService { } ---- -<1> For the default tenant, the `TenantFeature` qualifier is optional. +<1> For the default tenant, the `Tenant` qualifier is optional. <2> Executes token verification and converts the token to a `SecurityIdentity`. [NOTE] ==== When the provider is used during an HTTP request, the tenant configuration can be resolved as described in the xref:security-openid-connect-multitenancy.adoc[Using OpenID Connect Multi-Tenancy] guide. -However, when there is no active HTTP request, you must select the tenant explicitly with the `io.quarkus.oidc.TenantFeature` qualifier. +However, when there is no active HTTP request, you must select the tenant explicitly with the `io.quarkus.oidc.Tenant` qualifier. ==== [WARNING] @@ -1356,5 +1358,7 @@ For more information, see xref:security-oidc-code-flow-authentication#oidc-reque * xref:security-authentication-mechanisms.adoc#oidc-jwt-oauth2-comparison[Choosing between OpenID Connect, SmallRye JWT, and OAuth2 authentication mechanisms] * xref:security-authentication-mechanisms.adoc#combining-authentication-mechanisms[Combining authentication mechanisms] * xref:security-overview.adoc[Quarkus Security overview] +ifndef::no-quarkus-keycloak-admin-client[] * xref:security-keycloak-admin-client.adoc[Quarkus Keycloak Admin Client] +endif::no-quarkus-keycloak-admin-client[] * xref:security-openid-connect-multitenancy.adoc[Using OpenID Connect Multi-Tenancy] diff --git a/_guides/security-oidc-code-flow-authentication-tutorial.adoc b/_guides/security-oidc-code-flow-authentication-tutorial.adoc index 4ccd40e661a..63d99eab3b2 100644 --- a/_guides/security-oidc-code-flow-authentication-tutorial.adoc +++ b/_guides/security-oidc-code-flow-authentication-tutorial.adoc @@ -15,7 +15,7 @@ Discover how to secure application HTTP endpoints by using the Quarkus OpenID Co For more information, see xref:security-oidc-code-flow-authentication.adoc[OIDC code flow mechanism for protecting web applications]. -To learn about how well-known social providers such as Apple, Facebook, GitHub, Google, Mastodon, Microsoft, Twitch, Twitter (X), and Spotify can be used with Quarkus OIDC, see xref:security-openid-connect-providers.adoc[Configuring well-known OpenID Connect providers]. +To learn about how well-known social providers such as Apple, Facebook, GitHub, Google, Mastodon, Microsoft, Spotify, Twitch, and X (formerly Twitter) can be used with Quarkus OIDC, see xref:security-openid-connect-providers.adoc[Configuring well-known OpenID Connect providers]. See also, xref:security-authentication-mechanisms.adoc#other-supported-authentication-mechanisms[Authentication mechanisms in Quarkus]. If you want to protect your service applications by using OIDC Bearer token authentication, see xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication]. @@ -183,6 +183,15 @@ Finally, the `quarkus.http.auth.permission.authenticated` permission is set to t In this case, all paths are protected by a policy that ensures only `authenticated` users can access them. For more information, see xref:security-authorize-web-endpoints-reference.adoc[Security Authorization Guide]. +[NOTE] +==== +When you do not configure a client secret with `quarkus.oidc.credentials.secret`, it is recommended to configure `quarkus.oidc.token-state-manager.encryption-secret`. + +The `quarkus.oidc.token-state-manager.encryption-secret` enables the default token state manager to encrypt the user tokens in a browser cookie. If this key is not defined, and the `quarkus.oidc.credentials.secret` fallback is not configured, Quarkus uses a random key. A random key causes existing logins to be invalidated either on application restart or in environment with multiple instances of your application. Alternatively, encryption can also be disabled by setting `quarkus.oidc.token-state-manager.encryption-required` to `false`. However, you should disable secret encryption in development environments only. + +The encryption secret is recommended to be 32 chars long. For example, `quarkus.oidc.token-state-manager.encryption-secret=AyM1SysPpbyDfgZld3umj1qzKObwVMk` +==== + == Start and configure the Keycloak server To start a Keycloak server, use Docker and run the following command: @@ -278,7 +287,9 @@ After you have completed this tutorial, explore xref:security-oidc-bearer-token- * xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] * xref:security-jwt-build.adoc[Sign and encrypt JWT tokens with SmallRye JWT Build] * xref:security-authentication-mechanisms.adoc#oidc-jwt-oauth2-comparison[Choosing between OpenID Connect, SmallRye JWT, and OAuth2 authentication mechanisms] +ifndef::no-quarkus-keycloak-admin-client[] * xref:security-keycloak-admin-client.adoc[Quarkus Keycloak Admin Client] +endif::no-quarkus-keycloak-admin-client[] * https://www.keycloak.org/documentation.html[Keycloak Documentation] * xref:security-oidc-auth0-tutorial.adoc[Protect Quarkus web application by using Auth0 OpenID Connect provider] * https://openid.net/connect/[OpenID Connect] diff --git a/_guides/security-oidc-code-flow-authentication.adoc b/_guides/security-oidc-code-flow-authentication.adoc index b59fb25bd18..15ecefed83a 100644 --- a/_guides/security-oidc-code-flow-authentication.adoc +++ b/_guides/security-oidc-code-flow-authentication.adoc @@ -475,6 +475,7 @@ import org.eclipse.microprofile.jwt.Claims; import io.quarkus.arc.Unremovable; import io.quarkus.oidc.AuthorizationCodeTokens; import io.quarkus.oidc.OidcRedirectFilter; +import io.quarkus.oidc.Redirect; import io.quarkus.oidc.TenantFeature; import io.quarkus.oidc.runtime.OidcUtils; import io.smallrye.jwt.build.Jwt; @@ -482,27 +483,29 @@ import io.smallrye.jwt.build.Jwt; @ApplicationScoped @Unremovable @TenantFeature("tenant-refresh") +@Redirect(Location.SESSION_EXPIRED_PAGE) <1> public class SessionExpiredOidcRedirectFilter implements OidcRedirectFilter { @Override public void filter(OidcRedirectContext context) { if (context.redirectUri().contains("/session-expired-page")) { - AuthorizationCodeTokens tokens = context.routingContext().get(AuthorizationCodeTokens.class.getName()); <1> - String userName = OidcUtils.decodeJwtContent(tokens.getIdToken()).getString(Claims.preferred_username.name()); <2> - String jwe = Jwt.preferredUserName(userName).jwe() - .encryptWithSecret(context.oidcTenantConfig().credentials.secret.get()); <3> - OidcUtils.createCookie(context.routingContext(), context.oidcTenantConfig(), "session_expired", - jwe + "|" + context.oidcTenantConfig().tenantId.get(), 10); <4> + AuthorizationCodeTokens tokens = context.routingContext().get(AuthorizationCodeTokens.class.getName()); <2> + String userName = OidcUtils.decodeJwtContent(tokens.getIdToken()).getString(Claims.preferred_username.name()); <3> + String jwe = Jwt.preferredUserName(userName).jwe() + .encryptWithSecret(context.oidcTenantConfig().credentials.secret.get()); <4> + OidcUtils.createCookie(context.routingContext(), context.oidcTenantConfig(), "session_expired", + jwe + "|" + context.oidcTenantConfig().tenantId.get(), 10); <5> } } } ---- -<1> Access `AuthorizationCodeTokens` tokens associated with the now expired session as a `RoutingContext` attribute. -<2> Decode ID token claims and get a user name. -<3> Save the user name in a JWT token encrypted with the current OIDC tenant's client secret. -<4> Create a custom `session_expired` cookie valid for 5 seconds which joins the encrypted token and a tenant id using a "|" separator. Recording a tenant id in a custom cookie can help to generate correct session expired pages in a multi-tenant OIDC setup. +<1> Make sure this redirect filter is only called during a redirect to the session expired page. +<2> Access `AuthorizationCodeTokens` tokens associated with the now expired session as a `RoutingContext` attribute. +<3> Decode ID token claims and get a user name. +<4> Save the user name in a JWT token encrypted with the current OIDC tenant's client secret. +<5> Create a custom `session_expired` cookie valid for 5 seconds which joins the encrypted token and a tenant id using a "|" separator. Recording a tenant id in a custom cookie can help to generate correct session expired pages in a multi-tenant OIDC setup. Next, a public JAX-RS resource which generates session expired pages can use this cookie to create a page tailored for this user and the corresponding OIDC tenant, for example: @@ -642,7 +645,7 @@ Set the `quarkus.oidc.authentication.user-info-required=true` property to reques A request is sent to the OIDC provider `UserInfo` endpoint by using the access token returned with the authorization code grant response, and an `io.quarkus.oidc.UserInfo` (a simple `jakarta.json.JsonObject` wrapper) object is created. `io.quarkus.oidc.UserInfo` can be injected or accessed as a SecurityIdentity `userinfo` attribute. -`quarkus.oidc.authentication.user-info-required` is automatically enabled if one of these conditions is met: +`quarkus.oidc.authentication.user-info-required` is automatically enabled if one of these conditions is met: - if `quarkus.oidc.roles.source` is set to `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is set to `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, the current OIDC tenant must support a UserInfo endpoint in these cases. @@ -788,8 +791,11 @@ OIDC `CodeAuthenticationMechanism` uses the default `io.quarkus.oidc.TokenStateM It makes Quarkus OIDC endpoints completely stateless and it is recommended to follow this strategy to achieve the best scalability results. -See the <> and <> sections of this guide for alternative approaches to storing tokens. -For example, storing tokens in the database or other server-side storage, if you prefer and have good reasons for storing the token state on the server. +ifndef::no-quarkus-oidc-db-token-state-manager[] +Refer to the <> section of this guide for information on storing tokens in the database or other server-side storage solutions. This approach is suitable if you prefer and have compelling reasons to store the token state on the server. +endif::no-quarkus-oidc-db-token-state-manager[] + +See the <> section for alternative methods of token storage. This is ideal for those seeking customized solutions for token state management, especially when standard server-side storage does not meet your specific requirements. You can configure the default `TokenStateManager` to avoid saving an access token in the session cookie and to only keep ID and refresh tokens or a single ID token only. @@ -815,8 +821,10 @@ In such cases, use the `quarkus.oidc.token-state-manager.strategy` property to c If your chosen session cookie strategy combines tokens and generates a large session cookie value that is greater than 4KB, some browsers might not be able to handle such cookie sizes. This can occur when the ID, access, and refresh tokens are JWT tokens and the selected strategy is `keep-all-tokens` or with ID and refresh tokens when the strategy is `id-refresh-token`. To work around this issue, you can set `quarkus.oidc.token-state-manager.split-tokens=true` to create a unique session token for each token. +ifndef::no-quarkus-oidc-db-token-state-manager[] An alternative solution is to have the tokens saved in the database. For more information, see <>. +endif::no-quarkus-oidc-db-token-state-manager[] The default `TokenStateManager` encrypts the tokens before storing them in the session cookie. The following example shows how you configure it to split the tokens and encrypt them: @@ -908,6 +916,7 @@ public class CustomTokenStateManager implements TokenStateManager { For information about the default `TokenStateManager` storing tokens in an encrypted session cookie, see <>. +ifndef::no-quarkus-oidc-db-token-state-manager[] For information about the custom Quarkus `TokenStateManager` implementation storing tokens in a database, see <>. [[db-token-state-manager]] @@ -1009,6 +1018,7 @@ public class OidcDbTokenStateManagerEntity { <1> The Hibernate ORM extension will only create this table for you when the database schema is generated. For more information, refer to the xref:hibernate-orm.adoc[Hibernate ORM] guide. <2> You can choose a column length depending on the length of your tokens. +endif::no-quarkus-oidc-db-token-state-manager[] === Logout and expiration @@ -1304,7 +1314,7 @@ Most well-known social OAuth2 providers enforce rate-limiting so there is a high OAuth2 servers might not support a well-known configuration endpoint. In this case, you must disable the discovery and configure the authorization, token, and introspection and `UserInfo` endpoint paths manually. -For well-known OIDC or OAuth2 providers, such as Apple, Facebook, GitHub, Google, Microsoft, Spotify, and Twitter, Quarkus can help significantly simplify your application's configuration with the `quarkus.oidc.provider` property. +For well-known OIDC or OAuth2 providers, such as Apple, Facebook, GitHub, Google, Microsoft, Spotify, and X (formerly Twitter), Quarkus can help significantly simplify your application's configuration with the `quarkus.oidc.provider` property. Here is how you can integrate `quarkus-oidc` with GitHub after you have link:https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app[created a GitHub OAuth application]. Configure your Quarkus endpoint like this: @@ -1693,6 +1703,7 @@ testImplementation("net.sourceforge.htmlunit:htmlunit") testImplementation("io.quarkus:quarkus-junit5") ---- +ifndef::no-deprecated-test-resource[] [[integration-testing-wiremock]] === Wiremock @@ -1734,10 +1745,10 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import org.junit.jupiter.api.Test; -import com.gargoylesoftware.htmlunit.SilentCssErrorHandler; -import com.gargoylesoftware.htmlunit.WebClient; -import com.gargoylesoftware.htmlunit.html.HtmlForm; -import com.gargoylesoftware.htmlunit.html.HtmlPage; +import org.htmlunit.SilentCssErrorHandler; +import org.htmlunit.WebClient; +import org.htmlunit.html.HtmlForm; +import org.htmlunit.html.HtmlPage; import io.quarkus.test.common.QuarkusTestResource; import io.quarkus.test.junit.QuarkusTest; @@ -1779,6 +1790,7 @@ The user `admin` has the `user` and `admin` roles by default - it can be customi Additionally, `OidcWiremockTestResource` sets the token issuer and audience to `https://service.example.com`, which can be customized with `quarkus.test.oidc.token.issuer` and `quarkus.test.oidc.token.audience` system properties. `OidcWiremockTestResource` can be used to emulate all OIDC providers. +endif::no-deprecated-test-resource[] [[integration-testing-keycloak-devservices]] === Dev Services for Keycloak @@ -1815,6 +1827,7 @@ public class CodeFlowAuthorizationTest { } ---- +ifndef::no-deprecated-test-resource[] [[integration-testing-keycloak]] === Using KeycloakTestResourceLifecycleManager @@ -1879,6 +1892,7 @@ The user `admin` has the `user` and `admin` roles by default - it can be customi By default, `KeycloakTestResourceLifecycleManager` uses HTTPS to initialize a Keycloak instance that can be disabled by specifying `keycloak.use.https=false`. The default realm name is `quarkus` and client id is `quarkus-web-app` - set `keycloak.realm` and `keycloak.web-app.client` system properties to customize the values if needed. +endif::no-deprecated-test-resource[] [[integration-testing-security-annotation]] === TestSecurity annotation @@ -1924,4 +1938,3 @@ From the `quarkus dev` console, type `j` to change the application global log le * https://www.keycloak.org/documentation.html[Keycloak documentation] * https://openid.net/connect/[OpenID Connect] * https://tools.ietf.org/html/rfc7519[JSON Web Token] - diff --git a/_guides/security-oidc-configuration-properties-reference.adoc b/_guides/security-oidc-configuration-properties-reference.adoc index 438a9f72a3e..e76df52eb63 100644 --- a/_guides/security-oidc-configuration-properties-reference.adoc +++ b/_guides/security-oidc-configuration-properties-reference.adoc @@ -19,14 +19,8 @@ include::{generated-dir}/config/quarkus-oidc.adoc[opts=optional, leveloffset=+1] * xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication] * xref:security-oidc-bearer-token-authentication-tutorial.adoc[Protect a service application by using OpenID Connect (OIDC) Bearer token authentication] -// * https://www.keycloak.org/documentation.html[Keycloak Documentation] * https://openid.net/connect/[OpenID Connect] -// * https://tools.ietf.org/html/rfc7519[JSON Web Token] * xref:security-openid-connect-client-reference.adoc[OpenID Connect and OAuth2 Client and Filters Reference Guide] -// * xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] -// * xref:security-jwt-build.adoc[Sign and encrypt JWT tokens with SmallRye JWT Build] * xref:security-authentication-mechanisms.adoc#oidc-jwt-oauth2-comparison[Choosing between OpenID Connect, SmallRye JWT, and OAuth2 authentication mechanisms] * xref:security-authentication-mechanisms.adoc#combining-authentication-mechanisms[Combining authentication mechanisms] * xref:security-overview.adoc[Quarkus Security] -// * xref:security-keycloak-admin-client.adoc[Quarkus Keycloak Admin Client] -// TASK - Select some references and eliminate the rest. diff --git a/_guides/security-openid-connect-client-reference.adoc b/_guides/security-openid-connect-client-reference.adoc index db214a15dbe..6bceac12434 100644 --- a/_guides/security-openid-connect-client-reference.adoc +++ b/_guides/security-openid-connect-client-reference.adoc @@ -15,7 +15,11 @@ You can use Quarkus extensions for OpenID Connect and OAuth 2.0 access token man This includes the following: - Using `quarkus-oidc-client`, `quarkus-rest-client-oidc-filter` and `quarkus-resteasy-client-oidc-filter` extensions to acquire and refresh access tokens from OpenID Connect and OAuth 2.0 compliant Authorization Servers such as link:https://www.keycloak.org[Keycloak]. + +ifndef::no-quarkus-oidc-token-propagation[] + - Using `quarkus-rest-client-oidc-token-propagation` and `quarkus-resteasy-client-oidc-token-propagation` extensions to propagate the current `Bearer` or `Authorization Code Flow` access tokens. +endif::no-quarkus-oidc-token-propagation[] The access tokens managed by these extensions can be used as HTTP Authorization Bearer tokens to access the remote services. @@ -1097,6 +1101,7 @@ public class OidcRequestCustomizer implements OidcRequestFilter { } ---- +ifndef::no-quarkus-oidc-token-propagation-reactive[] [[token-propagation-reactive]] == Token Propagation Reactive @@ -1172,7 +1177,9 @@ quarkus.oidc-token-propagation.exchange-token=true ---- `AccessTokenRequestReactiveFilter` uses a default `OidcClient` by default. A named `OidcClient` can be selected with a `quarkus.oidc-token-propagation-reactive.client-name` configuration property or with the `io.quarkus.oidc.token.propagation.AccessToken#exchangeTokenClient` annotation attribute. +endif::no-quarkus-oidc-token-propagation-reactive[] +ifndef::no-quarkus-oidc-token-propagation[] [[token-propagation]] == Token Propagation @@ -1187,6 +1194,7 @@ However, the direct end-to-end Bearer token propagation should be avoided. For e Additionally, a complex application might need to exchange or update the tokens before propagating them. For example, the access context might be different when `Service A` is accessing `Service B`. In this case, `Service A` might be granted a narrow or completely different set of scopes to access `Service B`. The following sections show how `AccessTokenRequestFilter` and `JsonWebTokenRequestFilter` can help. +endif::no-quarkus-oidc-token-propagation[] === RestClient AccessTokenRequestFilter @@ -1328,6 +1336,7 @@ As mentioned, use `AccessTokenRequestFilter` if you work with Keycloak or an Ope You can generate the tokens as described in xref:security-oidc-bearer-token-authentication.adoc#integration-testing[OpenID Connect Bearer Token Integration testing] section. Prepare the REST test endpoints. You can have the test front-end endpoint, which uses the injected MP REST client with a registered token propagation filter, call the downstream endpoint. For example, see the `integration-tests/resteasy-client-oidc-token-propagation` in the `main` Quarkus repository. +ifndef::no-quarkus-oidc-token-propagation[] [[reactive-token-propagation]] == Token Propagation Reactive @@ -1345,8 +1354,10 @@ The `quarkus-rest-client-resteasy-client-oidc-token-propagation` extension provi The `quarkus-rest-client-resteasy-client-oidc-token-propagation` extension (as opposed to the non-reactive `quarkus-resteasy-client-oidc-token-propagation` extension) does not currently support the exchanging or resigning of the tokens before the propagation. However, these features might be added in the future. +endif::no-quarkus-oidc-token-propagation[] -[[oidc-client-graphql-client]] +ifndef::no-quarkus-oidc-client-graphql[] +[[quarkus-oidc-client-graphql]] == GraphQL client integration The `quarkus-oidc-client-graphql` extension provides a way to integrate an OIDC client into xref:smallrye-graphql-client.adoc[GraphQL clients] paralleling the approach used with REST clients. @@ -1401,6 +1412,7 @@ Uni tokenUni = oidcClients.getClient("OIDC_CLIENT_NAME") builder.dynamicHeader("Authorization", tokenUni); VertxDynamicGraphQLClient client = builder.build(); ---- +endif::no-quarkus-oidc-client-graphql[] [[configuration-reference]] == Configuration reference @@ -1409,9 +1421,11 @@ VertxDynamicGraphQLClient client = builder.build(); include::{generated-dir}/config/quarkus-oidc-client.adoc[opts=optional, leveloffset=+1] +ifndef::no-quarkus-oidc-token-propagation-reactive[] === OIDC token propagation include::{generated-dir}/config/quarkus-oidc-token-propagation-reactive.adoc[opts=optional, leveloffset=+1] +endif::no-quarkus-oidc-token-propagation-reactive[] == References diff --git a/_guides/security-openid-connect-client.adoc b/_guides/security-openid-connect-client.adoc index 65949122140..9876031aee2 100644 --- a/_guides/security-openid-connect-client.adoc +++ b/_guides/security-openid-connect-client.adoc @@ -68,6 +68,7 @@ The solution is in the `security-openid-connect-client-quickstart` link:{quickst First, you need a new project. Create a new project with the following command: +ifndef::no-quarkus-oidc-token-propagation[] :create-app-artifact-id: security-openid-connect-client-quickstart :create-app-extensions: oidc,rest-client-oidc-filter,rest-client-oidc-token-propagation,rest include::{includes}/devtools/create-app.adoc[] @@ -78,6 +79,20 @@ If you already have your Quarkus project configured, you can add these extension :add-extension-extensions: oidc,rest-client-oidc-filter,rest-client-oidc-token-propagation,rest include::{includes}/devtools/extension-add.adoc[] +endif::no-quarkus-oidc-token-propagation[] + +ifdef::no-quarkus-oidc-token-propagation[] +:create-app-artifact-id: security-openid-connect-client-quickstart +:create-app-extensions: oidc,rest-client-oidc-filter,rest +include::{includes}/devtools/create-app.adoc[] + +It generates a Maven project, importing the `oidc`, `rest-client-oidc-filter`, and `rest` extensions. + +If you already have your Quarkus project configured, you can add these extensions to your project by running the following command in your project base directory: + +:add-extension-extensions: oidc,rest-client-oidc-filter,rest +include::{includes}/devtools/extension-add.adoc[] +endif::no-quarkus-oidc-token-propagation[] It adds the following extensions to your build file: @@ -92,21 +107,31 @@ It adds the following extensions to your build file: io.quarkus quarkus-rest-client-oidc-filter +ifndef::no-quarkus-oidc-token-propagation[] io.quarkus quarkus-rest-client-oidc-token-propagation +endif::no-quarkus-oidc-token-propagation[] io.quarkus quarkus-rest ---- -[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] .build.gradle +ifndef::no-quarkus-oidc-token-propagation[] +[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] ---- implementation("io.quarkus:quarkus-oidc,rest-client-oidc-filter,rest-client-oidc-token-propagation,rest") ---- +endif::no-quarkus-oidc-token-propagation[] +ifdef::no-quarkus-oidc-token-propagation[] +[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] +---- +implementation("io.quarkus:quarkus-oidc,rest-client-oidc-filter,rest") +---- +endif::no-quarkus-oidc-token-propagation[] == Writing the application @@ -155,11 +180,13 @@ public class ProtectedResource { `ProtectedResource` returns a name from both `userName()` and `adminName()` methods. The name is extracted from the current `JsonWebToken`. -Next, add three REST clients: +Next, add the following REST clients: 1. `RestClientWithOidcClientFilter`, which uses an OIDC client filter provided by the `quarkus-rest-client-oidc-filter` extension to get and propagate an access token. 2. `RestClientWithTokenHeaderParam`, which accepts a token already acquired by the programmatically created OidcClient as an HTTP `Authorization` header value. +ifndef::no-quarkus-oidc-token-propagation[] 3. `RestClientWithTokenPropagationFilter`, which uses an OIDC token propagation filter provided by the `quarkus-rest-client-oidc-token-propagation` extension to get and propagate an access token. +endif::no-quarkus-oidc-token-propagation[] Add the `RestClientWithOidcClientFilter` REST client: @@ -217,7 +244,7 @@ public interface RestClientWithTokenHeaderParam { @Produces("text/plain") @Path("userName") Uni getUserName(@HeaderParam("Authorization") String authorization); <1> - + @GET @Produces("text/plain") @Path("adminName") @@ -226,6 +253,7 @@ public interface RestClientWithTokenHeaderParam { ---- <1> `RestClientWithTokenHeaderParam` REST client expects that the tokens will be passed to it as HTTP `Authorization` header values. +ifndef::no-quarkus-oidc-token-propagation[] Add the `RestClientWithTokenPropagationFilter` REST client: [source,java] @@ -263,6 +291,8 @@ public interface RestClientWithTokenPropagationFilter { IMPORTANT: Do not use the `RestClientWithOidcClientFilter` and `RestClientWithTokenPropagationFilter` interfaces in the same REST client because they can conflict, leading to issues. For example, the OIDC client filter can override the token from the OIDC token propagation filter, or the propagation filter might not work correctly if it attempts to propagate a token when none is available, expecting the OIDC client filter to obtain a new token instead. +endif::no-quarkus-oidc-token-propagation[] + Also, add `OidcClientCreator` to create an OIDC client programmatically at startup. `OidcClientCreator` supports `RestClientWithTokenHeaderParam` REST client calls: @@ -340,12 +370,12 @@ public class FrontendResource { @Inject @RestClient RestClientWithOidcClientFilter restClientWithOidcClientFilter; <1> - + @Inject @RestClient RestClientWithTokenPropagationFilter restClientWithTokenPropagationFilter; <2> - @Inject + @Inject OidcClientCreator oidcClientCreator; TokensHelper tokenHelper = new TokensHelper(); <5> @Inject @@ -387,7 +417,7 @@ public class FrontendResource { return tokenHelper.getTokens(oidcClientCreator.getOidcClient()).onItem() .transformToUni(tokens -> restClientWithTokenHeaderParam.getUserName("Bearer " + tokens.getAccessToken())); } - + @GET @Path("admin-name-with-oidc-client-token-header-param") @Produces("text/plain") @@ -403,7 +433,7 @@ public class FrontendResource { Tokens tokens = tokenHelper.getTokens(oidcClientCreator.getOidcClient()).await().indefinitely(); return restClientWithTokenHeaderParam.getUserName("Bearer " + tokens.getAccessToken()).await().indefinitely(); } - + @GET @Path("admin-name-with-oidc-client-token-header-param-blocking") @Produces("text/plain") @@ -411,7 +441,7 @@ public class FrontendResource { Tokens tokens = tokenHelper.getTokens(oidcClientCreator.getOidcClient()).await().indefinitely(); return restClientWithTokenHeaderParam.getAdminName("Bearer " + tokens.getAccessToken()).await().indefinitely(); } - + } ---- <1> `FrontendResource` uses the injected `RestClientWithOidcClientFilter` REST client with the OIDC client filter to get and propagate an access token to `ProtectedResource` when either `/frontend/user-name-with-oidc-client-token` or `/frontend/admin-name-with-oidc-client-token` is called. @@ -663,7 +693,7 @@ curl -i -X GET \ In contrast with the preceding command, this command returns a `403` status code. -Next, test that the programmatically created OIDC client correctly acquires and propagates the token with `RestClientWithTokenHeaderParam` both in reactive and imperative (blocking) modes. +Next, test that the programmatically created OIDC client correctly acquires and propagates the token with `RestClientWithTokenHeaderParam` both in reactive and imperative (blocking) modes. Call the `/user-name-with-oidc-client-token-header-param`. This command returns the `200` status code and the name `alice`: diff --git a/_guides/security-openid-connect-dev-services.adoc b/_guides/security-openid-connect-dev-services.adoc index fd3d37c2468..32ebe11900f 100644 --- a/_guides/security-openid-connect-dev-services.adoc +++ b/_guides/security-openid-connect-dev-services.adoc @@ -258,7 +258,7 @@ For more information, see xref:security-oidc-bearer-token-authentication.adoc#in [[keycloak-initialization]] === Keycloak initialization -The `quay.io/keycloak/keycloak:23.0.7` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default. +The `quay.io/keycloak/keycloak:24.0.4` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default. `quarkus.keycloak.devservices.image-name` can be used to change the Keycloak image name. For example, set it to `quay.io/keycloak/keycloak:19.0.3-legacy` to use a Keycloak distribution powered by WildFly. Be aware that a Quarkus-based Keycloak distribution is only available starting from Keycloak `20.0.0`. diff --git a/_guides/security-openid-connect-multitenancy.adoc b/_guides/security-openid-connect-multitenancy.adoc index cb2ea802488..0cca72b4f7d 100644 --- a/_guides/security-openid-connect-multitenancy.adoc +++ b/_guides/security-openid-connect-multitenancy.adoc @@ -410,6 +410,7 @@ After a little while, you can run this binary directly: == Test the application +ifndef::no-deprecated-test-resource[] === Use Dev Services for Keycloak xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] is recommended for the integration testing against Keycloak. @@ -478,13 +479,12 @@ import static org.junit.jupiter.api.Assertions.assertTrue; import java.io.IOException; +import org.htmlunit.SilentCssErrorHandler; +import org.htmlunit.WebClient; +import org.htmlunit.html.HtmlForm; +import org.htmlunit.html.HtmlPage; import org.junit.jupiter.api.Test; -import com.gargoylesoftware.htmlunit.SilentCssErrorHandler; -import com.gargoylesoftware.htmlunit.WebClient; -import com.gargoylesoftware.htmlunit.html.HtmlForm; -import com.gargoylesoftware.htmlunit.html.HtmlPage; - import io.quarkus.test.junit.QuarkusTest; import io.quarkus.test.keycloak.client.KeycloakTestClient; import io.restassured.RestAssured; @@ -562,6 +562,7 @@ public class CodeFlowIT extends CodeFlowTest { ---- For more information about how it is initialized and configured, see xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak]. +endif::no-deprecated-test-resource[] === Use the browser diff --git a/_guides/security-openid-connect-providers.adoc b/_guides/security-openid-connect-providers.adoc index d6df9101c8a..2015d1160f2 100644 --- a/_guides/security-openid-connect-providers.adoc +++ b/_guides/security-openid-connect-providers.adoc @@ -29,6 +29,177 @@ This property can be used in `application.properties`, in xref:security-openid-c == Well Known Providers +[[apple]] +=== Apple + +In order to set up OIDC for Apple you need to create a developer account, and sign up for the 99€/year program, but you cannot test your application on `localhost` like most other OIDC providers: +you will need to run it over HTTPS and make it publicly accessible, so for development purposes +you may want to use a service such as https://ngrok.com. + +Go to https://developer.apple.com/account/resources/identifiers/list[Create a new identifier] and press `+` + +image::oidc-apple-1.png[role="thumb"] + +Don't touch anything, keep `App IDs` selected, and press `Continue`: + +image::oidc-apple-2.png[role="thumb"] + +Don't touch anything, keep `App` selected, and press `Continue`: + +image::oidc-apple-3.png[role="thumb"] + +Enter a description and a Bundle ID (use your application package name): + +image::oidc-apple-4.png[role="thumb"] + +Then scroll down to find the `Sign in with Apple` Capability, select it, and press `Continue`: + +image::oidc-apple-5.png[role="thumb"] + +Write down your App ID Prefix, then press `Register`: + +image::oidc-apple-6.png[role="thumb"] + +Back on the `Identifiers` page, press `+`: + +image::oidc-apple-7.png[role="thumb"] + +Select `Service IDs` and press `Continue`: + +image::oidc-apple-8.png[role="thumb"] + +Enter a description and Bundle ID (use your application package name), then press `Continue`: + +image::oidc-apple-9.png[role="thumb"] + +Now press `Register`: + +image::oidc-apple-10.png[role="thumb"] + +Back on the service list, click on your newly created service: + +image::oidc-apple-11.png[role="thumb"] + +Enable `Sign in with Apple` and press `Configure`: + +image::oidc-apple-12.png[role="thumb"] + +Add your domain and return URL (set to `/_renarde/security/oidc-success`) and press `Next`: + +image::oidc-apple-13.png[role="thumb"] + +Now press `Done`: + +image::oidc-apple-14.png[role="thumb"] + +Now press `Continue`: + +image::oidc-apple-15.png[role="thumb"] + +And now press `Save`: + +image::oidc-apple-16.png[role="thumb"] + +Go to the https://developer.apple.com/account/resources/authkeys/list[Keys] page on the left menu, and press `+`: + +image::oidc-apple-17.png[role="thumb"] + +Fill in a key name, enable `Sign in with Apple`, and press `Configure`: + +image::oidc-apple-18.png[role="thumb"] + +Select your Primary App ID and press `Save`: + +image::oidc-apple-19.png[role="thumb"] + +Back on the key page, press `Continue`: + +image::oidc-apple-20.png[role="thumb"] + +Now press `Register`: + +image::oidc-apple-21.png[role="thumb"] + +Write down your `Key ID`, download your key and save it to your Quarkus application in `src/main/resources/AuthKey_.p8`: + +image::oidc-apple-22.png[role="thumb"] + +You can now configure your `application.properties`: + +[source,properties] +---- +quarkus.oidc.provider=apple +quarkus.oidc.client-id= +quarkus.oidc.credentials.jwt.key-file=AuthKey_.p8 +quarkus.oidc.credentials.jwt.token-key-id= +quarkus.oidc.credentials.jwt.issuer= +quarkus.oidc.credentials.jwt.subject=> section. + +[[discord]] +=== Discord + +Create a https://discord.com/developers/applications[Discord application]: + +image::oidc-discord-1.png[role="thumb"] + +You now can get your client id and secret: + +image::oidc-discord-2.png[role="thumb"] + +You can now configure your `application.properties`: + +[source,properties] +---- +quarkus.oidc.provider=discord +quarkus.oidc.client-id= +quarkus.oidc.credentials.client-secret= +---- + +[[facebook]] +=== Facebook + +Facebook you will not be let you test your application on `localhost` like most other OIDC providers: +you will need to run it over HTTPS and make it publicly accessible, so for development purposes +you may want to use a service such as https://ngrok.com. + +In order to set up OIDC for Facebook start by https://developers.facebook.com/apps/create/[Creating an application], select `None` as an app type, and press `Next`: + +image::oidc-facebook-1.png[role="thumb"] + +Now enter an application name, and contact email, and press `Create app`: + +image::oidc-facebook-2.png[role="thumb"] + +On the app page, click `Set up` on the `Facebook login` product: + +image::oidc-facebook-3.png[role="thumb"] + +Quick the `Quickstarts` page and click on `Facebook login > Settings` on the left menu: + +image::oidc-facebook-4.png[role="thumb"] + +Enter your `Redirect URIs` (set to `/_renarde/security/oidc-success`) and press `Save changes`: + +image::oidc-facebook-5.png[role="thumb"] + +Now go to `Settings > Basic` on the left-hand menu, and write down your `App ID` and `App secret`: + +image::oidc-facebook-6.png[role="thumb"] + +You can now configure your `application.properties`: + +[source,properties] +---- +quarkus.oidc.provider=facebook +quarkus.oidc.client-id= +quarkus.oidc.credentials.secret= +---- + +`quarkus.oidc.provider=facebook` will request Facebook to add `email` and `public_profile` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. + [[github]] === GitHub @@ -37,7 +208,7 @@ In order to set up OIDC for GitHub you need to create a new OAuth application in image::oidc-github-1.png[role="thumb"] Make sure to fill in the appropriate details, but more importantly the Authorization Callback URL, set to `http://localhost:8080/_renarde/security/github-success` -(if you intend to test this using the Quarkus DEV mode). +(if you intend to test this using the Quarkus dev mode). Now click on `Register application` and you'll be shown your application page: @@ -58,9 +229,9 @@ quarkus.oidc.client-id= quarkus.oidc.credentials.secret= ---- -`quarkus.oidc.provider=github` will request `GitHub` to add a `user:email` scope to issued access tokens. For information about overriding this scope or requesting more scopes, see the <> section. +`quarkus.oidc.provider=github` will request GitHub to add a `user:email` scope to issued access tokens. For information about overriding this scope or requesting more scopes, see the <> section. -TIP: You can also send access tokens issued by `GitHub` to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications. +TIP: You can also send access tokens issued by GitHub to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications. [[google]] === Google @@ -113,9 +284,33 @@ quarkus.oidc.client-id= quarkus.oidc.credentials.secret= ---- -`quarkus.oidc.provider=google` will request `Google` to add `openid`, `email` and `profile` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. +`quarkus.oidc.provider=google` will request Google to add `openid`, `email` and `profile` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. -TIP: You can also send access tokens issued by `Google` to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications. +TIP: You can also send access tokens issued by Google to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications. + +[[linkedin]] +=== LinkedIn + +Create a https://developer.linkedin.com/[LinkedIn application]: + +image::oidc-linkedin-1.png[role="thumb"] + +Add the `Sign In with LinkedIn using OpenId Connect` product: + +image::oidc-linkedin-2.png[role="thumb"] + +You now can get your client id and secret. Don't forget to also add the authorized redirect URLs for your application: + +image::oidc-linkedin-3.png[role="thumb"] + +You can now configure your `application.properties`: + +[source,properties] +---- +quarkus.oidc.provider=linkedin +quarkus.oidc.client-id= +quarkus.oidc.credentials.client-secret= +---- [[mastodon]] === Mastodon @@ -192,9 +387,9 @@ quarkus.oidc.client-id= quarkus.oidc.credentials.secret= ---- -`quarkus.oidc.provider=microsoft` will request `Microsoft` to add `openid`, `email` and `profile` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. +`quarkus.oidc.provider=microsoft` will request Microsoft to add `openid`, `email` and `profile` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. -TIP: You can also send access tokens issued by `Microsoft` to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications but you may need to set `quarkus.oidc.verify-access-token-with-user-info` configuration property to `true` if access tokens issued by Microsoft are not in JWT format. +TIP: You can also send access tokens issued by Microsoft to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications but you may need to set `quarkus.oidc.verify-access-token-with-user-info` configuration property to `true` if access tokens issued by Microsoft are not in JWT format. [NOTE] ==== @@ -211,164 +406,73 @@ quarkus.oidc.token.customizer-name=azure-access-token-customizer ==== -[[apple]] -=== Apple - -In order to set up OIDC for Apple you need to create a developer account, and sign up for the 99€/year program, but you cannot test your application on `localhost` like most other OIDC providers: -you will need to run it over `https` and make it publicly accessible, so for development purposes -you may want to use a service such as https://ngrok.com. - -Go to https://developer.apple.com/account/resources/identifiers/list[Create a new identifier] and press `+` - -image::oidc-apple-1.png[role="thumb"] - -Don't touch anything, keep `App IDs` selected, and press `Continue`: - -image::oidc-apple-2.png[role="thumb"] - -Don't touch anything, keep `App` selected, and press `Continue`: - -image::oidc-apple-3.png[role="thumb"] - -Enter a description and a Bundle ID (use your application package name): - -image::oidc-apple-4.png[role="thumb"] - -Then scroll down to find the `Sign in with Apple` Capability, select it, and press `Continue`: - -image::oidc-apple-5.png[role="thumb"] - -Write down your App ID Prefix, then press `Register`: - -image::oidc-apple-6.png[role="thumb"] - -Back on the `Identifiers` page, press `+`: - -image::oidc-apple-7.png[role="thumb"] - -Select `Service IDs` and press `Continue`: - -image::oidc-apple-8.png[role="thumb"] - -Enter a description and Bundle ID (use your application package name), then press `Continue`: - -image::oidc-apple-9.png[role="thumb"] - -Now press `Register`: - -image::oidc-apple-10.png[role="thumb"] - -Back on the service list, click on your newly created service: - -image::oidc-apple-11.png[role="thumb"] - -Enable `Sign in with Apple` and press `Configure`: - -image::oidc-apple-12.png[role="thumb"] - -Add your domain and return URL (set to `/_renarde/security/oidc-success`) and press `Next`: - -image::oidc-apple-13.png[role="thumb"] - -Now press `Done`: - -image::oidc-apple-14.png[role="thumb"] - -Now press `Continue`: - -image::oidc-apple-15.png[role="thumb"] - -And now press `Save`: - -image::oidc-apple-16.png[role="thumb"] - -Go to the https://developer.apple.com/account/resources/authkeys/list[Keys] page on the left menu, and press `+`: - -image::oidc-apple-17.png[role="thumb"] - -Fill in a key name, enable `Sign in with Apple`, and press `Configure`: - -image::oidc-apple-18.png[role="thumb"] - -Select your Primary App ID and press `Save`: - -image::oidc-apple-19.png[role="thumb"] - -Back on the key page, press `Continue`: - -image::oidc-apple-20.png[role="thumb"] +[[spotify]] +=== Spotify -Now press `Register`: +Create a https://developer.spotify.com/documentation/general/guides/authorization/app-settings/[Spotify application]: -image::oidc-apple-21.png[role="thumb"] +image::oidc-spotify-1.png[role="thumb"] -Write down your `Key ID`, download your key and save it to your Quarkus application in `src/main/resources/AuthKey_.p8`: +Don't forget to add `http://localhost:8080` as a redirect URI for testing during development purposes. You should get a client id and secret generated once a Spotify application setup has been complete, for example: -image::oidc-apple-22.png[role="thumb"] +image::oidc-spotify-2.png[role="thumb"] You can now configure your `application.properties`: [source,properties] ---- -quarkus.oidc.provider=apple -quarkus.oidc.client-id= -quarkus.oidc.credentials.jwt.key-file=AuthKey_.p8 -quarkus.oidc.credentials.jwt.token-key-id= -quarkus.oidc.credentials.jwt.issuer= -quarkus.oidc.credentials.jwt.subject= +quarkus.oidc.credentials.secret= ---- -`quarkus.oidc.provider=apple` will request `Apple` to add `openid`, `email` and `name` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. - -[[facebook]] -=== Facebook - -Facebook you will not be let you test your application on `localhost` like most other OIDC providers: -you will need to run it over `https` and make it publicly accessible, so for development purposes -you may want to use a service such as https://ngrok.com. - -In order to set up OIDC for Facebook start by https://developers.facebook.com/apps/create/[Creating an application], select `None` as an app type, and press `Next`: - -image::oidc-facebook-1.png[role="thumb"] - -Now enter an application name, and contact email, and press `Create app`: +`quarkus.oidc.provider=spotify` will request Spotify to add `user-read-private` and `user-read-email` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. -image::oidc-facebook-2.png[role="thumb"] +[[strava]] +=== Strava -On the app page, click `Set up` on the `Facebook login` product: +Create a https://www.strava.com/settings/api[Strava application]: -image::oidc-facebook-3.png[role="thumb"] +image::oidc-strava-1.png[role="thumb"] -Quick the `Quickstarts` page and click on `Facebook login > Settings` on the left menu: +For example, set `Category` to `SocialMotivation`, and set `ApplicationCallbackDomain` to either `localhost` or the domain name provided by Ngrok, see the <> for more information. -image::oidc-facebook-4.png[role="thumb"] +You can now configure your `application.properties`: -Enter your `Redirect URIs` (set to `/_renarde/security/oidc-success`) and press `Save changes`: +[source,properties] +---- +quarkus.oidc.provider=strava +quarkus.oidc.client-id= +quarkus.oidc.credentials.client-secret= +# default value is '/strava' +quarkus.oidc.authentication.redirect-path=/fitness/welcome <1> +---- +<1> Strava does not enforce that the redirect (callback) URI which is provided as an authorization code flow parameter is equal to the URI registered in the Strava application because it only requires configuring `ApplicationCallbackDomain`. For example, if `ApplicationCallbackDomain` is set to `www.my-strava-example.com`, Strava will accept redirect URIs such as `www.my-strava-example.com/a`, `www.my-strava-example.com/path/a`, which is not recommended by OAuth2 best security practices, see link:https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#name-insufficient-redirect-uri-v[Insufficent redirect_uri validation] for more information. +Therefore you must configure a redirect path when working with the Strava provider and Quarkus will enforce that the current request path matches the configured `quarkus.oidc.authentication.redirect-path` value before completing the authotization code flow. See the <> for more information. -image::oidc-facebook-5.png[role="thumb"] +[[twitch]] +=== Twitch -Now go to `Settings > Basic` on the left-hand menu, and write down your `App ID` and `App secret`: +Create a https://dev.twitch.tv/console/apps[Twitch application]: -image::oidc-facebook-6.png[role="thumb"] +image::oidc-twitch-1.png[role="thumb"] You can now configure your `application.properties`: [source,properties] ---- -quarkus.oidc.provider=facebook -quarkus.oidc.client-id= -quarkus.oidc.credentials.secret= +quarkus.oidc.provider=twitch +quarkus.oidc.client-id= +quarkus.oidc.credentials.client-secret.value= ---- -`quarkus.oidc.provider=facebook` will request `Facebook` to add `email` and `public_profile` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. - -[[twitter]] -=== Twitter +[[x]] +=== [[twitter]] X (formerly Twitter) -You can use Twitter for OIDC login, but at the moment, it restricts access to the user's email, which means you +You can use X (formerly Twitter) for OIDC login, but at the moment, it restricts access to the user's email, which means you will have to obtain it and verify it yourself. -In order to set up OIDC for Twitter start by https://developer.twitter.com/en/portal/projects/new[Creating a project], enter a project name, and press `Next`: +In order to set up OIDC for X, start by https://developer.twitter.com/en/portal/projects/new[Creating a project], enter a project name, and press `Next`: image::oidc-twitter-1.png[role="thumb"] @@ -399,7 +503,7 @@ image::oidc-twitter-7.png[role="thumb"] Select `Web App` as application type, then fill in your application details (use `/_renarde/security/twitter-success` for the `Callback URI`). -NOTE: Twitter doesn't require https usage in practice, but won't accept your `Website URL` without it, so +NOTE: X doesn't require https usage in practice, but won't accept your `Website URL` without it, so you can still use ngrok for it. Now press `Save`: @@ -414,17 +518,17 @@ You can now configure your `application.properties`: [source,properties] ---- -quarkus.oidc.provider=twitter +quarkus.oidc.provider=x quarkus.oidc.client-id= quarkus.oidc.credentials.secret= ---- -`quarkus.oidc.provider=twitter` will request `Twitter` to add `offline.access`, `tweet.read` and `users.read` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. +`quarkus.oidc.provider=x` will request X to add `offline.access`, `tweet.read` and `users.read` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. [NOTE] ==== -Twitter provider requires Proof Key for Code Exchange (PKCE) which is supported by the `quarkus.oidc.provider=twitter` declaration. -Quarkus has to encrypt the current PKCE code verifier in a state cookie while the authorization code flow with Twitter is in progress and it will +X provider requires Proof Key for Code Exchange (PKCE) which is supported by the `quarkus.oidc.provider=x` declaration. +Quarkus has to encrypt the current PKCE code verifier in a state cookie while the authorization code flow with X is in progress and it will generate a secure random secret key for encrypting it. You can provide your own secret key for encrypting the PKCE code verifier if you prefer with the `quarkus.oidc.authentication.state-secret` property but @@ -433,120 +537,9 @@ note that this secret should be 32 characters long, and an error will be reporte [NOTE] ==== -`X` is a new name for `Twitter`, see <>. You can continue using `quarkus.oidc.provider=twitter` but it might need to be changed to `quarkus.oidc.provider=x` in the future. +X is the new name of Twitter. You can continue using `quarkus.oidc.provider=twitter` for the time being but it might become deprecated in the future. ==== -[[x]] -=== X - -`X` is a new name for `Twitter`. You can currently use either `quarkus.oidc.provider=x` or `quarkus.oidc.provider=twitter` but only `quarkus.oidc.provider=x` may end up supported in the future. - -Please see <> for more information about registering your Quarkus application in `X` (`Twitter`). - -[[spotify]] -=== Spotify - -Create a https://developer.spotify.com/documentation/general/guides/authorization/app-settings/[Spotify application]: - -image::oidc-spotify-1.png[role="thumb"] - -Don't forget to add `http://localhost:8080` as a redirect URI for testing during development purposes. You should get a client id and secret generated once a Spotify application setup has been complete, for example: - -image::oidc-spotify-2.png[role="thumb"] - -You can now configure your `application.properties`: - -[source,properties] ----- -quarkus.oidc.provider=spotify -quarkus.oidc.client-id= -quarkus.oidc.credentials.secret= ----- - -`quarkus.oidc.provider=spotiify` will request `Spotify` to add `user-read-private` and `user-read-email` scopes to issued access tokens. For information about overriding these scopes or requesting more scopes, see the <> section. - -[[twitch]] -=== Twitch - -Create a https://dev.twitch.tv/console/apps[Twitch application]: - -image::oidc-twitch-1.png[role="thumb"] - -You can now configure your `application.properties`: - -[source,properties] ----- -quarkus.oidc.provider=twitch -quarkus.oidc.client-id= -quarkus.oidc.credentials.client-secret.value= ----- - -[[discord]] -=== Discord - -Create a https://discord.com/developers/applications[Discord application]: - -image::oidc-discord-1.png[role="thumb"] - -You now can get your client id and secret: - -image::oidc-discord-2.png[role="thumb"] - -You can now configure your `application.properties`: - -[source,properties] ----- -quarkus.oidc.provider=discord -quarkus.oidc.client-id= -quarkus.oidc.credentials.client-secret= ----- - -[[linkedin]] -=== LinkedIn - -Create a https://developer.linkedin.com/[LinkedIn application]: - -image::oidc-linkedin-1.png[role="thumb"] - -Add the `Sign In with LinkedIn using OpenId Connect` product: - -image::oidc-linkedin-2.png[role="thumb"] - -You now can get your client id and secret. Don't forget to also add the authorized redirect URLs for your application: - -image::oidc-linkedin-3.png[role="thumb"] - -You can now configure your `application.properties`: - -[source,properties] ----- -quarkus.oidc.provider=linkedin -quarkus.oidc.client-id= -quarkus.oidc.credentials.client-secret= ----- - -[[strava]] -=== Strava - -Create a https://www.strava.com/settings/api[Strava application]: - -image::oidc-strava-1.png[role="thumb"] - -For example, set `Category` to `SocialMotivation`, and set `ApplicationCallbackDomain` to either `localhost` or the domain name provided by Ngrok, see the <> for more information. - -You can now configure your `application.properties`: - -[source,properties] ----- -quarkus.oidc.provider=strava -quarkus.oidc.client-id= -quarkus.oidc.credentials.client-secret= -# default value is '/strava' -quarkus.oidc.authentication.redirect-path=/fitness/welcome <1> ----- -<1> Strava does not enforce that the redirect (callback) URI which is provided as an authorization code flow parameter is equal to the URI registered in the Strava application because it only requires configuring `ApplicationCallbackDomain`. For example, if `ApplicationCallbackDomain` is set to `www.my-strava-example.com`, Strava will accept redirect URIs such as `www.my-strava-example.com/a`, `www.my-strava-example.com/path/a`, which is not recommended by OAuth2 best security practices, see link:https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#name-insufficient-redirect-uri-v[Insufficent redirect_uri validation] for more information. -Therefore you must configure a redirect path when working with the Strava provider and Quarkus will enforce that the current request path matches the configured `quarkus.oidc.authentication.redirect-path` value before completing the authotization code flow. See the <> for more information. - [[provider-scope]] == Provider scopes diff --git a/_guides/security-overview.adoc b/_guides/security-overview.adoc index 81217b8b412..5750dbd9a89 100644 --- a/_guides/security-overview.adoc +++ b/_guides/security-overview.adoc @@ -17,8 +17,12 @@ Before building security into your Quarkus applications, learn about the xref:se == Key features of Quarkus Security The Quarkus Security framework provides built-in security authentication mechanisms for Basic, Form-based, and mutual TLS (mTLS) authentication. +ifndef::no-webauthn-authentication[] You can also use other well-known xref:security-authentication-mechanisms.adoc#other-supported-authentication-mechanisms[authentication mechanisms], such as OpenID Connect (OIDC) and WebAuthn. - +endif::no-webauthn-authentication[] +ifdef::no-webauthn-authentication[] +You can also use other well-known xref:security-authentication-mechanisms.adoc#other-supported-authentication-mechanisms[authentication mechanisms], such as OpenID Connect (OIDC). +endif::no-webauthn-authentication[] Authentication mechanisms depend on xref:security-identity-providers.adoc[Identity providers] to verify the authentication credentials and map them to a `SecurityIdentity` instance with the username, roles, original authentication credentials, and other attributes. {project-name} also includes built-in security to allow for role-based access control (RBAC) based on the common security annotations `@RolesAllowed`, `@DenyAll`, `@PermitAll` on REST endpoints, and Contexts and Dependency Injection (CDI) beans. diff --git a/_guides/security-testing.adoc b/_guides/security-testing.adoc index bc79dc86e65..fa84c80d554 100644 --- a/_guides/security-testing.adoc +++ b/_guides/security-testing.adoc @@ -139,6 +139,43 @@ If it becomes necessary to test security features using both `@TestSecurity` and mechanism when none is defined), then Basic Auth needs to be enabled explicitly, for example by setting `quarkus.http.auth.basic=true` or `%test.quarkus.http.auth.basic=true`. +Similarly, if it becomes necessary to test security features using both `@TestSecurity` and Bearer token authentication, +you can leverage both like in the example below: + +[source, java] +---- +@Test +@TestSecurity(user = "Bob") +public void testSecurityMetaAnnotation { + RestAssured.given() + .auth().oauth2(getTokenForUser("Alice")) <1> + .get("hello") + .then() + .statusCode(200) + .body(Matchers.is("Hello Alice")); + RestAssured.given() + .get("hello") + .then() + .statusCode(200) + .body(Matchers.is("Hello Bob")); <2> +} + +@Path("hello") +public static class HelloResource { + + @Inject + SecurityIdentity identity; + + @Authenticated + @GET + public String sayHello() { + return "Hello " + identity.getPrincipal().getName(); + } +} +---- +<1> Bearer token authentication mechanism is used, because a Bearer access token is sent with the HTTP request. +<2> No authorization header is present, therefore the Test Security Extension creates user `Bob`. + === Path-based authentication `@TestSecurity` can also be used when xref:security-authentication-mechanisms.adoc#combining-authentication-mechanisms[authentication mechanisms must be combined]. diff --git a/_guides/security-webauthn.adoc b/_guides/security-webauthn.adoc index 1edac265a39..fc47d17acb4 100644 --- a/_guides/security-webauthn.adoc +++ b/_guides/security-webauthn.adoc @@ -67,8 +67,8 @@ Just in case you get there wondering what's the relation with https://fidoallian and whether we support it: sure, yes, PassKeys is a way that your authenticator devices can share and sync their credentials, which you can then use with our WebAuthn authentication. -NOTE: The WebAuthn specification requires `https` to be used for communication with the server, though -some browsers allow `localhost`. If you must use `https` in `DEV` mode, you can always use the +NOTE: The WebAuthn specification requires HTTPS to be used for communication with the server, though +some browsers allow `localhost`. If you must use HTTPS in dev mode, you can always use the https://docs.quarkiverse.io/quarkus-ngrok/dev/index.html[quarkus-ngrok] extension. == Architecture diff --git a/_guides/smallrye-graphql-client.adoc b/_guides/smallrye-graphql-client.adoc index 4aa0a118e0d..bfe20044634 100644 --- a/_guides/smallrye-graphql-client.adoc +++ b/_guides/smallrye-graphql-client.adoc @@ -363,7 +363,8 @@ This example showed how to use both the dynamic and typesafe GraphQL clients to GraphQL service and explained the difference between the client types. == References +ifndef::no-quarkus-oidc-client-graphql[] +* xref:security-openid-connect-client-reference.adoc#quarkus-oidc-client-graphql[Integrating OIDC clients into GraphQL clients] +endif::no-quarkus-oidc-client-graphql[] -* xref:security-openid-connect-client-reference.adoc#oidc-client-graphql-client[Integrating OIDC clients into GraphQL clients] * https://smallrye.io/smallrye-graphql/latest/[Upstream SmallRye GraphQL Client documentation] - diff --git a/_guides/spring-cloud-config-client.adoc b/_guides/spring-cloud-config-client.adoc index ccdeaf1b2be..58571289c8d 100644 --- a/_guides/spring-cloud-config-client.adoc +++ b/_guides/spring-cloud-config-client.adoc @@ -124,6 +124,12 @@ quarkus.spring-cloud-config.enabled=true quarkus.spring-cloud-config.url=http://localhost:8888 ---- +[TIP] +==== +If you are using Gradle, the Gradle setting `rootProject.name` has precedence over `quarkus.application.name` +so be sure to set the Gradle property to the application name you want the Spring Cloud Config server to see. +==== + == Package and run the application Run the application with: diff --git a/_guides/telemetry-opentracing-to-otel-tutorial.adoc b/_guides/telemetry-opentracing-to-otel-tutorial.adoc index 5f381e63294..35cfd903c84 100644 --- a/_guides/telemetry-opentracing-to-otel-tutorial.adoc +++ b/_guides/telemetry-opentracing-to-otel-tutorial.adoc @@ -302,7 +302,7 @@ innerSpan.setTag("error.message", e.getMessage());``` innerSpan.recordException(e);``` |- -|Baggage carried by SpanContext in the Span | Baggage is an independent signal propagated in parallel with the OTel Context +|Baggage carried by SpanContext in the Span |Baggage is an independent signal propagated in parallel with the OTel Context, it's not part of it. |=== diff --git a/_guides/tls-registry-reference.adoc b/_guides/tls-registry-reference.adoc new file mode 100644 index 00000000000..3c918ee0b26 --- /dev/null +++ b/_guides/tls-registry-reference.adoc @@ -0,0 +1,521 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += TLS registry reference +include::_attributes.adoc[] +:categories: network +:summary: TLS registry configuration and usage +:numbered: +:sectnums: +:sectnumlevels: 4 +:topics: TLS, http, SSL, HTTPS, security, network +:extensions: io.quarkus:quarkus-tls-registry + +The TLS registry is a Quarkus extension centralizing the TLS configuration for the application. +It allows to define the TLS configuration in a single place and to reference it from multiple places in the application. + +The TLS extension should be automatically added to your project as soon as you use a compatible extension. +For example, if your application uses Quarkus REST, gRPC or reactive routes, the TLS registry is automatically added to your project. + +== Examples + +To configure a TLS connection, and more specifically the key stores and trust stores, you use the `quarkus.tls.*` properties. + +Configuration directly under `quarkus.tls` is the default configuration that will be used by all the TLS connections in the application. +However, you can also have specific configurations for specific connections by using the `quarkus.tls..*` properties. + +=== Configure the HTTP server to use https:// + +To configure the HTTP server to use HTTPS, you can use the following configuration: + +[source,properties] +---- +quarkus.tls.key-store.pem.0.cert=server.crt +quarkus.tls.key-store.pem.0.key=server.key +quarkus.http.insecure-requests=disabled # Reject HTTP requests +---- + +So you a `p12` (PKCS12) key store, use the following configuration: + +[source,properties] +---- +quarkus.tls.key-store.p12.path=server-keystore.p12 +quarkus.tls.key-store.p12.password=secret +quarkus.http.insecure-requests=disabled # Reject HTTP requests +---- + +Instead of the default configuration, you can use a named configuration: + +[source,properties] +---- +quarkus.tls.https.key-store.p12.path=server-keystore.p12 +quarkus.tls.https.key-store.p12.password=secret +quarkus.http.insecure-requests=disabled +quarkus.http.tls-configuration-name=https +---- + +=== Configure a client to use https:// + +As an example to illustrate client configuration, we will use a gRPC client: + +[source,properties] +---- +quarkus.tls.trust-store.jks.path=grpc-client-truststore.jks +quarkus.tls.trust-store.jks.password=password + +quarkus.grpc.clients.hello.plain-text=false +quarkus.grpc.clients.hello.use-quarkus-grpc-client=true +---- + +=== Configuring mTLS + +To configure mTLS, you need to configure both the server and the client. +Both will receive a key store and a trust store: + +- the server key store contains the server certificate and private key +- the client key store contains the client certificate and private key +- the server trust store contains the client certificate (to authenticate the client) +- the client trust store contains the server certificate (to authenticate the server) + +[source,properties] +---- +quarkus.tls.my-server.key-store.p12.path=target/certs/grpc-keystore.p12 +quarkus.tls.my-server.key-store.p12.password=password +quarkus.tls.my-server.trust-store.p12.path=target/certs/grpc-server-truststore.p12 +quarkus.tls.my-server.trust-store.p12.password=password + +quarkus.tls.my-client.trust-store.p12.path=target/certs/grpc-client-truststore.p12 +quarkus.tls.my-client.trust-store.p12.password=password +quarkus.tls.my-client.key-store.p12.path=target/certs/grpc-client-keystore.p12 +quarkus.tls.my-client.key-store.p12.password=password + +quarkus.grpc.clients.hello.plain-text=false +quarkus.grpc.clients.hello.tls-configuration-name=my-client +quarkus.grpc.clients.hello.use-quarkus-grpc-client=true + +quarkus.http.ssl.client-auth=REQUIRED # Enable mTLS +quarkus.http.insecure-requests=disabled +quarkus.http.tls-configuration-name=my-server +quarkus.grpc.server.use-separate-server=false +quarkus.grpc.server.plain-text=false +---- + +== Referencing a TLS configuration + +Once you have configured a _named_ configuration using `quarkus.tls.`, you need to reference it. +This is done using the `tls-configuration-name` property: + +[source,properties] +---- +quarkus.tls.https.key-store.p12.path=server-keystore.p12 +quarkus.tls.https.key-store.p12.password=secret + +quarkus.http.insecure-requests=disabled +quarkus.http.tls-configuration-name=https # Reference the named configuration +---- + +== Configuring TLS + +Configuring TLS is mainly about key stores and trust stores. +The configuration depends on the format (`pem`, `p12`, `jks`...). +There are other important properties too. +This section details the various properties you can use to configure TLS. + +=== Key stores + +Key stores are used to store the private key and the certificate. +They are mainly used on the server-side, but can also be used on the client-side when mTLS is used. + +==== PEM key stores + +PEM key stores are composed of a list of pair of two files: the certificate and the private key. +The certificate file is a `.crt` or `.pem` file, and the private key file is often a `.key` file. + +To configure a PEM key store, use the following properties: + +[source,properties] +---- +quarkus.tls.key-store.pem.a.cert=server.crt +quarkus.tls.key-store.pem.a.key=server.key +quarkus.tls.key-store.pem.b.cert=my-second-cert.crt +quarkus.tls.key-store.pem.b.key=my-second-key.key +---- + +In general, you will only need one pair of certificate and private key. +The certificate may contain multiple certificates (a chain), but there should be one private key. + +When multiple pairs are configured, the selection is done using SNI (Server Name Indication). +The client will send the server name it wants to connect to, and the server will select the appropriate pair of certificate and private key. +Make sure xref:./tls-registry-reference.adoc#sni[SNI] is enabled on both the client and server to use this feature. + +IMPORTANT: When configuring multiple key/cert pairs, the order is following the lexicographical order of the name (`a` and `b` in the previous snippet). So, the first pair is the one with the lowest lexicographical order. You can define the order by using the `quarkus.tls.key-store.pem.order` property, for example: `quarkus.tls.key-store.pem.order=b,c,a`. This is important when using SNI, as the first pair is the default one. + +==== PKCS12 key stores + +PKCS12 key stores are a single file containing the certificate and the private key. +To configure a PKCS12 key store, use the following properties: + +[source,properties] +---- +quarkus.tls.key-store.p12.path=server-keystore.p12 +quarkus.tls.key-store.p12.password=secret +---- + +`.p12` files are password-protected, so you need to provide the password to open the key store. +Also, they can include more than one certificate and private key. +In this case, you can: + +- either provide the alias of the certificate and private key you want to use +- or use SNI to select the appropriate certificate and private key (all keys must use the same password) + +To configure the alias, use the following properties: + +[source,properties] +---- +quarkus.tls.key-store.p12.path=server-keystore.p12 +quarkus.tls.key-store.p12.password=secret +quarkus.tls.key-store.p12.alias=my-alias +quarkus.tls.key-store.p12.alias-password=my-alias-password +---- + +==== JKS key stores + +JKS key stores are a single file containing the certificate and the private key. +Note that the JKS format should be avoided as it is less secure than PKCS12. +To configure a JKS key store, use the following properties: + +[source,properties] +---- +quarkus.tls.key-store.jks.path=server-keystore.jks +quarkus.tls.key-store.jks.password=secret +---- + +`.jks` files are password-protected, so you need to provide the password to open the key store. +Also, they can include more than one certificate and private key. +In this case, you can: + +- either provide the alias of the certificate and private key you want to use +- or use SNI to select the appropriate certificate and private key (all keys must use the same password) + +To configure the alias, use the following properties: + +[source,properties] +---- +quarkus.tls.key-store.jks.path=server-keystore.jks +quarkus.tls.key-store.jks.password=secret +quarkus.tls.key-store.jks.alias=my-alias +quarkus.tls.key-store.jks.alias-password=my-alias-password +---- + +[#sni] +==== SNI + +Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. +It enables a server to present different TLS certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios. + +To enable SNI, use the following property: + +[source,properties] +---- +quarkus.tls.key-store.sni=true # Disabled by default +---- + +With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate: + +- When configuring the keystore with PEM files, multiple CRT/Key must be given. +- When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same. Do not set the `alias` property in this case. + +==== Credential providers + +Instead of passing the key store password and alias password in the configuration, you can use a credential provider. + +A credential provider offers a way to retrieve the key store password and alias password. +Note that the credential provider is only used if the password / alias password are not set in the configuration. + +To configure a credential provider, use the following properties: + +[source, properties] +---- +# The name of the credential bucket in the credentials provider +quarkus.tls.key-store.credentials-provider.name=my-credentials + +# The name of the bean providing the credential provider (optional, using the default credential provider if not set) +quarkus.tls.key-store.credentials-provider.bean-name=my-credentials-provider + +# The key used to retrieve the key store password, `password` by default +quarkus.tls.key-store.credentials-provider.password-key=password + +# The key used to retrieve the alias password, `alias-password` by default +quarkus.tls.key-store.credentials-provider.alias-password-key=alias-password +---- + +IMPORTANT: The credential provider can only be used with PKCS12 and JKS key stores. + +=== Trust stores + +Trust stores are used to store the certificates of the trusted parties. +They are generally used on the client-side, and on the server-side when mTLS is used. + +==== PEM trust stores + +PEM trust stores are composed of a list of `.crt` or `.pem` files. +Each of them contains a certificate. + +To configure a PEM trust store, use the following properties: + +[source,properties] +---- +quarkus.tls.trust-store.pem.certs=ca.crt,ca2.pem +---- + +==== PKCS12 trust stores + +PKCS12 trust stores are a single file containing the certificates. +When multiple certificates are included, you can use the alias to select the appropriate certificate. + +To configure a PKCS12 trust store, use the following properties: + +[source,properties] +---- +quarkus.tls.trust-store.p12.path=client-truststore.p12 +quarkus.tls.trust-store.p12.password=password +quarkus.tls.trust-store.p12.alias=my-alias +---- + +`.p12` files are password-protected, so you need to provide the password to open the trust store. +However, unlike for key stores, the alias does not require a password (because it's the public certificate and not a private key). + +==== JKS trust stores + +JKS trust stores are a single file containing the certificates. +When multiple certificates are included, you can use the alias to select the appropriate certificate. +Note that the JKS format should be avoided as it is less secure than PKCS12. + +To configure a JKS trust store, use the following properties: + +[source,properties] +---- +quarkus.tls.trust-store.jks.path=client-truststore.jks +quarkus.tls.trust-store.jks.password=password +quarkus.tls.trust-store.jks.alias=my-alias +---- + +`.jks` files are password-protected, so you need to provide the password to open the trust store. +However, unlike for key stores, the alias does not require a password (because it's the public certificate and not a private key). + +==== Credential providers + +Instead of passing the trust store password in the configuration, you can use a credential provider. + +A credential provider offers a way to retrieve passwords and other credentials. +Note that the credential provider is only used if the password is not set in the configuration. + +To configure a credential provider, use the following properties: + +[source, properties] +---- +# The name of the credential bucket in the credentials provider +quarkus.tls.trust-store.credentials-provider.name=my-credentials + +# The name of the bean providing the credential provider (optional, using the default credential provider if not set) +quarkus.tls.trust-store.credentials-provider.bean-name=my-credentials-provider + +# The key used to retrieve the trust store password, `password` by default +quarkus.tls.trust-store.credentials-provider.password-key=password +---- + +IMPORTANT: The credential provider can only be used with PKCS12 and JKS trust stores. + +=== Other properties + +While key stores and trust stores are the most important properties, there are other properties you can use to configure TLS. + +NOTE: while the following examples use the _default_ configuration, you can use the _named_ configuration by prefixing the properties with the name of the configuration. + +==== Cipher suites + +The cipher suites are the list of ciphers that can be used during the TLS handshake. +You can configure the ordered list of enabled cipher suites. +If not configured, a reasonable default is selected from the built-in ciphers. +However, when configured, it takes precedence over the default suite defined by the SSL engine in use. + +To configure the cipher suites, use the following property: + +[source,properties] +---- +quarkus.tls.cipher-suites=TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384 +---- + +==== TLS Protocol versions + +The TLS protocol versions are the list of protocols that can be used during the TLS handshake. +You can configure the ordered list of enabled TLS protocols. +If not configured , it defaults to `TLSv1.3`, `TLSv1.2`. + +Are supported: `TLSv1`, `TLSv1.1`, `TLSv1.2`, `TLSv1.3`. + +To only enable `TLSv1.3`, configure the following property: + +[source,properties] +---- +quarkus.tls.protocols=TLSv1.3 +---- + +==== Handshake timeout + +When a TLS connection is established, the handshake phase is the first step. +During this phase, the client and server exchange information to establish the connection, typically the cipher suite, the TLS protocol version, the certification validation and so on. + +To configure the timeout for the handshake phase, use the following property: + +[source,properties] +---- +quarkus.tls.handshake-timeout=10S # Default. +---- + +==== ALPN + +Application-Layer Protocol Negotiation (ALPN) is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. +ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. + +This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection. + +ALPN is enabled by default. +To disable it, use the following property: + +[source,properties] +---- +quarkus.tls.alpn=false +---- + +==== Certificate Revocation List (CRL) + +A Certificate Revocation List (CRL) is a list of certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. +When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore. + +You can configure the CRL with the list of certificate files you do not trust anymore. +Two formats are allowed: DER and PKCS#7 (also known as P7B). + +* When using the DER format, you must pass DER-encoded CRLs. +* When using the PKCS#7 format, you must pass PKCS#7 `SignedData` object, with the only significant field being `crls`. + +To configure the CRL, use the following property: + +[source,properties] +---- +quarkus.tls.certificate-revocation-list=ca.crl, ca2.crl +---- + +==== Trusting all certificates and hostname verification + +IMPORTANT: These two properties should not be used in production. + +You can configure your TLS connection to trust all certificates and to disable the hostname verification. +These are two different steps: + +- trusting all certificates ignores the certificate validation, so all certificates are trusted. It is useful for testing with self-signed certificates, but should not be used in production. +- hostname verification is the process of verifying the server's identity. It is useful to prevent man-in-the-middle attacks. It often defaults to `HTTPS` or `LDAPS`. + +To trust all certificates, use the following property: + +[source,properties] +---- +quarkus.tls.trust-all=true +---- + +To disable the hostname verification, use the following property: + +[source,properties] +---- +quarkus.tls.hostname-verification-algorithm=NONE +---- + +=== Configuration reference + +The following table lists the supported properties: + +include::{generated-dir}/config/quarkus-tls.adoc[opts=optional, leveloffset=+1] + +== The registry API + +While extensions will automatically use the TLS registry, you can also use the registry API to access the TLS configuration programmatically. + +To access the TLS configuration, inject the `TlsConfigurationRegistry` bean and gets the TLS configuration by name (or the default one): + +[source,java] +---- + @Inject + TlsConfigurationRegistry certificates; +// ... +TlsConfiguration def = certificates.getDefault().orElseThrow(); +TlsConfiguration named = certificates.get("name").orElseThrow(); +//... +---- + +The `TlsConfiguration` object contains the key stores, trust stores, cipher suites, protocols, and other properties. +It also provides a way to create an `SSLContext` from the configuration. + +As Vert.x is omnipresent in Quarkus, you can also use the `TlsConfiguration` object to configure the Vert.x client or server such as `KeyCertOptions`, `TrustOptions`, and so on. + +== Registering a certificate from an extension + +This section is only for extension developers. +An extension can register a certificate in the TLS registry. +This is useful when an extension needs to provide a certificate to the application or provides a different format. + +To achieve this, the extension _processor_ must produce a `TlsCertificateBuildItem`. +A `TlsCertificateBuildItem` is composed of a name and a `CertificateSupplier`. + +[source,java] +---- +TlsCertificateBuildItem item = new TlsCertificateBuildItem("named", + new MyCertificateSupplier()); +---- + +The certificate supplier is a runtime object that is generally retrieved using a recorder method. +Here is an example of a certificate supplier: + +[source,java] +---- +public class MyCertificateSupplier implements Supplier { + + @Override + public TlsConfiguration get() { + try { + KeyStore ks = KeyStore.getInstance("PKCS12"); + ks.load(getClass().getResourceAsStream("target/certs/test-registration-keystore.p12"), + "password".toCharArray()); + KeyStore ts = KeyStore.getInstance("PKCS12"); + ts.load(getClass().getResourceAsStream("target/certs/test-registration-truststore.p12"), + "password".toCharArray()); + return new BaseTlsConfiguration() { + @Override + public KeyStore getKeyStore() { + return ks; + } + + @Override + public KeyStore getTrustStore() { + return ts; + } + }; + } catch (Exception e) { + throw new RuntimeException(e); + } + } + } +---- + +== Startup checks + +When the application starts, the TLS registry performs some checks to ensure the configuration is correct: + +- the key stores and trust stores are accessible +- the aliases are available and accessible in the key stores and trust stores +- the certificates are valid +- the cipher suites and protocols are valid +- the CRLs are valid + +If any of these checks fail, the application will fail to start. diff --git a/_guides/websockets-next-reference.adoc b/_guides/websockets-next-reference.adoc index 01c6ad2e00d..4b93f261aa4 100644 --- a/_guides/websockets-next-reference.adoc +++ b/_guides/websockets-next-reference.adoc @@ -274,7 +274,7 @@ Uni consumeAsync(Message m) { } @OnTextMessage -ReponseMessage process(Message m) { +ResponseMessage process(Message m) { // Process the incoming message and send a response to the client. // The method is called for each incoming message. // Note that if the method returns `null`, no response will be sent to the client. @@ -287,7 +287,7 @@ Uni processAsync(Message m) { // Note that if the method returns `null`, no response will be sent to the client. The method completes when the returned Uni emits its item. } -OnTextMessage +@OnTextMessage Multi stream(Message m) { // Process the incoming message and send multiple responses to the client. // The method is called for each incoming message. @@ -496,6 +496,51 @@ The `WebSocketConnection` provides both a blocking and a non-blocking method to - `sendTextAndAwait(String message)`: Sends a text message to the client and waits for the message to be sent. It's blocking and should only be called from an executor thread. - `sendText(String message)`: Sends a text message to the client. It returns a `Uni`. It's non-blocking, but you must subscribe to it. +=== List open connections + +It is also possible to list all open connections. +Quarkus provides a CDI bean of type `io.quarkus.websockets.next.OpenConnections` that declares convenient methods to access the connections. + +[source, java] +---- +import io.quarkus.logging.Log; +import io.quarkus.websockets.next.OpenConnections; + +class MyBean { + + @Inject + OpenConnections connections; + + void logAllOpenConnections() { + Log.infof("Open connections: %s", connections.listAll()); <1> + } +} +---- +<1> `OpenConnections#listAll()` returns an immutable snapshot of all open connections at the given time. + +There are also other convenient methods. +For example, `OpenConnections#findByEndpointId(String)` makes it easy to find connections for a specific endpoint. + +=== CDI events + +Quarkus fires a CDI event of type `io.quarkus.websockets.next.WebSocketConnection` with qualifier `@io.quarkus.websockets.next.Open` asynchronously when a new connection is opened. +Moreover, a CDI event of type `WebSocketConnection` with qualifier `@io.quarkus.websockets.next.Closed` is fired asynchronously when a connection is closed. + +[source, java] +---- +import jakarta.enterprise.event.ObservesAsync; +import io.quarkus.websockets.next.Open; +import io.quarkus.websockets.next.WebSocketConnection; + +class MyBean { + + void connectionOpened(@ObservesAsync @Open WebSocketConnection connection) { <1> + // This observer method is called when a connection is opened... + } +} +---- +<1> An asynchronous observer method is executed using the default blocking executor service. + == Serialization and Deserialization The WebSocket Next extension supports automatic serialization and deserialization of messages. @@ -565,12 +610,28 @@ Item find(Item item) { 1. Specify the codec to use for both the deserialization of the incoming message 2. Specify the codec to use for the serialization of the outgoing message -== Handle Pong message +== Ping/pong messages -The `@OnPongMessage` annotation is used to consume pong messages. -A websocket endpoint must declare at most one method annotated with `@OnPongMessage`. +A https://datatracker.ietf.org/doc/html/rfc6455#section-5.5.2[ping message] may serve as a keepalive or to verify the remote endpoint. +A https://datatracker.ietf.org/doc/html/rfc6455#section-5.5.3[pong message] is sent in response to a ping message and it must have an identical payload. -The method must accept a single parameter of type `Buffer`: +The server automatically responds to a ping message sent from the client. +In other words, there is no need for `@OnPingMessage` callback declared on an endpoint. + +The server can send ping messages to a connected client. +The `WebSocketConnection` declares methods to send ping messages; there is a non-blocking variant: `WebSocketConnection#sendPing(Buffer)` and a blocking variant: `WebSocketConnection#sendPingAndAwait(Buffer)`. +By default, the ping messages are not sent automatically. +However, the configuration property `quarkus.websockets-next.server.auto-ping-interval` can be used to set the interval after which, the server sends a ping message to a connected client automatically. + +[source,properties] +---- +quarkus.websockets-next.server.auto-ping-interval=2 <1> +---- +<1> Sends a ping message to a connected client every 2 seconds. + +The `@OnPongMessage` annotation is used to define a callback that consumes pong messages sent from the client. +An endpoint must declare at most one method annotated with `@OnPongMessage`. +The callback method must return either `void` or `Uni`, and it must accept a single parameter of type `Buffer`. [source,java] ---- @@ -580,6 +641,8 @@ void pong(Buffer data) { } ---- +NOTE: The server can also send unsolicited pong messages that may serve as a unidirectional heartbeat. There is a non-blocking variant: `WebSocketConnection#sendPong(Buffer)` and also a blocking variant: `WebSocketConnection#sendPongAndAwait(Buffer)`. + [[websocket-next-security]] == Security @@ -630,18 +693,118 @@ public class Endpoint { `SecurityIdentity` is initially created during a secure HTTP upgrade and associated with the websocket connection. -Currently, for an HTTP upgrade be secured, users must configure an HTTP policy protecting the HTTP upgrade path. -For example, to secure the `open()` method in the above websocket endpoint, one can add the following authentication policy: +NOTE: When OpenID Connect extension is used and token expires, Quarkus automatically closes connection. + +== Secure HTTP upgrade + +An HTTP upgrade is secured when standard security annotation is placed on an endpoint class or an HTTP Security policy is defined. +The advantage of securing HTTP upgrade is less processing, the authorization is performed early and only once. +You should always prefer HTTP upgrade security unless, like in th example above, you need to perform action on error. +.Use standard security annotation to secure an HTTP upgrade +[source, java] +---- +package io.quarkus.websockets.next.test.security; + +import io.quarkus.security.Authenticated; +import jakarta.inject.Inject; + +import io.quarkus.security.identity.SecurityIdentity; +import io.quarkus.websockets.next.OnOpen; +import io.quarkus.websockets.next.OnTextMessage; +import io.quarkus.websockets.next.WebSocket; + +@Authenticated <1> +@WebSocket(path = "/end") +public class Endpoint { + + @Inject + SecurityIdentity currentIdentity; + + @OnOpen + String open() { + return "ready"; + } + + @OnTextMessage + String echo(String message) { + return message; + } +} +---- +<1> Initial HTTP handshake ends with the 401 status for anonymous users. +You can also redirect the handshake request on authorization failure with the `quarkus.websockets-next.server.security.auth-failure-redirect-url` configuration property. + +IMPORTANT: HTTP upgrade is only secured when a security annotation is declared on an endpoint class next to the `@WebSocket` annotation. +Placing a security annotation on an endpoint bean will not secure bean methods, only the HTTP upgrade. +You must always verify that your endpoint is secured as intended. + +.Use HTTP Security policy to secure an HTTP upgrade [source,properties] ---- -quarkus.http.auth.permission.secured.paths=/end -quarkus.http.auth.permission.secured.policy=authenticated +quarkus.http.auth.permission.http-upgrade.paths=/end +quarkus.http.auth.permission.http-upgrade.policy=authenticated ---- -Other options for securing HTTP upgrade requests, such as using the security annotations, will be explored in the future. +== Inspect and/or reject HTTP upgrade -NOTE: When OpenID Connect extension is used and token expires, Quarkus automatically closes connection. +To inspect an HTTP upgrade, you must provide a CDI bean implementing the `io.quarkus.websockets.next.HttpUpgradeCheck` interface. +Quarkus calls the `HttpUpgradeCheck#perform` method on every HTTP request that should be upgraded to a WebSocket connection. +Inside this method, you can perform any business logic and/or reject the HTTP upgrade. + +.Example HttpUpgradeCheck +[source, java] +---- +package io.quarkus.websockets.next.test; + +import io.quarkus.websockets.next.HttpUpgradeCheck; +import io.smallrye.mutiny.Uni; +import jakarta.enterprise.context.ApplicationScoped; + +@ApplicationScoped <1> +public class ExampleHttpUpgradeCheck implements HttpUpgradeCheck { + + @Override + public Uni perform(HttpUpgradeContext ctx) { + if (rejectUpgrade(ctx)) { + return CheckResult.rejectUpgrade(400); <2> + } + return CheckResult.permitUpgrade(); + } + + private boolean rejectUpgrade(HttpUpgradeContext ctx) { + var headers = ctx.httpRequest().headers(); + // implement your business logic in here + } +} +---- +<1> The CDI beans implementing `HttpUpgradeCheck` interface can be either `@ApplicationScoped`, `@Singleton` or `@Dependent` beans, but never the `@RequestScoped` beans. +<2> Reject the HTTP upgrade. Initial HTTP handshake ends with the 400 Bad Request response status code. + +TIP: You can choose WebSocket endpoints to which the `HttpUpgradeCheck` is applied with the `HttpUpgradeCheck#appliesTo` method. + +[[traffic-logging]] +== Traffic logging + +Quarkus can log the messages sent and received for debugging purposes. +To enable traffic logging, set the `quarkus.websockets-next.server.traffic-logging.enabled` configuration property to `true`. +The payload of text messages is logged as well. +However, the number of logged characters is limited. +The default limit is 100, but you can change this limit with the `quarkus.websockets-next.server.traffic-logging.text-payload-limit` configuration property. + +TIP: The messages are only logged if the `DEBUG` level is enabled for the logger `io.quarkus.websockets.next.traffic`. + +.Example configuration +[source, properties] +---- +quarkus.websockets-next.server.traffic-logging.enabled=true <1> +quarkus.websockets-next.server.traffic-logging.text-payload-limit=50 <2> + +quarkus.log.category."io.quarkus.websockets.next.traffic".level=DEBUG <3> +---- +<1> Enables traffic logging. +<2> Set the number of characters of a text message payload which will be logged. +<3> Enable `DEBUG` level is for the logger `io.quarkus.websockets.next.traffic`. [[websocket-next-configuration-reference]] == Configuration reference diff --git a/_guides/websockets-next-tutorial.adoc b/_guides/websockets-next-tutorial.adoc index 91a67eda53e..0e1756cf25f 100644 --- a/_guides/websockets-next-tutorial.adoc +++ b/_guides/websockets-next-tutorial.adoc @@ -3,7 +3,7 @@ This guide is maintained in the main Quarkus repository and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// -= Getting started with WebSockets-Next += Getting started with WebSockets Next include::_attributes.adoc[] :categories: web :diataxis-type: tutorial diff --git a/_guides/writing-native-applications-tips.adoc b/_guides/writing-native-applications-tips.adoc index c7b6f86c841..259f74ded76 100644 --- a/_guides/writing-native-applications-tips.adoc +++ b/_guides/writing-native-applications-tips.adoc @@ -234,6 +234,33 @@ The final order of business is to make the configuration file known to the `nati To do that, place the configuration file under the `src/main/resources/META-INF/native-image//` folder. This way they will be automatically parsed by the native build, without additional configuration. +=== Registering for proxy + +Analogous to `@RegisterForReflection`, you can use `@RegisterForProxy` to register interfaces for dynamic proxy: + +[source,java] +---- +@RegisterForProxy +public interface MyInterface extends MySecondInterface { +} +---- + +Note that `MyInterface` and all its super interfaces will be registered. + +Also, in case the interface is in a third-party jar, you can do it by using an empty class that will host the `@RegisterForProxy` for it. + +[source,java] +---- +@RegisterForProxy(targets={MyInterface.class, MySecondInterface.class}) +public class MyReflectionConfiguration { +} +---- + +[WARNING] +==== +Note that the order of the specified proxy interfaces is significant. For more information, see link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Proxy.html[Proxy javadoc]. +==== + [[delay-class-init-in-your-app]] === Delaying class initialization