Using ActiveMQ 5 > Version 5 Getting Started
This document describes how to install and configure ActiveMQ for both Unix and Windows' platforms.
Hardware:
Operating Systems:
Environment:
c:\Program Files\jdk.1.7.0_xx_xx.This section of the Getting Started Guide explains how to install binary and source distributions of ActiveMQ on a Windows system.
This procedure explains how to download and install the binary distribution on a Windows system.
activemq-x.x.x.zip.This procedure explains how to download and install the source distribution on a Windows system.
NOTE: ActiveMQ requires Java 7 to run and to build
activemq-x.x-src.zip.The recommended method of building ActiveMQ is the following:
cd [activemq_install_dir] mvn clean install
where [activemq_install_dir] is the directory in which ActiveMQ was installed.
If the above build fails on some tests, type the following:
cd [activemq_install_dir] mvn clean install -Dmaven.test.skip=true
If you prefer to use an IDE, then you can auto-generate the IDE's project file using maven plugins:
mvn eclipse:eclipse
or
mvn idea:idea
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:
cd [activemq_install_dir]\assembly\target unzip activemq-x.x-SNAPSHOT.zip cd activemq-x.x-SNAPSHOT bin\activemq
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.
Warning
If you are building ActiveMQ 5.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.
This procedure explains how to download and install the latest developer's snapshot.
NOTE: ActiveMQ requires Java 7 to run and to build
This procedure explains how to download and install the binary distribution on a Unix system.
NOTE: There are several alternative ways to perform this type of installation.
\> wget http://activemq.apache.org/path/tofile/apache-activemq-5.8-tar.gz
\> tar zxvf activemq-x.x.x.tar.gz
ActiveMQ start-up script is not executable, change its permissions. The ActiveMQ script is located in the bin directory. For example:\> cd [activemq_install_dir]/bin \> chmod 755 activemq
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 requires Java 7 to run and to build
From a browser, navigate to activemq.apache.org/.
Click the Download link in the navigation pane (the left pane).
Click the Maven ActiveMQ SNAPSHOT link.
Select the version of ActiveMQ to download
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:
tar zxvf activemq.x.x-src.tar.gz
Build ActiveMQ using Maven 3.0 or greater and Java 7:
The preferred method of building ActiveMQ is the following:
cd [activemq_install_dir] mvn clean install
If Maven crashes with a java.lang.OutOfMemoryError, you you need to do this first (assuming a Bourne-like shell):
export MAVEN_OPTS=-Xmx1024M
If the above build fails on some tests, do the following:
cd [activemq_install_dir] mvn clean install -Dmaven.test.skip=true
If you prefer to use an IDE then you can auto-generate the IDE's project file using maven plugins:
mvn eclipse:eclipse
or
mvn idea:idea
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.
This procedure explains how to download and install the latest developer's snapshot.
NOTE: ActiveMQ requires Java 7 to run and to build
tar zxvf activemq-x.x.x.tar.gzFor a source developer's snapshot:
tar zxvf activemq-x.x.x-src.tar.gz
ActiveMQ script may need its permissions changed:cd [activemq_install_dir]/bin chmod 755 activemq
There now follows instructions on how to run the ActiveMQ Message Broker.
See also Starting ActiveMQ with a different configuration file
From a console window, change to the installation directory and run ActiveMQ:
cd [activemq_install_dir]
where activemq_install_dir is the directory in which ActiveMQ was installed, e.g., c:\Program Files\ActiveMQ-5.x.
Then type (depending on ActiveMQ version):
ActiveMQ 5.10 onwards
bin\activemq start
`ActiveMQ 5.9 or older**
bin\activemq
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.
From a command shell, change to the installation directory and run ActiveMQ:
cd [activemq_install_dir]
where activemq_install_dir is the directory in which ActiveMQ was installed, e.g., /usr/local/activemq-5.x.
Then type:
bin/activemq start
OR
bin/activemq start > /tmp/smlog 2>&1 &; Note: /tmp/smlog may be changed to another file name.
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).
nohup bin/activemq > /tmp/smlog 2>&1 &
For other ways of running the broker see Here. For example you can run an embedded broker inside your JMS Connection to avoid starting a separate process.
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:
INFO ActiveMQ JMS Message Broker (ID:apple-s-Computer.local-51222-1140729837569-0:0) has started
ActiveMQ's default port is 61616. From another window run netstat and search for port 61616.
From a Windows console, type:
netstat -an|find "61616"
OR
From a Unix command shell, type:
netstat -an|grep 61616
You can monitor ActiveMQ using the Web Console by pointing your browser at
From ActiveMQ 5.8 onwards the web apps is secured out of the box.
The default username and password is admin/admin. You can configure this in the conf/jetty-real.properties file.
Or you can use the JMX support to view the running state of ActiveMQ.
For more information see the file docs/WebConsole-README.txt in the distribution.
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:
cd [activemq_install_dir]
where activemq_install_dir is the directory in which ActiveMQ was installed, e.g., /usr/local/activemq-5.x.
Then type:
bin/activemq stop
Or you can do the following:
ps -ef|grep activemq kill [PID]
where [PID] is the process id of the ActiveMQ process.
By default ActiveMQ uses the conf/activemq.xml as the main configuration file when starting. If you want to use a different configuration file you can specify this as a parameter.
For example to use conf/activemq-demo.xml which includes the web demos, you do as follows:
bin/activemq console xbean:conf/activemq-demo.xml
To start Active in console mode and load the conf/activemq-demo.xml file. Yes you need the xbean: as prefix.
And to launch as a background process you can do:
bin/activemq start xbean:conf/activemq-demo.xml
For example to use examples/conf/activemq-demo.xml which includes the web demos, you do as follows:
bin/activemq console xbean:examples/conf/activemq-demo.xml
To start Active in console mode and load the examples/conf/activemq-demo.xml file. Yes you need the xbean: as prefix.
And to launch as a background process you can do:
bin/activemq start xbean:examples/conf/activemq-demo.xml
The ActiveMQ broker should now run. You can configure the broker by specifying an Xml Configuration file as a parameter to the activemq command. An alternative is to use the Broker Configuration URI to configure things on the command line in a concise format (though the configuration options are not as extensive as if you use Java or XML code). You can also
Also see Configuring Transports to see how you can configure the various connection, transport and broker options using the connection URL in the ActiveMQConnectionFactory.
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.
If you are new to using ActiveMQ, running the Web Samples or the Examples is a good next step to learn more about ActiveMQ.