Guides - Latest

Build native executables with GraalVM or Mandrel.

Create an application that uses the Micrometer metrics library to collect runtime, extension and application metrics and expose them as a Prometheus (OpenMetrics) endpoint.

Discover how to create your first Quarkus application.

Create a new tutorial that guides users through creating, running, and testing a Quarkus application that uses annotations from an imaginary extension.

Learn more about developing reactive applications with Quarkus.

Get started with Quarkus Security by securing your Quarkus application endpoints with the built-in Quarkus Basic authentication and the Jakarta Persistence identity provider, enabling role-based access control.

This guide explains how your Quarkus application can utilize web sockets to create interactive web applications.

Migrate an application from OpenTracing to OpenTelemetry tracing in Quarkus 3.x.

Learn how to use OpenID Connect (OIDC) and OAuth2 clients with filters to get, refresh, and propagate access tokens in your applications.

Quarkus Security provides comprehensive OpenId Connect (OIDC) and OAuth2 support with its quarkus-oidc extension, supporting both Authorization code flow and Bearer token authentication mechanisms.

Use the Quarkus OpenID Connect (OIDC) extension to secure a Jakarta REST application with Bearer token authentication.

Discover how to secure application HTTP endpoints by using the Quarkus OpenID Connect (OIDC) authorization code flow mechanism with the Quarkus OIDC extension, providing robust authentication and authorization.

Learn more about Quarkus integrations in IDEs.

Explore the Quarkus developer toolchain which makes Quarkus development so fast and enjoyable.

Discover some of the features that make developing with Quarkus a joyful experience.

Contribute to the documentation by using the recommended diataxis content types, steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal.

You can use Dev Services for Keycloak and the Dev UI for the OpenID Connect (OIDC) Keycloak provider and adapt these services for other OpenID Connect providers.

Enable Basic authentication for your Quarkus project and allow users to authenticate with a username and password.

You can configure your application to use Jakarta Persistence to store users’ identities.

Learn how to upgrade your projects to the latest version of Quarkus

How to use virtual threads in a REST application

Learn how to enable bearer token authorization in your Quarkus application using Keycloak Authorization Services for secure access to protected resources.

This guide demonstrates how your OpenID Connect (OIDC) application can support multitenancy to serve multiple tenants from a single application.

Optionally, use application.yaml instead of application.properties to configure your application.

Quarkus extensions can do a lot, or a little.

The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications.

HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.

This document explains how to configure well-known social OIDC and OAuth2 providers.

Cross-origin resource sharing (CORS) is an HTTP-header-based mechanism that allows a server to indicate any origins other than its own, from which a browser should permit loading resources.

When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread.

In the Quarkus Security framework, identity providers play a crucial role in authentication and authorization by verifying user identities.

Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer token authentication by using the Quarkus OpenID Connect (OIDC) extension.

To protect your web applications, you can use the industry-standard OpenID Connect (OIDC) Authorization Code Flow mechanism provided by the Quarkus OIDC extension.

Learn how to manage proactive authentication in Quarkus, including customizing settings and handling exceptions.

The Quarkus Security architecture provides several built-in authentication mechanisms and is highly customizable.

Quarkus Security is a framework that provides the architecture, multiple authentication and authorization mechanisms, and other tools to build secure and production-quality Java applications.

Quarkus documentation is structured into four distinct content types: concepts, how-tos, tutorials, and references.

Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.

This guide explains how you can access Git repositories with JGit.

This guide covers how to use multiple GCP services.

This guide covers how to use the Amazon DynamoDB database in Quarkus.

This guide covers how to use the Amazon Identity and Access Management in Quarkus.

This guide covers how to use the Amazon Key Management Service in Quarkus.

This guide covers how to use the Amazon S3 cloud storage in Quarkus.

This guide covers how to use the Amazon Simple Email Service in Quarkus.

This guide covers how to use the Amazon Simple Notification Service in Quarkus.

This guide covers how to use the Amazon Simple Queue Service in Quarkus.

This guide covers how to use the AWS Systems Manager in Quarkus.

Quarkus incorporates a pluggable web security layer.

Learn more about Quarkus class loading infrastructure.

This reference guide explains how to develop command line applications with Quarkus.

Learn more about how to configure your Quarkus applications.

Use a unified configuration model to define data sources for Java Database Connectivity (JDBC) and Reactive drivers.

