Introduction
This document describes how to install and configure ActiveMQ 3.x for both Unix and Windows' platforms.
Document Organization
The Getting Started Guide for ActiveMQ 3.x document contains the following sections:
Pre-Installation Requirements
Hardware:
- 33 MB of free disk space for the ActiveMQ 3.x binary distribution.
- 18 MB of free disk space for the ActiveMQ 3.x source or developer's distributions.
Operating Systems:
- Windows: Windows XP SP2, Windows 2000.
- Unix: Ubuntu Linux, Powerdog Linux, MacOS, AIX, HP-UX, Solaris, or any Unix platform that supports Java.
Environment:
- Java Developer Kit (JDK) 1.4.x or greater for deployment and 1.5.x (Java 5) for compiling/building.
- The JAVA_HOME environment variable must be set to the directory where the JDK is installed, e.g., c:\Program Files\jsdk.1.4.2-09.
- Maven 1.0.2 or greater (required when installing source or developer's releases).
- JARs that will be used must be added to the classpath.
Installation Procedure for Windows
This section of the Getting Started Guide explains how to install binary and source distributions of ActiveMQ on a Windows system.
Windows Binary Installation
This procedure explains how to download and install the binary distribution on a Windows system.
- From a browser, navigate to www.ActiveMQ.org.
- Click the Download link in the navigation pane (the left pane).
- Click the ActiveMQ 3.x Release link under the "Latest Releases" section. This brings up a new page.
- Under the Download Here section, select the desired distribution (you may have to scroll down to see the "Download Here" section).
For a binary distribution, the filename will be similar to: activemq-x.x.x.zip. - Extract the files from the ZIP file into a directory of your choice.
- Proceed to the Starting ActiveMQ section of this document.
- Following start-up, go to the Testing the Installation section of this document.
Windows Source Installation
This procedure explains how to download and install the source distribution on a Windows system.
NOTE: ActiveMQ can be run on a Java 1.4.x system, however, Java 1.5 is required to compile/build ActiveMQ.
- From a browser, navigate to www.ActiveMQ.org.
- Click the Download link in the navigation pane (the left pane).
- Click the ActiveMQ 3.x Release link under the "Latest Releases" section. This brings up another page.
- Under the Download Here section, select the desired distribution (if necessary, scroll down to see the "Download Here" section).
For a source distribution, the filename will be similar to: activemq-x.x-src.zip. - Extract ActiveMQ from the ZIP file into a directory of your choice.
- Build ActiveMQ using Maven 1.0.2 or greater and Java 1.5.
- If you prefer to use an IDE, then you can auto-generate the IDE's project file using maven plugins:
Feel free to use any other applicable IDE. Please refer to the plugin reference for more details.
- Start ActiveMQ from the target directory, for example:
NOTE: Working directories get created relative to the current directory. To create the working directories in the proper place, ActiveMQ must be launched from its home/installation directory.
- Proceed to the Testing the Installation section.
NOTE: Working directories get created relative to the current directory. To create the working directories in the proper place, ActiveMQ must be launched from its home/installation directory.
 | Warning
If you are building ActiveMQ 3.x under Windows using Cygwin there is a path name length limitation. If the path name length is exceeded, you may see build errors. To correct this, move the ActiveMQ source directory higher in the file system tree, e.g., /cygdrive/c/d/sm. |
Windows Developer's Release
This procedure explains how to download and install the latest developer's snapshot.
NOTE: ActiveMQ can be run on a Java 1.4.x system, however, Java 1.5 is required to compile/build ActiveMQ.
- From a browser, navigate to www.ActiveMQ.org.
- Click the Download link in the navigation pane (the left pane).
- Click the Current development SNAPSHOT release link.
- Select the version of ActiveMQ to download (if necessary, scroll down to see the ActiveMQ snapshots).
- Extract the files from the ZIP file into a directory of your choice.
- If a binary snapshot was downloaded, proceed to the Starting ActiveMQ section of this document.
If a source snapshot was downloaded, perform step 6 and step 7 of the Windows Source Installation procedure. - Following start-up, proceed to the Testing the Installation section.
Installation Procedure for Unix
Unix Binary Installation
This procedure explains how to download and install the binary distribution on a Unix system.
- Download the activemq gzip file to the Unix machine, using either a browser or a tool, i.e., wget, scp, ftp, etc.
- Extract the files from the gzip file into a directory of your choice. For example:
- If the ActiveMQ start-up script is not executable, change its permisssions. The ActiveMQ script is located in the bin directory. For example:
- Proceed to the Starting ActiveMQ section of this document.
- Following start-up, go to the Testing the Installation section.
Unix Source Installation
This procedure explains how to download and install the source distribution on a Unix system. This procedure assumes the Unix machine has a browser. Please see the previous Unix Binary Installation section for details on how to install ActiveMQ without a browser.
NOTE: ActiveMQ can be run on a Java 1.4.x system, however, Java 1.5 is required to compile/build ActiveMQ.
- From a browser, navigate to www.ActiveMQ.org.
- Click the Download link in the navigation pane (the left pane).
- Click the ActiveMQ 3.x Release link under the "Latest Releases" section. This brings up a new page.
- Under the Download Here section, select the desired distribution (if necessary, scroll down to see the "Download Here" section).
For a source distribution, the filename will be similar to: activemq-x.x-src.tar.gz. - Extract the files from the ZIP file into a directory of your choice. For example:
- Build ActiveMQ using Maven 1.0.2 or greater and Java 5:
- If you prefer to use an IDE then you can auto-generate the IDE's project file using maven plugins:
Feel free to use any other applicable IDE. Please refer to the plugin reference for more details.
NOTE: Working directories get created relative to the current directory. To create working directories in the proper place, ActiveMQ must be launched from its home/installation directory.
- Proceed to the Starting ActiveMQ section of this document.
- Proceed to Testing the Installation section.
Unix Developer's Release
This procedure explains how to download and install the latest developer's snapshot.
NOTE: ActiveMQ can be run on a Java 1.4.x system, however, Java 5 is required to compile/build ActiveMQ.
- From a browser, navigate to www.ActiveMQ.org.
- Click the Download link in the navigation pane (the left pane).
- Click the Current development SNAPSHOT release link.
- Select the version of ActiveMQ to download (you may have to scroll down to see the ActiveMQ snapshots). The filename will be similar to: activemq-x.x.x-tar.gz or activemq-x.x.x-src.tar.gz.
- Extract the files from the gzip file into a directory of your choice. For example:
- If a binary snapshot was downloaded, to make it executable, the ActiveMQ script may need its permissions changed:
#For a binary snapshot, proceed to the Starting ActiveMQ section of this document.
#If a source snapshot was downloaded perform steps 6 - 8 of the Unix Source Installation procedure.
- Proceed to the Testing the Installation section.
Starting ActiveMQ
On Windows:
From a console window, change to the installation directory and run ActiveMQ:
where activemq_install_dir is the directory in which ActiveMQ was installed, e.g., c:\Program Files\ActiveMQ-3.x.
Then type:
NOTE: Working directories get created relative to the current directory. To create working directories in the proper place, ActiveMQ must be launched from its home/installation directory.
On Unix:
From a command shell, change to the installation directory and run ActiveMQ:
where activemq_install_dir is the directory in which ActiveMQ was installed, e.g., /usr/local/activemq-3.x.
Then type:
NOTE: Working directories get created relative to the current directory. To create working directories in the proper place, ActiveMQ must be launched from its home/installation directory.
| Warning
Do NOT close the console or shell in which ActiveMQ was started, as that will terminate ActiveMQ (unless ActiveMQ was started with nohup).
|
Testing the Installation
If ActiveMQ is up and running without problems, the Window's console window or the Unix command shell will display information similar to the following log line:
ActiveMQ's default port is 61616. From another window run netstat and search for port 61616.
From a Windows console, type:
OR
From a Unix command shell, type:
Stopping ActiveMQ
For both Windows and Unix installations, terminate ActiveMQ by typing "CTRL-C" in the console or command shell in which it is running.
If ActiveMQ was started in the background on Unix, the process can be killed, with the following:
Configuring ActiveMQ
The ActiveMQ broker should now run. You can configure the broker by specifying an Xml Configuration file as a parameter to the activemq command.
See the Initial Configuration for details of which jars you need to add to your classpath to start using ActiveMQ in your Java code
If you want to use JNDI to connect to your JMS provider then please view the JNDI Support. If you are a Spring user you should read about Spring Support
After the installation, ActiveMQ is running with a basic configuration. For details on configuring options, please see refer to the Configuration section.
Additional Resources
If you are new to using ActiveMQ, running the Examples is a good next step to learn more about ActiveMQ.