Guides - Latest

Discover how to create your first Quarkus application.

Learn more about developing reactive applications with Quarkus.

Build native executables with GraalVM or Mandrel.

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

Learn more about Quarkus integrations in IDEs.

Hardcoded values in your code is a no go (even if we all did it at some point ;-)). In this guide, we learn how to configure your application.

Learn more about how to configure your Quarkus applications.

Group multiple configuration properties into an object.

Extend and customize the Configuration.

YAML as a Configuration Source.

List all the configuration properties per extensions

You often need to execute custom actions when the application starts and clean up everything when the application stops. This guide explains how to be notified when an application stops or starts.

Quarkus DI solution is based on the Contexts and Dependency Injection for Java 2.0 specification. This guide explains the basics of CDI.

Go more in depth into the Quarkus implementation of CDI.

Learn more about how to develop reactive applications with Quarkus.

This guide covers:

• Testing in JVM mode
• Testing in native mode
• Injection of resources into tests

Get early test feedback with Continuous Testing.

A list of all extensions that support Dev Services and their configuration options.

This guide explains logging and how to configure it.

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

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

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

Learn more about the base runtime image used by Quarkus for native executables and how you can tweak it.

Learn how you can reduce the size of your native executables with UPX.

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

Explore in more details how to debug native executables.

JSON is now the lingua franca between microservices. In this guide, we see how you can get your REST services to consume and produce JSON payloads.

Discover how to develop highly scalable REST services with JAX-RS and RESTEasy Reactive.

This guide explains how to use the RESTEasy Reactive REST Client.

This guide explains how to migrate an application from RESTEasy Classic to RESTEasy Reactive.

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

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

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

This guide explains how your Quarkus application can utilize web sockets to create interactive web applications. Because it’s the canonical web socket application, we are going to create a simple chat application.

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 to use the RESTEasy REST Client in order to interact with REST APIs (JSON and other) with very little effort.

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

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

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

This guide demonstrates how to use reactive routes.

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.

With Quarkus, you can easily configure a datasource, or several if need be.

Automatically start database containers with Dev Services.

Hibernate ORM is the de facto JPA implementation and offers you the full breath of an Object Relational Mapper. It works beautifully in Quarkus.

Hibernate ORM is the de facto JPA implementation and offers you the full breadth of an Object Relational Mapper. It makes complex mappings possible, but it does not make simple and common mappings trivial. Panache focuses on making your entities trivial and fun to write.

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

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.

Quarkus comes with a Transaction Manager and uses it to coordinate and expose transactions to your applications. Each extension dealing with persistence will integrate with it for you. And you will explicitly interact with transactions via CDI. This guide will walk you through all that.

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

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

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

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

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

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

Reactive API for Hibernate ORM

Simplified reactive ORM layer based on Hibernate Reactive.

Infinispan is an in memory data grid that allows running in a server outside of application processes. This extension provides functionality to allow the client that can connect to said server when running in Quarkus.

This guide covers how to use an Elasticsearch cluster using the low level or high level REST clients.

Start Elasticsearch automatically in dev and test modes.

This guide covers how to use MongoDB in Quarkus.

Manage your MongoDB schema migrations with Liquibase.

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 covers how to use a Redis datastore in Quarkus.

Learn how to customize the Redis client to your needs.

Start Redis automatically in dev and test modes.

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

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

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

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

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 Spanner in Quarkus.

This guide covers how to use GCP Storage in Quarkus.

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

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

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

This reference guide provides an in-depth look on Apache Kafka and Smallrye Reactive Messaging framework.

Start Apache Kafka automatically in dev and test modes.

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

Start Apicurio Registry automatically in dev and test modes.

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

Reference guide for SmallRye Reactive Messaging and AMQP.

Start AMQP automatically in dev and test modes.

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

Reference guide for SmallRye Reactive Messaging and RabbitMQ.

Start RabbitMQ automatically in dev and test modes.

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

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

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

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

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 covers how to use GCP PubSub in Quarkus.

This guide is the entry point for everything security in Quarkus.

Secure your web endpoints with authorizations.

Learn more about how Quarkus handles authentication.

Customize Quarkus’ security layer behavior.

Test the security of your Quarkus applications.

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

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

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 a LDAP directory to store your user identities.

This guide demonstrates how to use the OpenID Connect extension to protect your Quarkus JAX-RS service application using Bearer Token Authorization where the tokens are issued by OpenID Connect Providers such as Keycloak.

