| <div class="wiki-content maincontent"><p>The ActiveMQ Web Console is a web based administration tool for working with ActiveMQ. When used with the <a shape="rect" href="jmx.html">JMX</a> support it can be an invaluable tool for working with ActiveMQ</p><h3 id="WebConsole-RunningtheWebConsoleonActiveMQ5.0orlater">Running the Web Console on ActiveMQ 5.0 or later</h3><p>We have integrated the Web Console into the binary distribution. So <a shape="rect" href="download.html">Download</a> a binary distribution then follow the instructions for <a shape="rect" href="version-5-run-broker.html">Version 5 Run Broker</a>. Then you can point your web browser at the URL</p><ul><li><a shape="rect" class="external-link" href="http://localhost:8161/admin" rel="nofollow">http://localhost:8161/admin</a></li></ul><p>And hey presto, you should now have the Web Console running.</p><p>In the event that you are running a standalone broker and the Web Console is not reachable, check that the following lines are included in your ActiveMQ config xml:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"> |
| <property name="locations"> |
| <value>file:${activemq.base}/conf/credentials.properties</value> |
| </property> |
| </bean> |
| |
| <!-- your broker config goes here --> |
| |
| <import resource="${activemq.base}/conf/jetty.xml" /></pre> |
| </div></div><p>The import will start up an embedded Jetty container. To verify that the config is working, the following should appear in your ActiveMQ console/logs on next startup:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">INFO | jetty-7.1.6.v20100715 |
| INFO | ActiveMQ WebConsole initialized.</pre> |
| </div></div><h3 id="WebConsole-Changingtheport">Changing the port</h3><p>If you want to change the port number of the web console, see the configuration files in the conf directory.</p><h3 id="WebConsole-SecuringWebConsole">Securing Web Console</h3><p>Starting with ActiveMQ 5.4.0, Web Console comes pre-configured with basic access authentication setup. It's turned off by default, so you need to turn it on explicitly, but it's really simple. Go to the <code>${ACTIVEMQ_HOME}/conf/jetty.xml</code> and find the following line</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><property name="authenticate" value="false" /></pre> |
| </div></div><p>and change it to</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><property name="authenticate" value="true" /></pre> |
| </div></div><p>That's it. From that point on, web server will look at <code>${ACTIVEMQ_HOME}/conf/jetty-realm.properties</code> file trying to match provided credentials with those listed in the file. By default, you can access the web console with <code>admin/admin</code> credentials. That can be changed (and more users can be added) in the <code>jetty-realm.properties</code> file.</p><p>You may also wish to enable <strong>ssl connector</strong> to further secure access to the web console and other web resources of the broker. To do that, go to the <code>${ACTIVEMQ_HOME}/conf/jetty.xml</code> and make sure you have the secure connector enabled. In versions 5.7 and newer just uncomment a predefined config. In any case make sure your connectors settings looks similar to this.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> <property name="connectors"> |
| <list> |
| <bean id="Connector" class="org.eclipse.jetty.server.nio.SelectChannelConnector"> |
| <property name="port" value="8161" /> |
| </bean> |
| <bean id="SecureConnector" class="org.eclipse.jetty.server.ssl.SslSelectChannelConnector"> |
| <property name="port" value="8162" /> |
| <property name="keystore" value="file:${activemq.conf}/broker.ks" /> |
| <property name="password" value="password" /> |
| </bean> |
| </list> |
| </property> |
| </pre> |
| </div></div><p>Standard connector is left enabled in this example, but you can remove it in your configuration if you wish.</p><p>Note that these changes will affect the whole web server, so if you're using <a shape="rect" href="rest.html">REST</a> API or blob fileserver be sure to provide appropriate credentials.</p><p>If you're interested in securing 5.3.1 (and 5.3.2) Web consoles, take a look at <a shape="rect" class="external-link" href="http://www.nighttale.net/activemq/securing-activemq-531-console.html" rel="nofollow">this article</a>. For older versions, please refer to <a shape="rect" class="external-link" href="http://it.toolbox.com/blogs/unix-sysadmin/securing-activemq-web-console-27727" rel="nofollow">this article</a></p><h3 id="WebConsole-UsingtheWebConsole">Using the Web Console</h3><p>The web console is depicted in the following image:</p><p><span class="confluence-embedded-file-wrapper confluence-embedded-manual-size"><img class="confluence-embedded-image" height="250" src="web-console.data/web_console.png"></span></p><p>To get started, go to the <a shape="rect" class="external-link" href="http://localhost:8080/activemq-web-console/send.jsp" rel="nofollow">Send</a> page and send a message to a queue (you can send multiple if you like, see the message count field).</p><p>Now that you have sent messages to a queue you should be able to <a shape="rect" class="external-link" href="http://localhost:8080/activemq-web-console/browse.jsp" rel="nofollow">Browse</a> then and view the queue as an RSS or Atom feed.</p><p>The Web Console has many features relative to it's tabs as shown in the following table.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Tab</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Features</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Home</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" class="external-link" href="http://activemq.apache.org/producer-flow-control.html#ProducerFlowControl-Systemusage">System Usage</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Queues</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Topics</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" class="external-link" href="http://activemq.apache.org/advisory-message.html">Viewing Advisory Messages</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Subscribers</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Connections</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" class="external-link" href="http://activemq.apache.org/protocols.html">Protocols</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Scheduled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Send</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" class="external-link" href="http://activemq.apache.org/delay-and-schedule-message-delivery.html">Delay and Schedule Message Delivery</a></p></td></tr></tbody></table></div><h1 id="WebConsole-ExternalWebConsoles">External Web Consoles</h1><p>There are a number of external web consoles for Apache ActiveMQ in separate open source projects:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>External Project</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" class="external-link" href="http://hawt.io/" rel="nofollow">hawtio</a></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>hawtio is an open source HTML5 web application for visualising, managing, tracing and debugging Camel routes & endpoints, ActiveMQ brokers, JMX, OSGi and logging. Here is a <a shape="rect" class="external-link" href="http://www.bennet-schulz.com/2016/07/apache-activemq-and-hawtio.html" rel="nofollow">blog entry</a> how to install hawtio as web console for ActiveMQ.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" class="external-link" href="http://www.jboss.org/rhq" rel="nofollow">RHQ</a></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>RHQ is an open source operational monitoring tool which has support for Apache Camel (along with other Apache projects like Tomcat, httpd, ActiveMQ etc)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><a shape="rect" class="external-link" href="http://www.hermesjms.com/confluence/display/HJMS/Home" rel="nofollow">Hermes JMS</a></td><td colspan="1" rowspan="1" class="confluenceTd">HermesJMS is an extensible console that helps you interact with JMS providers making it simple to publish and edit messages, browse or seach queues and topics, copy messages around and delete them.</td></tr></tbody></table></div></div> |
| |
