Guides - Latest
Tutorials
Short and focused exercises to get you going quickly.
Building a Native Executable
Build native executables with GraalVM or Mandrel.
Collect metrics using Micrometer
Create an application that uses the Micrometer metrics library to collect runtime, extension and application metrics and expose them as a Prometheus (OpenMetrics) endpoint.
Creating Your First Application
Discover how to create your first Quarkus application.
Creating a tutorial
Create a new tutorial that guides users through creating, running, and testing a Quarkus application that uses annotations from an imaginary extension.
Getting Started With Reactive
Learn more about developing reactive applications with Quarkus.
Getting Started with Security using Basic authentication and Jakarta Persistence
Get started with Quarkus Security by securing your Quarkus application endpoints with the built-in Quarkus Basic authentication and the Jakarta Persistence identity provider and enabling role-based access control.
Migrate from OpenTracing to OpenTelemetry tracing
Migrate an application from OpenTracing to OpenTelemetry tracing in Quarkus 3.x.
Protect Quarkus web application by using an Auth0 OpenID Connect provider
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.
Protect a service application by using OpenID Connect (OIDC) Bearer token authentication
Use the Quarkus OpenID Connect (OIDC) extension to secure a Jakarta REST application with Bearer token authentication.
Protect a web application by using OpenID Connect (OIDC) authorization code flow
With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism.
Using our Tooling
Explore the Quarkus developer toolchain which makes Quarkus development so fast and enjoyable.
Your second Quarkus application
Discover some of the features that make developing with Quarkus a joyful experience.
How-to Guides
Step-by-step guides to covering key tasks, real world operations and common problems.
Contribute to Quarkus documentation
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.
Enable Basic authentication
Enable Basic authentication for your Quarkus project and allow users to authenticate with a username and password.
Update projects to the latest Quarkus version
Learn how to upgrade your projects to the latest version of Quarkus
YAML configuration
Optionally, use application.yaml
instead of application.properties
to configure your application.
Concepts
Explanations of some of the larger concepts and technologies involved with Quarkus.
Authentication mechanisms in Quarkus
The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications.
Basic authentication
HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
Configuring Well-Known OpenID Connect Providers
This document explains how to configure well-known social OIDC and OAuth2 providers.
Cross-origin resource sharing
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.
Duplicated context, context locals, asynchronous processing and propagation
When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread.
Identity providers
In the Quarkus Security framework, identity providers play a crucial role in authentication and authorization by verifying user identities.
OpenID Connect (OIDC) Bearer token authentication
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.
OpenID Connect authorization code flow mechanism for protecting web applications
To protect your web applications, you can use the industry-standard OpenID Connect (OIDC) Authorization Code Flow mechanism provided by the Quarkus OIDC extension.
Quarkus Security architecture
The Quarkus Security architecture provides several built-in authentication mechanisms and is highly customizable.
Quarkus Security overview
Quarkus Security is a framework that provides the architecture, multiple authentication and authorization mechanisms, and other tools for you to build secure and production-quality Java applications.
Quarkus documentation content types
Quarkus documentation is structured into four distinct content types: concepts, how-tos, tutorials, and references.
Security vulnerability detection and reporting in Quarkus
Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
References
Technical Resource that covers tools, components, and commands. The encyclopedia for Quarkus.
Quarkus Cheat Sheet
Authorization of web endpoints
Quarkus has an integrated pluggable web security layer.
Command Mode Applications
This reference guide explains how to develop command line applications with Quarkus.
Configure data sources in Quarkus
Use a unified configuration model to define data sources for Java Database Connectivity (JDBC) and Reactive drivers.
HTTP Reference
Learn more about configuring Quarkus’ Vert.x based HTTP layer - and Undertow if you are using servlets.
Infinispan Client Extension Reference Guide
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.
Logging configuration
Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs.
Mailer Reference Guide
This reference guide explains in more details the configuration and usage of the Quarkus Mailer.
Micrometer Metrics
Use Micrometer to collect metrics produced by Quarkus, its extensions, and your application.
Native Reference Guide
This guide is a companion to the Building a Native Executable, Using SSL With Native Images, and Writing Native Applications, guides.
OpenID Connect (OIDC) and OAuth2 Client and Filters Reference Guide
This reference guide explains how to use:
OpenID Connect (OIDC) configuration properties
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.
Quarkus style and content guidelines
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.
Qute Reference Guide
Learn everything you need to know about the Qute template engine.
Reactive Messaging AMQP 1.0 Connector Reference Documentation
This guide is the companion from the Getting Started with AMQP 1.0.
Reactive Messaging RabbitMQ Connector Reference Documentation
This guide is the companion from the Getting Started with RabbitMQ.
Redis Extension Reference Guide
Redis is an in-memory data store used as a database, cache, streaming engine, and message broker.
Using transactions in Quarkus
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).
Vert.x Reference Guide
This reference guide provides advanced details about the usage and the configuration of the Vert.x instance used by Quarkus.
Virtual Thread support reference
This guide explains how to benefit from Java 21+ virtual threads in Quarkus application.
General Guides
Other Quarkus Guides
AWS Lambda SnapStart Configuration
This document explains how to optimize your AWS Lambda application for SnapStart
AWS Lambda with RESTEasy Reactive, Undertow, or Reactive Routes
This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an AWS Lambda.
Accessing application properties with Spring Boot properties API
Use Spring Boot’s @ConfigurationProperties
in place of MicroProfile Config annotations
Apache Kafka Reference Guide
This reference guide provides an in-depth look on Apache Kafka and Smallrye Reactive Messaging framework.
Apache Pulsar Reference Guide
This reference guide provides an in-depth look on Apache Pulsar and Smallrye Reactive Messaging framework.
Application Data Caching
This guide explains how to cache expensive method calls of your CDI beans using simple annotations.
Application Initialization and Termination
You often need to execute custom actions when the application starts and clean up everything when the application stops.
Automate Quarkus deployment with Ansible
Build and deploy your Quarkus App using Ansible
Azure Functions with RESTEasy Reactive, Undertow, or Reactive Routes
Deploy Vert.x Web, Servlet, or RESTEasy microservices as a Microsoft Azure Function.
Build Items
Explore all the BuildItems you can consume/produce in your extensions.
Build analytics
This guide presents what build analytics is and how to configure it.
Build, Sign and Encrypt JSON Web Tokens
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.
Building Quarkus apps with Quarkus Command Line Interface (CLI)
Use the Quarkus CLI to create, build, run, and manage extensions for Quarkus projects.
CDI Integration Guide
Learn how to integrate your extension with Quarkus’ CDI container.
Centralized log management (Graylog, Logstash, Fluentd)
This guide explains how to centralize your logs with Logstash or Fluentd using the Graylog Extended Log Format (GELF).
Command Mode with Picocli
Simplify command line applications creation with the Picocli extension.
Compressing native executables using UPX
Ultimate Packer for eXecutables (UPX) is a compression tool reducing the size of executables.
Conditional Extension Dependencies
Trigger the inclusion on additional extensions based on certain conditions.
Configuring Your Application
Hardcoded values in your code is a no go (even if we all did it at some point ;-)).
Connecting to an Elasticsearch cluster
This guide covers how to interact with an Elasticsearch cluster using the low level REST client or the Elasticsearch Java client.
Consuming a gRPC Service
This guide explains how to consume gRPC services in your Quarkus application.
Container Images
Learn how to build and push container images with Jib, OpenShift or Docker as part of the Quarkus build.
Context Propagation in Quarkus
Learn more about how you can pass contextual information with SmallRye Context Propagation.
Cross-Site Request Forgery Prevention
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.
Deploying on OpenShift
This guide covers how to deploy a native application on OpenShift.
Deploying to Google Cloud Platform (GCP)
This guide explains how to deploy a Quarkus application to Google Cloud.
Deploying to Microsoft Azure Cloud
Deploy a Quarkus application to the Microsoft Azure cloud platform.
Deploying your gRPC Service in Kubernetes
This guide explains how to deploy your gRPC services in Quarkus to Kubernetes.
Dev Services Overview
A list of all extensions that support Dev Services and their configuration options.
Dev Services and UI for OpenID Connect (OIDC)
Start Keycloak or other providers automatically in dev and test modes.
Dev Services for Apicurio Registry
Start Apicurio Registry automatically in dev and test modes.
Dev Services for Databases
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.
Dev Services for Kubernetes
Start a Kubernetes API server automatically in dev and test modes.
Dev Services for Pulsar
With Quarkus Smallrye Reactive Messaging Pulsar extension (quarkus-smallrye-reactive-messaging-pulsar) Dev Services for Pulsar automatically starts a Pulsar broker in dev mode and when running tests.
Dev Services for RabbitMQ
Dev Services for RabbitMQ automatically starts a RabbitMQ broker in dev mode and when running tests.
Dev UI
Learn how to get your extension to contribute features to the Dev UI (v2).
Extension codestart
Provide users with initial code for extensions when generating Quarkus applications on code.quarkus.io and all the Quarkus tooling.
Extension for Spring Data API
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.
Extension for Spring Data REST
Spring Data REST simplifies the creation of CRUD applications based on our Spring Data compatibility layer.
Funqy
This guide explains basics of the Funqy framework, a simple portable cross-provider cloud function API.
Funqy Google Cloud Functions
This guide explains Funqy’s Google Cloud Platform Functions binding.
Funqy HTTP Binding with Azure Functions
Use Funqy HTTP binding with Microsoft Azure Functions to deploy your serverless Quarkus applications.
Funqy HTTP Binding with Google Cloud Functions
This guide explains Funqy’s Google Cloud Platform Functions HTTP binding.
Generating Jakarta REST resources with Panache
Hibernate ORM REST Data with Panache simplifies the creation of CRUD applications based on Jakarta REST and Hibernate ORM.
Getting Started to SmallRye Reactive Messaging with AMQP 1.0
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with AMQP.
Getting Started to SmallRye Reactive Messaging with Apache Kafka
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with Apache Kafka.
Getting Started to SmallRye Reactive Messaging with Apache Pulsar
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with Apache Pulsar.
Getting Started to SmallRye Reactive Messaging with RabbitMQ
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with RabbitMQ.
Getting Started with SmallRye Stork
The essence of distributed systems resides in the interaction between services.
Getting Started with gRPC
This guide explains how to start using gRPC in your Quarkus application.
Google Cloud Functions (Serverless)
This guide explains how you can deploy Quarkus-based Google Cloud Functions.
Google Cloud Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes
This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as a Google Cloud Function.
Hibernate Search guide
Hibernate Search allows you to index your entities in an Elasticsearch cluster and easily offer full text search in all your Hibernate ORM-based applications.
How dev mode differs from a production application
How dev mode differs from a production application
Implementing a gRPC Service
This guide explains how to implement gRPC services in your Quarkus application.
Initialization tasks
This reference guide explains how to configure initialization tasks
Introduction to Contexts and Dependency Injection (CDI)
Quarkus DI solution is based on the Jakarta Contexts and Dependency Injection 4.0 specification.
Kubernetes Client
This guide demonstrates how to use the Fabric8 Kubernetes client to interact with your Kubernetes cluster.
Kubernetes extension
This guide covers how to deploy a native application on Kubernetes.
Measuring Performance
This guide explains how to best measure the footprint of a Quarkus application.
Measuring the coverage of your tests
This guide explains how to measure the test coverage of your Quarkus application.
Migrating to RESTEasy Reactive
Migrating from RESTEasy Classic to RESTEasy Reactive is straightforward in most cases, however there are a few cases that require some attention.
Mutiny - Async for bare mortal
Mutiny is an intuitive, reactive programming library.
Narayana LRA Participant Support
This guides covers the usage of LRA to coordinate activities across services.
OpenID Connect Client and Token Propagation Quickstart
This guide explains how to use OpenID Connect and OAuth2 Client and Filters to acquire, refresh and propagate access tokens.
Packaging And Releasing With JReleaser
This guide covers packaging and releasing CLI applications using the JReleaser tool.
Quarkus Base Runtime Image
To ease the containerization of native executables, Quarkus provides a base image providing the requirements to run these executables.
Quarkus Extension Metadata
Quarkus extensions are distributed as Maven JAR artifacts that application and other libraries may depend on.
Quarkus Extension Registry
Learn more about the notion of extension registry and how you can use your own.
Quarkus Extension for Spring Cache API
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.
Quarkus Extension for Spring DI API
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.
Quarkus Extension for Spring Scheduling API
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.
Quarkus Extension for Spring Security API
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.
Quarkus Extension for Spring Web API
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.
Quarkus Maven Plugin
The Quarkus Maven Plugin builds the Quarkus applications, and provides helpers to launch dev mode or build native executables.
Quarkus Security with Jakarta Persistence
Quarkus provides a Jakarta Persistence (formerly known as JPA) identity provider, similar to the JDBC identity provider, suitable for use with the Basic and Form-based Quarkus Security mechanisms, which require a combination of username and password credentials.
Quarkus Virtual Thread support for gRPC services
This guide explains how to benefit from Java virtual threads when implementing a gRPC service.
Quarkus Virtual Thread support with Reactive Messaging
This guide explains how to benefit from Java virtual threads when writing message processing applications in Quarkus.
Qute Templating Engine
Learn more about how you can use templating in your applications with the Qute template engine.
Re-augment a Quarkus Application
Use mutable jars to rebuild your application with different build time configurations.
Reading properties from Spring Cloud Config Server
Quarkus provides a compatibility layer for Spring Cloud Config in the form of the spring-cloud-config-client extension.
Scheduling Periodic Tasks
Modern applications often need to run specific tasks periodically.
Scheduling Periodic Tasks with Quartz
You need clustering support for your scheduled tasks? This guide explains how to use the Quartz extension for that.
Sending emails using SMTP
Learn more about how you can send email from a Quarkus application with our reactive email client.
Simplified Hibernate ORM with Panache
Hibernate ORM is the de facto Jakarta Persistence implementation and offers you the full breadth of an Object Relational Mapper.
Simplified Hibernate ORM with Panache and Kotlin
This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
Simplified Hibernate Reactive with Panache
Simplified reactive ORM layer based on Hibernate Reactive.
Simplified MongoDB with Panache
This guide covers the usage of MongoDB using active records and repositories.
Simplified MongoDB with Panache and Kotlin
This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
SmallRye Fault Tolerance
This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
SmallRye GraphQL
This guide explains how to leverage SmallRye GraphQL to implement GraphQL services.
SmallRye GraphQL Client
This guide explains how to leverage SmallRye GraphQL Client to consume GraphQL services.
SmallRye Health
This guide demonstrates how your Quarkus application can utilize the SmallRye Health extension.
SmallRye Metrics
This guide demonstrates how your Quarkus application can utilize the SmallRye Metrics extension.
Testing Your Application
This guide covers testing in JVM mode, native mode, and injection of resources into tests
Tips for writing native applications
This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
Using Apache Kafka Streams
This guide demonstrates how your Quarkus application can utilize the Apache Kafka Streams API to implement stream processing applications based on Apache Kafka.
Using Apache Kafka with Schema Registry and Avro
Use Apache Kafka, Avro serialized records, and connect to a schema registry.
Using Blaze-Persistence
This guide explains how to use Blaze-Persistence to simplify your data and DTO layers.
Using Eclipse Vert.x API from a Quarkus Application
This guide explains how to use Vert.x in Quarkus to build reactive applications.
Using Flyway
This guide covers how to use the Flyway extension to manage your schema migrations.
Using Hibernate ORM and Jakarta Persistence
Hibernate ORM is the de facto Jakarta Persistence implementation and offers you the full breath of an Object Relational Mapper.
Using Hibernate Reactive
Hibernate Reactive is a reactive API for Hibernate ORM, supporting non-blocking database drivers and a reactive style of interaction with the database.
Using JMS
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.
Using JWT RBAC
This guide explains how your application can utilize SmallRye JWT to provide secured access to the Jakarta REST endpoints.
Using Keycloak Admin Client
The Quarkus Keycloak Admin Client and its reactive twin support Keycloak Admin Client which can be used to configure a running Keycloak server.
Using Liquibase
This guide covers how to use the Liquibase extension to manage your schema migrations.
Using Liquibase MongoDB
Liquibase is an open source tool for database schema change management, it allows managing MongoDB databases via it’s MongoDB Extension.
Using OAuth2 RBAC
This guide explains how your Quarkus application can utilize OAuth2 tokens to provide secured access to the Jakarta REST endpoints.
Using OpenAPI and Swagger UI
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.
Using OpenID Connect (OIDC) Multi-Tenancy
This guide demonstrates how your OpenID Connect application can support multi-tenancy so that you can serve multiple tenants from a single application.
Using OpenID Connect (OIDC) and Keycloak to Centralize Authorization
This guide demonstrates how your Quarkus application can authorize access to protected resources using Keycloak Authorization Services.
Using OpenTelemetry
This guide explains how your Quarkus application can utilize OpenTelemetry to provide distributed tracing for interactive web applications.
Using Podman with Quarkus
Podman is a daemonless and rootless container engine for developing, managing, and running OCI Containers on your Linux system or other OS.
Using SSL With Native Executables
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.
Using Security with .properties File
This guide demonstrates how your Quarkus application can use a .properties file to store your user identities.
Using Security with JDBC
This guide demonstrates how your Quarkus application can use a database to store your user identities.
Using Security with WebAuthn
This guide demonstrates how your Quarkus application can use WebAuthn authentication instead of passwords.
Using Security with an LDAP Realm
This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities.
Using Software Transactional Memory in Quarkus
This guides covers the usage of Software Transactional Memory (STM).
Using Stork with Kubernetes
This guide explains how to use Stork with Kubernetes for service discovery and load balancing.
Using WebSockets
This guide explains how your Quarkus application can utilize web sockets to create interactive web applications.
Using a Credentials Provider
This guides explains how to use the Vault credentials provider or implement your own custom one.
Using the Cassandra Client
This guide covers how to use the Apache Cassandra NoSQL database in Quarkus.
Using the event bus
This guide explains how different beans can interact using the event bus.
Using the legacy REST Client
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.
Using the legacy REST Client with Multipart
This guide explains how to use the RESTEasy Classic REST Client to send multipart REST requests, typically to upload documents.
Using xDS gRPC
This page explains how to enable xDS gRPC usage in your Quarkus application.
Validation with Hibernate Validator
This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
Writing REST Services with RESTEasy Reactive
Discover how to develop highly scalable reactive REST services with Jakarta REST and RESTEasy Reactive.
Writing Your Own Extension
Quarkus extensions optimize your applications by pushing as much work as possible to the build operation.