This guide demonstrates how to use the OpenID Connect extension to protect your Quarkus JAX-RS web application using the Authorization Code Flow and OpenID Connect Providers such as Keycloak.

This guide demonstrates how your OpenID Connect application can support multi-tenancy so that you can serve multiple tenants from a single application.

This guide demonstrates how your Quarkus application can authorize access to protected resources using Keycloak Authorization Services.

This guide explains how to use OpenID Connect and OAuth2 Client and Filters to acquire, refresh and propagate access tokens.

Reference guide for OpenID Connect and OAuth2 Client and Filters.

This guide explains how to configure Quarkus to authenticate against well-known OpenID Connect providers such as GitHub, Google, Microsoft, Apple…

Start Keycloak or other providers automatically in dev and test modes.

This guide explains how your application can utilize SmallRye JWT to verify JWT tokens and provide secured access to the JAX-RS endpoints.

This guide explains how your application can build, sign and/or encrypt JWT tokens with a fluent and configurable SmallRye JWT Build API.

This guide explains how your Quarkus application can utilize OAuth2 tokens to provide secured access to the JAX-RS endpoints.

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

Keep confidential your database credentials by storing them in Vault.

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

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

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

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

This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with business processes and rules.

Use Kogito to add business automation and power it up with DMN decision support.

Use Kogito to add DRL files with rules.

Use Kogito to add business automation to power it up with predictions.

Start Kogito automatically in dev and test modes.

This guide walks you through the process of creating a Quarkus application with OptaPlanner’s constraint solving Artificial Intelligence (AI).

This guide covers the systems integration with Apache Camel

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

Simplify command line applications creation with the Picocli extension.

Easy Quarkus-based scripting with jbang.

Learn how to use SmallRye Stork for service discovery and load balacing.

Learn how to use SmallRye Stork in a Kubernetes environment.

Have a more in-depth look at how SmallRye Stork can be configured and used.

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

Use Podman instead of Docker for running containers.

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

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

Use ConfigMaps as a configuration source for your Quarkus applications.

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

This guide explains how to deploy a Quarkus application to Microsoft Azure Cloud.

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

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

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

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

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.

Deploy your Quarkus applications on Heroku.

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

This guide explains Funqy’s HTTP binding.

This guide explains Funqy’s Amazon Lambda binding.

This guide explains Funqy’s Amazon Lambda HTTP binding.

This guide explains Funqy’s Knative Events binding.

This guide explains Funqy’s Azure Functions HTTP binding.

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

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

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

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

This guide covers how to use the Amazon Identity and Access Management 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.

This guide covers how to use multiple GCP services.

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

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

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

This guide demonstrates how your Quarkus application can collect metrics using the Micrometer extension.

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

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

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

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

JSON is now the lingua franca between microservices. In this guide, we see how you can get your REST services to consume and produce JSON payloads.

Entry point for everything gRPC.

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

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

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

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

This guide covers:

• Maven configuration
• Creating a new project
• Dealing with extensions
• Development mode
• Debugging
• Import in your IDE
• Building a native executable
• Build a container friendly executable

This guide covers:

• Gradle configuration
• Creating a new project
• Dealing with extensions
• Development mode
• Debugging
• Import in your IDE
• Building a native executable
• Build a container friendly executable

Discover how you can streamline the release process of your Quarkus applications with JReleaser.

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

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

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 JAX-RS annotations for defining REST endpoints, Quarkus provides a compatibility layer for Spring Web in the form of the spring-web extension.

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.

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 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 the Scheduler or Quartz extensions to schedule tasks, Quarkus provides a compatibility layer for Spring Scheduled in the form of the spring-scheduled extension.

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

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. In this guide, you learn how to schedule periodic tasks.

Learn more about the Scheduler extension.

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

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

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

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

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

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

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

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

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

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

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

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

This guide explains how to use Kotlin.

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

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

Learn step by step how to build a simple extension.

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

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

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

How capabilities are implemented and used in Quarkus.

Trigger the inclusion on additional extensions based on certain conditions.

Quarkus extensions optimize your applications by pushing as much work as possible to the build operation. This guide explains the rationale of Quarkus extensions and guides you through authoring your own extensions.

Provide users with initial code for extensions when generating Quarkus applications on code.quarkus.io and all the Quarkus tooling. This guide explains how to create and configure a Codestart for an extension.

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

Learn more about Quarkus reactive architecture.

Learn more about Quarkus class loading infrastructure.

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

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

How dev mode differs from a production application