Apache Artemis Console Documentation

Documentation > Deploying

Deploying embedded in Artemis

The console releases are integrated into subsequent Apache Artemis releases.

Deploying in Jetty

Install Jetty Version 12 and make sure to add the modules http and ee10-deploy. See the Jetty Deploy Guide for more info

You will need to create a Jetty Context XML file in the webapps directory, name it artemis-console.xml and add the following:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://jetty.org/configure_10_0.dtd">

<Configure class="org.eclipse.jetty.ee10.webapp.WebAppContext"> 
  <Set name="contextPath">/console</Set> 
  <Set name="war">/myapps/artemis-console-war.war</Set> 
</Configure>

You can then start Jetty using the following command:

java -Dhawtio.authenticationEnabled=false -jar $JETTY_HOME/start.jar

NOTE: Since this is only running the Connect plugin Hawtio authentication is disabled. Authentication will take place on connection to the Artemis Broker.

Connect a browser to http://localhost:8080/console or the URL you configured for Jetty.

The connecting chapter explains how to connect to a running broker.

For full information on deploying Applications in Jetty see The Operations Guide

Deploying in Tomcat

Firstly you will need to install Tomcat Version 10.

There are many ways to deploy a WAR file using Tomcat. The Tomcat Documentation explains this in detail.

You will need to make sure that the context path for the console is configured to be /console, if the war were configured in the tomcat server.xml this would look like:

<Context path="/console" docBase="/myapps/artemis-console-war.war"/>

Since the console only deploys the connect plugin authentication by hawtio is done on connecting to the Artemis Broker you can disable authentication by setting the property:

export CATALINA_OPTS="-Dhawtio.authenticationEnabled=false"

Once Tomcat is started connect a browser to http://localhost:8080/console or the URL you configured for tomcat.

The connecting chapter explains how to connect to a running broker

Running from the cli (JBang)

You can install and run Hawtio from CLI using JBang. If you don’t have JBang locally yet, first install it following: https://www.jbang.dev/download/

Now you can install the latest Hawtio on your machine using the jbang command:

jbang app install hawtio@hawtio/hawtio

This will allow you to deploy Artemis Console using the following command:

hawtio --war-location /pathto/artemis-console-war.war --context-path /console

The command will automatically open the console at http://localhost:8080/hawtio/.

For a full list of configuration options run:

hawtio --help