This guide explains how your Quarkus application can read configuration properties at runtime from Consul.

This guide covers how to use GCP Secret Manager in Quarkus to consume configuration properties directly or via your application.properties.

Go more in depth into the Quarkus implementation of CDI.

Learn more about how you extract content from documents using the Apache Tika toolkit.

This guide covers how to use GCP BigQuery in Quarkus.

This guide covers how to use GCP Bigtable in Quarkus.

This guide covers how to use GCP Firestore in Quarkus.

This guide covers how to use GCP PubSub in Quarkus.

This guide covers how to use GCP Spanner in Quarkus.

This guide covers how to use GCP Storage in Quarkus.

Learn more about configuring Quarkus’ Vert.x based HTTP layer - and Undertow if you are using servlets.

Use Infinispan as the Quarkus cache backend

Infinispan is an in memory distributed data store and cache server that offers flexible deployment options and robust capabilities for storing, managing, and processing data.

Load shedding is the practice of detecting service overload and rejecting requests.

Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs.

This reference guide explains in more details the configuration and usage of the Quarkus Mailer.

Management interface configuration

Use Micrometer to collect metrics produced by Quarkus, its extensions, and your application.

This guide is a companion to the Building a Native Executable, Using SSL With Native Images, and Writing Native Applications, guides.

This guide covers how to use the Neo4j graph database in Quarkus.

You can use Quarkus extensions for OpenID Connect and OAuth 2.0 access token management, focusing on acquiring, refreshing, and propagating tokens.

Typically, you have to register an OIDC client (application) manually in your OIDC provider’s dashboard.

As a Quarkus developer, you configure the Quarkus OpenID Connect (OIDC) extension by setting the following properties in the src/main/resources/application.properties file.

The Quarkus Maven Plugin builds the Quarkus applications, and provides helpers to launch dev mode or build native executables.

Guidelines are provided to help you to contribute clear and consistent content that is also sourced in the required diataxis structure and composition of Quarkus documentation.

Learn everything you need to know about the Qute template engine.

This guide is the companion from the Getting Started with AMQP 1.0.

This guide is the companion from the Getting Started with RabbitMQ.

Use Redis as the Quarkus cache backend

Redis is an in-memory data store used as a database, cache, streaming engine, and message broker.

Learn more about the Scheduler extension.

This guide is the companion from the Stork Getting Started Guide.

TLS registry configuration and usage

This guide covers how to test your Quarkus web application with Playwright.

This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to consume and produce HTTP messages.

Keep confidential your database credentials by storing them in Vault.

Generate X.509 certificates with Vault’s PKI Secret Engine.

This guide explains how your Quarkus application can utilize OpenTelemetry to provide observability for interactive web applications.

This guide covers how to develop, build and serve your npm-compatible web applications such as React, Angular, Vue, Lit, Svelte, Astro, SolidJS, and others alongside Quarkus.

This guide explains how to use Sentry to monitor your application and be notified when exceptions occur.

This guide explains how you can use HashiCorp Vault to securely store your credentials in Quarkus.

This guide explains how you can use HashiCorp Vault for “encryption as a service”.

This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to consume and produce messages via WebSockets.

This guide covers how to set up bundling and minification (with source-map) for your web app scripts (JS, JSX, TS, TSX), dependencies (jQuery, htmx, Bootstrap, Lit etc.), and styles (CSS, SCSS, SASS).

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).

This reference guide provides advanced details about the usage and the configuration of the Vert.x instance used by Quarkus.

This guide explains how to benefit from Java 21+ virtual threads in Quarkus application.

The quarkus-websockets-next extension provides a modern declarative API to define WebSocket server and client endpoints.

This guide explains the various methods supported by Quarkus to authenticate to your Vault.

Learn how to configure gRPC code generation.

Learn how to configure gRPC server and clients.

This guide explains how you can deploy Quarkus-based AWS Lambdas.

This document explains how to optimize your AWS Lambda application for SnapStart

This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an AWS Lambda.

Use Spring Boot’s @ConfigurationProperties in place of MicroProfile Config annotations

List all the configuration properties per extensions

This guide covers the systems integration with Apache Camel

This reference guide provides an in-depth look on Apache Kafka and Quarkus Messaging extensions.

This reference guide provides an in-depth look on Apache Pulsar and the Quarkus Messaging extensions.

This reference guide explains how to enable AppCDS with Quarkus.

