Guides - Latest

Quarkus has an integrated 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.

Go more in depth into the Quarkus implementation of CDI.

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

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

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

This reference guide explains how to use:

Guidelines are provided to help you to contribute clear and consistent content that is also sourced in the required 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.

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.

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

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

List all the configuration properties per extensions

This guide explains how you can deploy Quarkus-based Amazon 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 Amazon Lambda.

This guide covers the systems integration with Apache Camel

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

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.

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

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

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.

This guide covers: Gradle configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable

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 image, and build a container friendly executable

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.

This guide explains logging and how to configure it.

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

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

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

Learn how to build and push container images with Jib, S2I or Docker 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.

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

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.

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

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

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

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.

If any Elasticsearch-related extension is present (e.g.

Start Apache Kafka automatically in dev and test modes.

If any Kogito process-related extension is present (e.g.

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

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 contribute features to the Dev UI.

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 Amazon Lambda binding.

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

This guide explains Funqy’s HTTP binding.

This guide explains Funqy’s Amazon Lambda HTTP binding.

This guide explains Funqy’s Azure Functions HTTP binding.

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

This guide explains Funqy’s Knative Events binding.

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

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

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

This guide demonstrates how your Quarkus application can utilize SmallRye Reactive 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.

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

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

Infinispan is an in memory data grid that allows running in a server outside of application processes.

Quarkus DI solution is based on the Contexts and Dependency Injection for Java 2.0 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.

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

Migrating from RESTEasy Classic to 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.

This guide demonstrates how to use the OpenID Connect Extension to protect your web application based on the Authorization Code Flow using Quarkus.

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

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

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

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

Learn more about Quarkus reactive architecture.

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.

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 JPA 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 guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.

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.

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 JPA 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 JAX-RS endpoints.

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

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

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 to power it up with predictions.

Use Kogito to add DRL files with rules.

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 JAX-RS 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 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 demonstrates how your Quarkus application can use Keycloak to protect your JAX-RS applications using bearer token authorization, where these tokens are issued by a Keycloak server.

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.

Podman is a daemonless and rootless container engine for developing, managing, and running OCI Containers on your Linux system or other OS.

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.

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.

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.

Quarkus comes with a Transaction Manager and uses it to coordinate and expose transactions to your applications.

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 guide covers how to use the Apache Cassandra NoSQL database in Quarkus.

This guide covers how to use MongoDB in Quarkus.

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 Reactive REST Client.

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

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

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

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.

JSON is now the lingua franca between microservices.

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

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

This guide explains how to benefit from Java 19 virtual threads when writing REST services in Quarkus.

YAML as a Configuration Source.

Entry point for everything gRPC.