Installing the Management Console
This document describes where to download the required files and how to install or deploy these files for different application servers. Please contact the MuleSoft Support Team with any questions about downloading and deploying Mule Management Console.
- Installation and Deployment Checklist
- Deployment Instructions for Specific Web Application Servers/Containers
- Starting the Management Console
- Additional Configuration
- Configuring the Management Console to Use an External Database
- Configuring a Custom Folder for mmc-data
- Customizing the Agent Configuration
- Go Further
|Trial Version vs Production Version|
Please note that if you have downloaded MuleSoft's bundled runtime download – ESB with Mule Management Console (MMC) – it is appropriate for use only as an evaluation tool and is not considered production-ready.
(For instructions on running Mule for the first time, see Downloading and Launching Mule ESB.)
To use Mule Management Console for stress testing or in a production environment, download the necessary files from MuleSoft's customer portal and deploy the console application on an application server, such as Tomcat.
This document assumes that you have Mule Enterprise 3.4.x already installed. Download it from the customer portal if you need to upgrade to this version. If you are using Mule Enterprise 3.3.x, please switch to the 3.3.x version of this documentation.
This document also assumes that you have a Web application server such as Tcat, Tomcat, or JBoss installed. Please refer to the Hardware and Software Requirements for the latest information about hardware requirements and supported application servers, Java Runtime Environments, and browsers.
Installation and Deployment Checklist
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
mmc.war.Why?The name of the WAR file will vary 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 will change accordingly. For example, if your war file is named
mmc-foobar.war, you would need to use
If your Mule instance is packaged as a Web app, click below for special instructions. Otherwise, skip this step.Special instructions for Embedded Mode
Special Instructions for Embedded Mode
You can also deploy the Management Console agent in a Mule ESB instance packaged as a Web app.
Note that when embedded, Mule does not support the Mule Deployment Model or High Availability. Furthermore, because the application server needs control of Mule, the Mule Management Console's capabilities are reduced; specifically, you cannot restart the server via the Mule Management Console.
You must ensure that the classpath 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
You can obtain the .jar files from the customer portal.A specific listener should be added to the file
web.xml, as follows:
... you need to remove it. Otherwise the same Mule app would start twice.
- Deploy your
mmc.warfile to your application server or other container. See specific instructions for each supported container in the following section.
- Optionally, perform additional configuration to use an external database, change the default folder for mmc.data, or configure a different default port and server ID.
Deployment Instructions for Specific Web Application Servers/Containers
Since the procedure for deploying Web apps varies by container, you should refer to your container's documentation for complete information on deploying Web apps.
Deploying the Management Console .war in Tcat/Tomcat
You can deploy the management console and your Mule applications inside Tcat/Tomcat without any modifications, other than specifying JVM parameters.
See Tcat Server Documentation for instructions on how to deploy Web applications inside of Tcat.
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:
- 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 will run by default with IPv6, so in order to specify IPv4 instead, add the following line to the
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.
Deploying the Management Console .war in JBoss
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 the environment variable JAVA_OPTS contains the following:
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 to JBoss 6, you need to remove the following files from JBoss:
<your_profile>is your server profile.
Starting the Management Console
To run the Management Console, make sure your container is running and the management console Web app has been deployed correctly. Then enter
http://localhost:8080/mmc in your browser. (Note that if you are using the trial version, the default port is 8585 instead of 8080.) If you see the login screen (see below), you installed correctly and are now running the console.
If another app is using port 8080, you can change the port in your container's configuration (such as the
/conf/server.xml file under your Tomcat home directory). If you want to run the management console remotely from another computer, enter the correct name (or IP address) of the host computer instead of localhost.
When you start the management console for the first time, you can log in with the username
admin and the password
Configuring the Management Console to Use an External Database
By default, the Management Console uses its own internal database; however, you can configure it to use an external database, which can be useful for disaster recovery.
See Persisting Environment Data for instructions on how to set up the Management Console to use an external database for storing environment information, such as users, groups, applications, etc.
See Persisting Transaction Data for instructions on how to set up the Management Console to use an external database for storing transaction data (Business Events).
Configuring a Custom Folder for mmc-data
To specify a new folder for
mmc-data, use the following parameter in the Mule startup command:
Customizing the Agent Configuration
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 to 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:
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
- Read the Quick Start Guide to Mule ESB Server and the Management Console
- Find out how to accomplish Common Tasks with the management console