This guide explains how to cache expensive method calls of your CDI beans using simple annotations.

You often need to execute custom actions when the application starts and clean up everything when the application stops.

Build and deploy your Quarkus App using Ansible

Integrate Quarkus with the Microsoft Azure functions that you have written.

Deploy Vert.x Web, Servlet, or RESTEasy microservices as a Microsoft Azure Function.

Explore all the BuildItems you can consume/produce in your extensions.

This guide presents what build analytics is and how to configure it.

According to RFC7519, JSON Web Token (JWT) is a compact, URL-safe means of representing claims which are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code(MAC) and/or encrypted.

Use the Quarkus CLI to create, build, run, and manage extensions for Quarkus projects.

Learn step by step how to build a simple extension.

Learn how to integrate your extension with Quarkus’ CDI container.

This guide explains how to centralize your logs with Logstash or Fluentd using the Graylog Extended Log Format (GELF).

Simplify command line applications creation with the Picocli extension.

Ultimate Packer for eXecutables (UPX) is a compression tool reducing the size of executables.

Trigger the inclusion on additional extensions based on certain conditions.

Hardcoded values in your code is a no go (even if we all did it at some point ;-)).

This guide covers how to interact with an Elasticsearch cluster using the low level REST client or the Elasticsearch Java client.

This guide explains how to consume gRPC services in your Quarkus application.

Learn how to build and push container images with Jib, OpenShift, Docker, or Podman as part of the Quarkus build.

Learn more about how you can pass contextual information with SmallRye Context Propagation.

Get early test feedback with Continuous Testing.

Cross-Site Request Forgery (CSRF) is an attack that forces an end user to execute unwanted actions on a web application in which they are currently authenticated.

This guide covers how to deploy a native application on OpenShift.

This guide explains how to deploy a Quarkus application to Google Cloud.

Deploy your Quarkus applications on Heroku.

Deploy a Quarkus application to the Microsoft Azure cloud platform.

This guide explains how to deploy your gRPC services in Quarkus to Kubernetes.

An introduction to Dev Services and a list of all extensions that support Dev Services and their configuration options.

Start AMQP automatically in dev and test modes.

Start Apicurio Registry automatically in dev and test modes.

When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services.

Start Elasticsearch automatically in dev and test modes

Start Infinispan automatically in dev and test modes.

Start Apache Kafka automatically in dev and test modes.

Start a Kubernetes API server automatically in dev and test modes.

Quarkus supports a feature called Dev Services that allows you to create various datasources without any config.

With Quarkus Messaging Pulsar extension (quarkus-messaging-pulsar) Dev Services for Pulsar automatically starts a Pulsar broker in dev mode and when running tests.

Dev Services for RabbitMQ automatically starts a RabbitMQ broker in dev mode and when running tests.

Start Redis automatically in dev and test modes.

Learn how to get your extension to contribute features to the Dev UI (v2).

Extend and customize the Configuration.

How capabilities are implemented and used in Quarkus.

Provide users with initial code for extensions when generating Quarkus applications on code.quarkus.io and all the Quarkus tooling.

While you are encouraged to use Hibernate ORM with Panache for your data layer, Quarkus provides a compatibility layer for Spring Data JPA in the form of the spring-data-jpa extension.

Spring Data REST simplifies the creation of CRUD applications based on our Spring Data compatibility layer.

This guide explains basics of the Funqy framework, a simple portable cross-provider cloud function API.

This guide explains Funqy’s AWS Lambda binding.

This guide explains Funqy’s Google Cloud Platform Functions binding.

This guide explains Funqy’s HTTP binding.

This guide explains Funqy’s AWS Lambda HTTP binding.

Use Funqy HTTP binding with Microsoft Azure Functions to deploy your serverless Quarkus applications.

This guide explains Funqy’s Google Cloud Platform Functions HTTP binding.

This guide explains Funqy’s Knative Events binding.

This guide explains how to generate SBOMs for Quarkus applications in the CycloneDX format.

Hibernate ORM REST Data with Panache simplifies the creation of CRUD applications based on Jakarta REST and Hibernate ORM.

This guide demonstrates how your Quarkus application can utilize Quarkus Messaging to interact with AMQP.

This guide demonstrates how your Quarkus application can utilize Quarkus Messaging to interact with Apache Kafka.

This guide demonstrates how your Quarkus application can utilize Quarkus Messaging to interact with Apache Pulsar.

