Installing the Management Console

You can also deploy the Management Console agent in a Mule ESB instance packaged as a Web app.

You must ensure that the class path for the Mule Web application includes the Management Console agent JAR file and the necessary files required for any additional Mule modules.

To integrate the agent on a Mule ESB instance running as a Web application, add to the libraries folder the following .jar files:

mmc-agent-mule3-impl-<latest Mule ESB version>-full.jar

mule-module-cluster-ee.jar

mule-module-tracking-ee.jar

You can obtain the .jar files from the customer portal.

A specific listener should be added to the file web.xml, as follows:

If your web.xml includes:

…​you need to remove it. Otherwise the same Mule app would start twice.

You can deploy the Management Console and your Mule applications inside Tomcat/Tcat without any modifications, other than specifying JVM parameters.

See TCat Server Documentation for instructions on how to deploy Web applications inside of Tcat.

After your JVM parameters in Tomcat as follows:

For Windows:

For MacOS/Linux:

We recommend running on a IPv4 stack. Tomcat will run by default with IPv6, so in order to specify IPv4 instead, add the following line to the setenv.sh file:

Be sure not to run programs on your system that try to bind to the same port using different versions of the IP protocol.

For Tomcat, first deploy the mmc.war file by copying it to your Tomcat /webapps directory. Tomcat, when started, deploys the Management Console application. You should see a mmc folder in the Tomcat /webapps folder after Tomcat deploys the console Web application.

Due to JMX conflicts generated by an old MBeanServer implementation, you must configure JBoss to use the Java5 MBeanServer. You do this by providing the -Djboss.platform.mbeanserver parameter in the startup command. For example:

On Windows, before startup, ensure that environment variable JAVA_OPTS contains:

Note, too, that memory-related JVM options are still mandatory. For instance:

You may also try specifying smaller memory parameters depending on your environment, such as:

To successfully deploy the console JBoss 6, you need to remove the following files from JBoss:

To specify a new folder for mmc-data, use the following parameter in the Mule startup command:

For example:

You may want to configure a different default port for agent communication, or a different server ID before running Mule.

You can change the agent configuration from that of the default URL, which is displayed when registering a new server instance. The agent configuration determines the bind port for the server instance. You may wish to change the agent URL if you want to start multiple instances of Mule ESB within the same box and connect the console to these different instances, or if you want to connect to remote server instances.

Unless a port is specified, the console will look in the 7777-7877 port range and bind the first free port by default. When you start Mule from a command line, you can change the port to which the server binds. You specify the new port as a switch or option in the command used to start Mule, as follows:

For example:

You may also specify a custom port range, as follows:

In addition, when you change the agent bind port to accommodate multiple Mule instances, you also must start Mule from the bin directory that corresponds to the particular Mule instance. For example, you might run a second instance of Mule as follows, where this second instance is installed at /opt/second_mule:

To disable the Management Console agent on Mule ESB startup, use the mule.agent.enabled property as shown below:

The agent is enabled by default.