Introduction

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

Hawtio has lots of plugins such as: Apache ActiveMQ "Classic," Apache Camel, JMX, OSGi, Logs, Spring Boot, and Diagnostics. 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 or can be deployed as an OSGi bundle.

Get Started

• Running an executable JAR
• Running a Spring Boot app
• Deploying on Apache Karaf
• Deploying on OpenShift

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

Running an executable JAR

You can start up Hawtio on your machine using the hawtio-app executable JAR.

• hawtio-app-2.17.0.jar

Once you have downloaded it, just run this from the command line:

java -jar hawtio-app-2.17.0.jar

Running a Spring Boot app

Attaching the Hawtio console to your Spring Boot app is simple.

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

    <dependency>
      <groupId>io.hawt</groupId>
      <artifactId>hawtio-springboot</artifactId>
      <version>2.17.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.

Deploying on Apache Karaf

If you are using Apache Karaf 4.x and above:

feature:repo-add hawtio 2.17.0
feature:install hawtio

This will install all the features required for Hawtio. The Hawtio console can then be viewed at http://localhost:8181/hawtio.

Karaf versions prior to 4.x are not supported.

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.