This guide demonstrates how your Quarkus application can utilize Quarkus Messaging to interact with RabbitMQ.

The essence of distributed systems resides in the interaction between services.

This guide explains how to start using gRPC in your Quarkus application.

This guide explains how you can deploy Quarkus-based Google Cloud Functions.

This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as a Google Cloud Function.

How dev mode differs from a production application

This guide explains how to implement gRPC services in your Quarkus application.

This reference guide explains how to configure initialization tasks

Quarkus DI solution is based on the Jakarta Contexts and Dependency Injection 4.1 specification.

Dev UI extension for Apache Kafka for development purposes.

This guide demonstrates how to use the Fabric8 Kubernetes client to interact with your Kubernetes cluster.

Use ConfigMaps as a configuration source for your Quarkus applications.

This guide covers how to deploy a native application on Kubernetes.

Group multiple configuration properties into an object.

This guide explains how to best measure the footprint of a Quarkus application.

This guide explains how to measure the test coverage of your Quarkus application.

Migrating from RESTEasy Classic to Quarkus REST (formerly RESTEasy Reactive) is straightforward in most cases, however there are a few cases that require some attention.

Mutiny is an intuitive, reactive programming library.

This guides covers the usage of LRA to coordinate activities across services.

Entry point for Observability DevServices

OTel-LGTM is all-in-one Docker image containing OpenTelemetry’s OTLP as the protocol to transport metrics, tracing and logging data to an OpenTelemetry Collector which then stores signals data into Prometheus (metrics), Tempo (traces) and Loki (logs), only to have it visualized by Grafana.

This guide covers packaging and releasing CLI applications using the JReleaser tool.

Learn more about what we call a Platform in the Quarkus world.

To ease the containerization of native executables, Quarkus provides a base image providing the requirements to run these executables.

Quarkus extensions are distributed as Maven JAR artifacts that application and other libraries may depend on.

Learn more about the notion of extension registry and how you can use your own.

While you are encouraged to use the Cache extension for your application-level caching, Quarkus provides a compatibility layer for Spring Cache in the form of the spring-cache extension.

While you are encouraged to use CDI annotations for injection, Quarkus provides a compatibility layer for Spring dependency injection in the form of the spring-di extension.

While you are encouraged to use the Scheduler or Quartz extensions to schedule tasks, Quarkus provides a compatibility layer for Spring Scheduled in the form of the spring-scheduled extension.

While you are encouraged to use the Quarkus Security layer to secure your applications, Quarkus provides a compatibility layer for Spring Security in the form of the spring-security extension.

While you are encouraged to use Jakarta REST annotations for defining REST endpoints, Quarkus provides a compatibility layer for Spring Web in the form of the spring-web extension.

Event-driven messaging systems have become the backbone of most modern applications, enabling the building of message-driven microservices or complex data streaming pipelines.

Learn more about Quarkus reactive architecture.

This guide explains how to benefit from Java virtual threads when implementing a gRPC service.

This guide explains how to benefit from Java virtual threads when writing message processing applications in Quarkus.

Develop and build your Quarkus application with Gradle

Develop and build your Quarkus application with Maven

Learn more about creating all kinds of Web applications with Quarkus.

Learn more about how you can use templating in your applications with the Qute template engine.

Use mutable jars to rebuild your application with different build time configurations.

This guide covers how to use the Reactive SQL Clients in Quarkus.

Quarkus provides a compatibility layer for Spring Cloud Config in the form of the spring-cloud-config-client extension.

Modern applications often need to run specific tasks periodically.

You need clustering support for your scheduled tasks? This guide explains how to use the Quartz extension for that.

Easy Quarkus-based scripting with jbang.

Use encrypted configuration values to protect sensitive passwords, secrets, tokens and keys.

This document describes how to test Quarkus Security.

Learn more about how you can send email from a Quarkus application with our reactive email client.

Hibernate ORM is the de facto Jakarta Persistence implementation and offers you the full breadth of an Object Relational Mapper.

This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.

Simplified reactive ORM layer based on Hibernate Reactive.

This guide covers the usage of MongoDB using active records and repositories.

This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.

This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.

This guide explains how to leverage SmallRye GraphQL to implement GraphQL services.

This guide explains how to leverage SmallRye GraphQL Client to consume GraphQL services.

