Chapter 4. Setting up and Accessing the Web Console

Revision History
06/01/12
Added the content about console security.
12/06/12
Made it clear that the Web console is only for standalone containers

Abstract

Red Hat JBoss A-MQ's Web console is an easy way to query a standalone broker for JMX statistics, destination statuses, and information on any routes deployed in the broker.
The Red Hat JBoss A-MQ Web console is an embedded console for administering standalone broker. Using the embedded console is an easy way to manage your broker with minimal configuration.
Warning
For monitoring a broker hosted in a Fabric container, use the management console. The JBoss A-MQ Web console does not work in a Fabric container.
If you want more security, more reliability, or the ability to monitor master/slave clusters, you can deploy the Web console as a standalone application. It is easy to deploy into Tomcat or any standard Web container.

4.1. Using the Embedded Web Console

Revision History
12/06/12
Made it clear that Web console doesn't work in Fabric
12/06/12
Removed the enterprise and disto conditions

Abstract

By default, the Red Hat JBoss A-MQ Web console is deployed along with the a message broker. It is accessible at http://hostName:portNum/activemqweb.

Overview

For a standalone broker the default configuration is for the Web console to be loaded along with the broker. The default address for the standalone broker's console is localhost:8181/activemqweb.
Warning
When a broker is deployed into a fabric, the default configuration profile does not include the Web console. The Red Hat JBoss A-MQ Web console does not work in a Fabric container, so to achieve similar functionality you can use the management console.
The default port and security configuration can easily be modified.

Accessing the console

JBoss A-MQ Web console's address is http://hostName:portNum/activemqweb.
For example, to access the default broker administration console on your local machine, you would point your Web browser at http://localhost:8181/activemqweb.

Changing the port

The port number at which the Web console is accessed is controlled by the broker's Pax Web server. To change the port, you need to edit the org.osgi.service.http.port property in the org.ops4j.pax.web OSGi Admin PID.
Example 4.1, “Changing the Web Console's Port” shows the console commands used to change the port number of a standalone broker's Web console to 8536.

Example 4.1. Changing the Web Console's Port

JBossA-MQ:karaf@root> config:edit org.ops4j.pax.web
JBossA-MQ:karaf@root> config:proplist
 service.pid = org.ops4j.pax.web javax.servlet.context.tempdir = InstallDir/data/pax-web-jsp org.osgi.service.http.port = 8181 org.ops4j.pax.web.config.file = InstallDir/etc/jetty.xml org.apache.karaf.features.configKey = org.ops4j.pax.web
JBossA-MQ:karaf@root> config:propset org.osgi.service.http.port 8536
JBossA-MQ:karaf@root> config:update

Securing the console

The security for the Web console is provided by the Web container in which it is deployed. For the embedded instance of the Web console, you need to configure the embedded Jetty container's security by editing conf/jetty.xml.
See Section 4.2, “Securing the Web Console” for details.