Introduction

Hawtio is a lightweight and modular Web console for managing Java applications.

Hawtio has plugins such as: Apache Camel and JMX (Logs, Spring Boot, Quartz, and more will be provided soon). You can dynamically extend Hawtio with your own plugins or automatically discover plugins inside the JVM.

The only server side dependency (other than the static HTML/CSS/JS/images) is the excellent Jolokia library which has small footprint (around 300KB) and is available as a JVM agent, or comes embedded as a servlet inside the hawtio-default.war.

Get Started

• Running from CLI
• Running a Spring Boot app
• Running a Quarkus app
• Deploying on OpenShift

For more details and other containers, see Get Started Guide.

Running from CLI (JBang)

If you haven't installed JBang yet, first install it: https://www.jbang.dev/download/

You can start up Hawtio on your machine using the following jbang command.

jbang app install hawtio@hawtio/hawtio
hawtio --help

Running a Spring Boot app

Note

Hawtio v4 supports Spring Boot 3.x.

You can attach the Hawtio console to your Spring Boot app with the following steps.

1. Add io.hawt:hawtio-springboot to the dependencies in pom.xml:

   <dependency>
     <groupId>io.hawt</groupId>
     <artifactId>hawtio-springboot</artifactId>
     <version>4.2.0</version>
   </dependency>

2. Enable the Hawtio and Jolokia endpoints by adding the following line in application.properties:

   management.endpoints.web.exposure.include=hawtio,jolokia
   spring.jmx.enabled=true

Now you should be able to run Hawtio in your Spring Boot app as follows:

mvn spring-boot:run

Opening http://localhost:8080/actuator/hawtio should show the Hawtio console.

See Spring Boot example for a working example app.

Running a Quarkus app

Note

Hawtio v4 supports Quarkus 3.x.

You can attach the Hawtio console to your Quarkus app by adding io.hawt:hawtio-quarkus to the dependencies in pom.xml:

<dependency>
  <groupId>io.hawt</groupId>
  <artifactId>hawtio-quarkus</artifactId>
  <version>4.2.0</version>
</dependency>

Now you should be able to run Hawtio with your Quarkus app in development mode as follows:

mvn compile quarkus:dev

Opening http://localhost:8080/hawtio should show the Hawtio console.

See Quarkus example for a working example app.

Contributing

We love contributions! Here are the resources on how to get you involved in Hawtio development.

• FAQ
• Change Log
• How to contribute
• Community

Check out the GitHub issues for finding issues to work on.

License

Hawtio is licensed under Apache License, Version 2.0.