Start and Stop On-Premises Mule Runtime Engine
Start and stop on-premises runtime to run Mule applications on a host you manage. Use these commands after you unpack the distribution and install an Enterprise license. After the runtime is running, deploy Mule application JARs. See On-Premises Mule Runtime Deployment Model and the setup path in On-Premises Runtimes Overview.
Registration with Anypoint Runtime Manager is optional. That registered model is a Hybrid Standalone Runtime.
Deployment status does not appear in the console when the runtime runs as a service or daemon. Look in $MULE_HOME/logs/mule_ee.log (Enterprise) for startup and deployment messages.
Mule runtime engine uses the Java Service Wrapper (Tanuki) to control the Java Virtual Machine (JVM) from your native OS. The wrapper provides many options and features, including the ability to run Mule as a Unix daemon or install or remove Mule as a Windows Service. The wrapper can handle system signals and start parameters, and overall provides much better interaction between the JVM and the underlying OS.
Use the Startup and Shutdown Script
The wrapper is called by a script in $MULE_HOME/bin.
The following table lists all the parameters that the script accepts:
| Parameter | Description |
|---|---|
|
Starts Mule in the terminal background. |
|
Stops Mule. Inbound endpoints process in-flight messages before Mule shuts down. However, after the timeout period, inflight messages that haven’t completed are abandoned and Mule shuts down. |
|
Restarts Mule. |
|
(Linux/Unix only.) Displays the status of the Mule server ( |
|
(Linux/Unix only.) Dumps the Mule wrapper’s core to |
|
Start Mule in the terminal foreground (console mode). Same as running |
|
Install Mule as a Windows Service or Linux/Unix Daemon. |
|
Remove Mule from your Windows Services or Linux/Unix Daemons. |
Start in the Console
Start Mule from a command line by changing the directory to where you unzipped the Mule software distribution and then changing to the bin directory. Run the following commands:
-
On Windows environments:
$ $MULE_HOME\bin\mule.bat -
On Linux/Unix environments:
$ $MULE_HOME/bin/mule
These commands run Mule in foreground mode, and the startup script displays information on the terminal’s standard output. You can’t issue further commands on the terminal as long as Mule is running.
To stop Mule, press CTRL-C in the terminal in which the script is running.
Start as a Windows Service
To run Mule as a Windows service, you need to install it first by running:
$ $MULE_HOME\bin\mule.bat installOnce installed, you can run Mule as a service:
$ $MULE_HOME\bin\mule.bat start|
When Windows restarts, the Mule service stops the same way as using the |
Add Properties to wrapper.conf After Installation
After the installation of Mule as a Windows service, you can override the properties defined in the wrapper.conf file by declaring new properties in the wrapper.additional.conf file.
The behavior changes depending on the Mule edition you are using:
-
Mule Community Edition
-
After adding a new property, reinstall or restart the Windows Service.
-
Add the property and ensure that its index is greater than the greatest index in the
wrapper-additional.conffile. Otherwise, your property can be overridden.For example, if the
wrapper-additional.confhas the property:wrapper.java.additional.n=-Dproperty=valueWhen
nis the greatest index, you should add your property in thewrapper.conffile incrementing the index:wrapper.java.additional.n+1=-DyourProperty=valueOfYourProperty
-
-
Mule Enterprise Edition
-
By default, you can add 20 extra properties after installing Mule as a Service.
-
Configure the number of extra properties you need, using the following command line argument when you install the service:
-additionalJavaProperties=numberOfExtraProperties
-
Start as a Linux or Unix Daemon
Installing the daemon does not create a systemd unit named mule.service. The mule install command registers a Java Service Wrapper (Tanuki) daemon. systemctl start mule fails because that unit does not exist. Use $MULE_HOME/bin/mule start after mule install, not systemctl mule start.
To run Mule as a Linux-Unix Daemon, you need to install it first by running:
$ $MULE_HOME/bin/mule installOnce installed, you can run Mule as a daemon:
$ $MULE_HOME/bin/mule start|
You can also start Mule without executing the installation step. This will start the Mule in the background for the current user session. |
The following example starts Mule from a Unix console:
$ $MULE_HOME/bin/mule start
MULE_HOME is set to ~/Downloads/mule-enterprise-standalone-4.3.0
MULE_BASE is set to ~/Downloads/mule-enterprise-standalone-4.3.0
Starting Mule Enterprise Edition...
Waiting for Mule Enterprise Edition.................
running: PID:87318Start from a Script
To start Mule from a script or from your IDE without using the Java Service Wrapper, you can use the org.mule.MuleServer class. This class accepts a couple of parameters.
org.mule.MuleServer -config mule-config.xml
or
org.mule.MuleServer -builder <fully qualified classname> -config appContext.xml
-
-config specifies one or more configuration files to use. If this argument is omitted, it will look for and use
mule-config.xmlif it exists. -
-builder is a fully qualified classname of the configuration builder to use. If this is not set, the default
org.mule.config.builders.AutoConfigurationBuilderis used, which will try to auto-detect configuration files based on available builders. In the most common scenario, this will resolve toorg.mule.config.spring.SpringXmlConfigurationBuilder.
The easiest way to set the classpath is to include all JARs in the ./lib/mule and ./lib/opt directories of the distribution. You can look at the dependency report for the server and each of the modules to see exactly which JARs are required for a particular module.
Deploy Applications
-
Start Mule.
-
After Mule starts, you can deploy your Mule applications by moving your packaged JAR files to the
appsdirectory in$MULE_HOME.
Stop On-Premises Mule Runtime Engine
Run the stop command to stop Mule.
The following example stops Mule from a Unix console:
$ $MULE_HOME/bin/mule stop
MULE_HOME is set to /Applications/mule-enterprise-standalone-4.3.0
MULE_BASE is set to /Applications/mule-enterprise-standalone-4.3.0
Stopping Mule Enterprise Edition...
Stopped Mule Enterprise Edition.Remove the Service or Daemon
Run the remove command to remove the service or daemon from your system.
The following example removes the Mule daemon from a Unix console:
$ $MULE_HOME/bin/mule remove
MULE_HOME is set to /Applications/mule-enterprise-standalone-4.3.0
MULE_BASE is set to /Applications/mule-enterprise-standalone-4.3.0
Detected Mac OSX:
Mule Enterprise Edition is not running.
Removing Mule Enterprise Edition daemon...Enable Anypoint Monitoring
Optionally, you can install Anypoint Monitoring for cloud-managed supported versions of on-premises runtimes so you can monitor applications running on that server.
Find Runtime Logs
When you start on-premises Mule runtime engine in the console, startup and DEPLOYED messages print to standard output. When you start it as a Windows service or Linux daemon, those messages do not go to the terminal.
Look in $MULE_HOME/logs/mule_ee.log (Enterprise Edition) for startup, deployment, and application logs. The mule dump script parameter writes wrapper diagnostics to $MULE_HOME/log/mule_ee.log.
If the log file is missing, the process user cannot write to $MULE_HOME/logs. Confirm that user owns $MULE_HOME and that you started the instance whose MULE_HOME you are inspecting.
Troubleshoot Common Error Messages
Timed out waiting for signal from JVM
The Java Service Wrapper (Tanuki) did not receive a ready signal from the JVM before wrapper.startup.timeout. See Download, Install, and Upgrade On-Premises Mule Runtime Engine for wrapper.conf timeouts.