Installing the Production Version of MMC
The Mule Management Console is a Web app designed to run in an application server, such as Apache Tomcat, and usually packaged in a .war file.
This document describes where to download the required files and how to install or deploy these files for different application servers. You can contact the MuleSoft Support team with any questions about downloading and deploying Mule Management Console.
|Trial Version vs Production Version|
Please note that if you have downloaded MuleSoft’s bundled runtime download – Mule with Mule Management Console (MMC) – it is appropriate for use only as an evaluation tool and is not considered production-ready. For installation instructions for the trial version, see Installing the Trial Version of MMC.
This document assumes that you are have the current version of Mule Enterprise already installed. Download it from the customer portal if you need to upgrade to this version. If you are using an older version of Mule Enterprise, you can switch to an older version of this documentation.
This document assumes that your enterprise license is current. See Installing an Enterprise License for information on obtaining and installing an enterprise license.
This document also assumes that you have a Web application server such as Tomcat or JBoss installed. Refer to the Hardware and Software Requirements for the latest information about hardware requirements and supported application servers, Java Runtime Environments, and browsers.
To install the management console:
Download the Mule Management Console application (.war file) from the MuleSoft customer portal. (Note that the management console agent, formerly a separate download and installation, is now embedded in the Mule Enterprise distribution.)
Rename your .war file to
The name of the WAR file varies depending on the version that you download, following the format
<console_name>-<version>.war. Once you have downloaded this file from the customer portal, change the name to
mmc.war.All instructions below assume that your WAR file has been renamed mmc.war. If your file is named differently, note that the URL that you use to access the console changes accordingly. For example, if your war file is named
mmc-foobar.war, you would need to use
http://localhost:8080:mmc-foobarto access the console.
If your Mule instance is packaged as a Web app (not recommended), contact support for special instructions.
Adjust the configuration on your web application server so that it gives precedence to MMC’s classloader, instead of your Web application server’s own native classloader.
mmc.warfile to your application server. See specific instructions for each supported app server in the following section.
|Since the procedure for deploying varies by app server, you should also refer to your app server’s documentation for complete information on deploying web apps.|
You can deploy the management console and your Mule applications inside Tomcat without any modifications, other than specifying JVM parameters.
Alter your JVM parameters in Tomcat as follows.
Create a file named
Copy the following string into the file:
setenv JAVA_OPTS=-Xmx1024m -XX:MaxPermSize=512m
Save the file.
Create a file named
Copy the following lines into the file:
1 2 #!/bin/sh JAVA_OPTS="-Xmx1024m -XX:MaxPermSize=512m"
Save the file.
Make it executable, for example with the command
chmod u+x setenv.sh.
We recommend running on an IP v4 stack. Tomcat runs by default with IPv6, so in order to specify IPv4 instead, modify the
JAVA_OPTS in the
$TOMCAT_HOME/bin/setenv.sh file, as shown below.
1 2 #!/bin/sh JAVA_OPTS="-Xmx1024m -XX:MaxPermSize=512m -Djava.net.preferIPv4Stack=true"
The line above adds the
-Djava.net.preferIPVv4Stack=true option to
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. After Tomcat deploys the console Web application, you should see a directory called
mmc inside Tomcat’s
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:
./run.sh -c all -Djboss.platform.mbeanserver
On Windows, before startup, ensure that the environment variable JAVA_OPTS contains the following:
Note, too, that memory-related JVM options are still mandatory. For instance:
export JAVA_OPTS="-XX:MaxPermSize=512m -Xmx1G"
You may also try specifying smaller memory parameters depending on your environment, such as:
export JAVA_OPTS="-XX:MaxPermSize=300m -Xmx256m"
To successfully deploy the console to JBoss 6, you need to remove the following files from JBoss:
<your_profile>is your server profile.
The detailed, step-by-step instructions for installing and deploying MMC to WebSphere are provided on Installing and Deploying MMC to WebSphere.
Note that if you want to configure MMC to persist data on external databases, you should follow the instructions for the specific database, as described here:
MMC version 3.4.X prior to 3.4.2: Persisting MMC Data On External Databases
MMC version 3.4.2 and above: Persisting MMC Data On External Databases in MMC 3.4.2
But the locations of the files to modify differs from those instructions (which are based on an example Tomcat installation.)
For an example, see Installing and Deploying MMC to WebSphere.
To run the Management Console, make sure your application server is running and the Management Console Web app has been deployed correctly. Then, navigate to the URL where the Management Console Web application is hosted, for example
http://localhost:8080/mmc. If you see the login screen (see below), you have installed everything correctly and are now running the console.
Log in with the username
admin and the password