This page last changed on Jul 28, 2006 by aperepel.

Introduction

The following sections will walk you through the installation process for the full binary and source distribution of Mule.

Quick Links

Prerequisites

Operating Systems
Mule will run any platform that supports java, these include -

  • Windows XP SP2 and Windows 2000.
  • Linux, Solaris, AIX and HP-UX.
  • Mac OSX

Environment

  • Java Developer Kit (JDK) 1.4.x or greater for deployment and JDK 1.5.x for building Mule from source. Download.
  • The JAVA_HOME environment variable must be set to the directory where the JDK is installed, e.g. c:\java\j2sdk1.4.2_08.
  • You PATH environment variable should also contain the path to the JDK bin directory, e.g. ;c:\java\j2sdk1.4.2_08\bin.
  • Maven 1.0.2 (required for building from source and running some examples). Download.
  • A compression tool such as WinZip (Windows) or GZip (Linux/Unix) for uncompressing the Mule distribution.
  • For Linux/Unix users working from the shell, you'll need a download tool such as wget or ftp.

Disk Space

Installing on Windows

Windows Binary Installation

  1. Download the Mule binary distribution here.
  2. The latest distribution is at the top of the page. Click on the .zip link, to download the Windows distribution.
  3. Once the distribution is downloaded, extract the files from the zip file into a directory of your choice, e.g. c:\java.
  4. For a description of the Mule installation directories go to Distribution Layout.
  5. See Testing the Installation for details on how to make sure the installation was successful.

Installing the Developer Release on Windows

This procedure explains how to download and install the latest developers' snapshot. The process is very similar for installing the regular distribution; the only difference being that a snapshot release does not contain any documentation.

  1. Download the Mule binary distribution here.
  2. Scroll to the Developer Release section of this page.
  3. There may be more than one developer release i.e. 1.x-SNAPSHOT and 2.x-SNAPSHOT.
  4. Click on the .zip link next to the desired developer release, to download the Windows distribution.
  5. We recommend that you delete any previous versions of the developer build installed on your machine. This can be done by deleting the directory that contains the release.
  6. Once the distribution is downloaded, extract the files from the zip file into a directory of your choice, e.g. c:\java.
  7. For a description of the Mule installation directories go to Distribution Layout.
  8. See Testing the Installation for details on how to make sure the installation was successful.

Installing on Linux/Unix

Linux/Unix Binary Installation

The following steps take you through installing Mule on Linux/Unix environments. Be sure to download the distributions with filenames ending with tar.gz as these wil have all file permissions correctly set up.

Using a Browser

  1. Download the Mule binary distribution here.
  2. The latest distribution is at the top of the page. Click on the .tar.gz link, to download the Windows distribution.
  3. Once the distribution is downloaded, extract the files from the zip file into a directory of your choice, e.g. /usr/local.
  4. Extract the distribution using the tar command. For example, if you downloaded Mule 1.2 distribution -
    tar -xvzf mule-1.3.tar.gz
    
  5. See Testing the Installation for details on how to make sure the installation was successful.
  6. For a description of the Mule installation directories go to Distribution Layout.

Using the Shell

If you do not have a browser or are installing Mule on a remote machine without X-Windows follow these steps.

  1. You'll need to know the version of Mule you want to download. If you ae unsure, you need to go to a machine with a browser and check the download page at http://muleumo.org/Download.
  2. The file URL will be in the form of -
    http://dist.codehaus.org/mule/distributions/mule-x.x-dist.tar.gz
    

    where x.x will be replaced with the SNAPSHOT version you wish to download.

  3. In your shell change the directory to where you want to install Mule, e.g. /usr/local.
  4. Download the distribution using you download tool. For example to download the Mule 1.2 distribution using wget -
    wget http://dist.codehaus.org/mule/distributions/mule-1.2-dist.tar.gz
    
  1. Extract the distribution using the tar command -
    tar -xvzf mule-1.2-dist.tar.gz
    
  2. See Testing the Installation for details on how to make sure the installation was successful.
  3. For a description of the Mule installation directories go to Distribution Layout.

Installing the Developer Release on Linux/Unix

This procedure explains how to download and install the latest developers' snapshot. The process is very similar for installing the regular distribution; the only difference being that a snapshot release does not contain any documentation.

Be sure to download the distributions with filenames ending with tar.gz as these wil have all file permissions correctly set up.