This guide demonstrates how your Quarkus application can utilize the SmallRye Health extension.

This guide demonstrates how your Quarkus application can utilize the SmallRye Metrics extension.

This guide covers testing in JVM mode, native mode, and injection of resources into tests

This reference guide covers the QuarkusComponentTestExtension, a JUnit extension to ease the testing of components and mocking of their dependencies.

This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.

Hibernate Search Standalone allows you to index your entities in an Elasticsearch/OpenSearch cluster and easily offer full text search in all your applications, even without Hibernate ORM.

Hibernate Search with Hibernate ORM allows you to index your entities in an Elasticsearch/OpenSearch cluster and easily offer full text search in all your Hibernate ORM-based applications.

This guide demonstrates how your Quarkus application can utilize the Apache Kafka Streams API to implement stream processing applications based on Apache Kafka.

Use Apache Kafka, Avro serialized records, and connect to a schema registry.

Use Apache Kafka, Json Schema serialized records, and connect to a schema registry.

This guide explains how to use Blaze-Persistence to simplify your data and DTO layers.

This guide explains how to use Vert.x in Quarkus to build reactive applications.

This guide covers how to use the Flyway extension to manage your schema migrations.

Hibernate ORM is the de facto Jakarta Persistence implementation and offers you the full breath of an Object Relational Mapper.

Hibernate Reactive is a reactive API for Hibernate ORM, supporting non-blocking database drivers and a reactive style of interaction with the database.

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.

This guide explains how your application can utilize SmallRye JWT to provide secured access to the Jakarta REST endpoints.

This guide explains how Java Flight Recorder (JFR) can be extended to provide additional insight into your Quarkus application.

The Quarkus Keycloak Admin Client and its reactive twin support Keycloak Admin Client which can be used to configure a running Keycloak server.

This guide explains how to use Kotlin.

This guide covers how to use the Liquibase extension to manage your schema migrations.

Liquibase is an open source tool for database schema change management, it allows managing MongoDB databases via it’s MongoDB Extension.

This guide explains how your Quarkus application can utilize OAuth2 tokens to provide secured access to the Jakarta REST endpoints.

This guide explains how to use the OpenAPI extension to generate an OpenAPI descriptor and get a Swagger UI frontend to test your REST endpoints.

This guide explains how your Quarkus application can utilize OpenTelemetry Logging to provide distributed logging for interactive web applications.

This guide explains how your Quarkus application can utilize OpenTelemetry to provide metrics for interactive web applications.

This guide explains how your Quarkus application can utilize OpenTelemetry Tracing to provide distributed tracing for interactive web applications.

Podman is an open-source, daemonless, and rootless container engine for developing, managing, and running OCI Containers on Linux, Windows and Mac.

This guide demonstrates how to use reactive routes.

In this guide, we will discuss how you can get your native images to support SSL, as native images don’t support it out of the box.

Quarkus provides support for properties file-based authentication intended for development and testing purposes.

This guide demonstrates how your Quarkus application can use a database to store your user identities.

This guide demonstrates how your Quarkus application can use WebAuthn authentication instead of passwords.

This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities.

This guides covers the usage of Software Transactional Memory (STM).

This guide explains how to use Stork with Kubernetes for service discovery and load balancing.

This guide explains how your Quarkus application can utilize web sockets to create interactive web applications.

This guides explains how to use the Vault credentials provider or implement your own custom one.

This page explains how to use gRPC CLI.

This guide covers how to use the Apache Cassandra NoSQL database in Quarkus.

This guide covers how to use Infinispan with Quarkus.

This guide covers how to use MongoDB in Quarkus.

This guide explains how to use the REST Client.

This guide covers how to use a Redis datastore in Quarkus.

This guide explains how different beans can interact using the event bus.

This guide explains how to use the RESTEasy Classic REST Client in order to interact with REST APIs (JSON and other) with very little effort.

This guide explains how to use the RESTEasy Classic REST Client to send multipart REST requests, typically to upload documents.

This page explains how to enable xDS gRPC usage in your Quarkus application.

This guide covers how to use Hibernate Validator/Bean Validation in your REST services.

Learn more about how to use the web dependency locator

JSON is now the lingua franca between microservices.

Discover how to develop highly scalable reactive REST services with Jakarta REST and Quarkus REST.

Quarkus extensions optimize your applications by pushing as much work as possible to the build operation.

Entry point for everything gRPC.