Using a Browser

  1. Download the Mule binary distribution here.
  2. Scroll to the Developer Release section of this page.
  3. There may be more than one developer release i.e. 1.x-SNAPSHOT and 2.x-SNAPSHOT.
  4. Click on the .tar.gz link next to the desired developer release, to download the distribution.
  5. We recommend that you delete any have a previous versions of the developer build installed on your machine. This can be done by deleting the directory that contains the release.
  6. Once the distribution is downloaded, open a shell and extract the distribution into a directory of your choice, e.g. /usr/local using the tar command. For example, if you downloaded Mule 2.0-SNAPSHOT distribution -
    tar -xvzf mule-2.0-SNAPSHOT.tar.gz
    
  7. See Testing the Installation for details on how to make sure the installation was successful.
  8. For a description of the Mule installation directories go to Distribution Layout.

Using the Shell

If you do not have a browser or are installing Mule on a remote machine without X-Windows follow these steps.

  1. You'll need to know the version of Mule Developer you want to download. If you ae unsure, you need to go to a machine with a browser and check the download page at http://muleumo.org/Download. Most of the time you'll want the default 'SNAPHOT' version unless you are working with a new major release e.g. '2.0-SNAPSHOT'.
  2. The file URL will be in the form of -
    http://dist.codehaus.org/mule/nightly/mule-x.x-dist.tar.gz
    

    where x.x will be replaced with the SNAPSHOT version you wish to download.

  3. In your shell change the directory to where you want to install Mule, e.g. /usr/local.
  4. Download the Mule distribution using you download tool. For example to download the default snapshot using wget -
    wget http://dist.codehaus.org/mule/nightly/mule-SNAPSHOT-dist.tar.gz
    
  1. Extract the distribution using the tar command. For example -
    tar -xvzf mule-SNAPSHOT-dist.tar.gz
    
  2. See Testing the Intallation for details on how to make sure the installation was successful.
  3. For a description of the Mule installation directories go to Distribution Layout.

Source Installation

There is a snapshot of the Mule source code included in the distribution. However, it is provided only for reference purposes and does not contain necessary build files to build it, but is useful for attaching to the Mule jar in your IDE.

If you want to work with the Mule source code directly you should read Working with the build (Maven 2.x) which explains how to checkout Mule source from Subversion and run the Mule build.

Testing the Installation

The best way to test the installation is to run an example. We suggest you run the echo example. Details on how to do this can be found here.

When you ran the example there should have been a start up message displayed in your console/Unix shell. It will display something similar to the following if Mule is up and running without any problems:

**********************************************************************
* Mule - Universal Message Objects version 1.2-SNAPSHOT              *
* SymphonySoft Limited                                               *
* For help or more information go to http://www.muleumo.org          *
*                                                                    *
* Server started: Mon Oct 3 14:16:00 CET 2005                        *
* JDK: 1.5.0_03 (mixed mode)                                         *
* OS: Windows XP (5.1, x86)                                          *
*                                                                    *
* Agents Running:                                                    *
*   Mule Admin: accepting connections on tcp://localhost:60504       *
**********************************************************************


Mule's AdminAgent default port is 60504. From another window run netstat and search for port 60504.

From a Windows console, type:

netstat -an|find "60504"

OR

From a Unix command shell, type:

netstat -an|grep 60504

Stopping Mule

For both Windows and Unix installations, terminate Mule by typing "CTRL-C" in the command shell or console in which it is running.

If Mule was started in the background on Unix, the process can be killed, for example:

ps -ef|grep mule
kill PID

Where "PID" is the process id of the Mule process.

Backgrounding a Linux\Unix process

If you run Mule from a shell you should run it as a background process if you want it to continue running after you close the shell. To do this you can use nohup i.e.

nohup mule -config mule-config.xml

or by backgrounding the process using disown

mule -config mule-config.xml

jobs
(will display a list of current jobs you are running)

disown %(job number)

Additional Resources

Before using Mule you should take a few minutes to get an understanding of what Mule is and how it works. We recommend the Getting Started Guide guide and once you have installed the distribution try running the Examples, this is a really easy way to get something up and running in Mule and they are fully documented. We suggest you start with the Echo Example and work you way down the list. Also, you can inspect and manage a running Mule instance using JMX Management, where you can stop and start component and view message processing statistics.

Distribution Layout

Any distribution downloaded from Mule 1.1 onwards will have the following structure-

  • ./mule-1.2
    • ./bin - Contains shell and batch scripts for running Mule
    • ./docs - API documentation for Mule and its sub-projects (not included in the Developer releases)
    • ./lib - Jars needed by the Mule distribution
    • ./lib/opt - Optional jars required by certain Mule transports and components
    • ./lib/patch - Used to include jars and resources at the beginning of the classpath. This directory is empty.
    • ./lib/licenses - License information about all the jars shipped with Mule.
    • ./samples - Sample applications, scripts and source code
    • ./src - The source code for Mule and its sub-projects.
    • ./tools - Tools for working with Mule applications
    • ./LICENSE.txt - License agreement for Mule.
    • ./README.txt - Information about the distribution and getting started
Document generated by Confluence on Oct 03, 2006 09:23