Chapter 2. Installation

2.1. Prerequisites

AMQ Broker requires the following components.

  • JRE 8 (for running AMQ Broker)
  • JDK 8 (for running the examples)
  • Maven 3.2 (for running the examples)

Note that the broker runtime requires only a JRE. However, running the included examples requires a full JDK as well as Maven.

If you are installing AMQ Broker on a supported version of Red Hat Enterprise Linux, you can use the yum command to install any needed pre-requisites. For example, the command below installs OpenJDK 8 and Maven.

$ sudo yum install java-1.8.0-openjdk maven

You can also download supported versions of a JDK and Maven from their respective websites, OpenJDK and Apache Maven for example. Consult Supported Configurations to ensure you are using a supported version of Java.

2.2. Downloading an AMQ Broker Archive

A platform-independent, archived distribution of AMQ Broker is available for download from the Red Hat Customer Portal. See Using Your Subscription for more information on how to access the customer portal using your Red Hat subscription. You can download a copy of the distribution by following the steps below.


Red Hat also releases archives to the customer portal that are not part of the planned release cycle. These releases address security issues or provide other fixes and enhancements and are not displayed under the default list on the Software Downloads page. Instead, they are displayed when you click the page’s Security Advisory and Patches tabs.


  1. Open a browser and log in to the Red Hat Customer Portal at
  2. Click Downloads.
  3. Find Red Hat JBoss AMQ in the Product Downloads list.
  4. Select Download Latest Broker from the drop-down list located on the same row to go to the Software Downloads page for AMQ Broker.
  5. From the Software Downloads page, select the correct AMQ Broker version from the Version drop-down menu.
  6. Click the Download link for AMQ Broker.

2.3. Installing on Linux


You must first download the installation archive from the Red Hat Customer Portal.


  1. Create a new user named amq-broker and provide it a password.

    sudo useradd amq-broker
    sudo passwd amq-broker
  2. Create the directory /opt/redhat/amq-broker and make the new amq-broker user and group the owners of it.

    sudo mkdir /opt/redhat
    sudo mkdir /opt/redhat/amq-broker
    sudo chown -R amq-broker:amq-broker /opt/redhat/amq-broker
  3. Change the owner of the archive to the new user.

    sudo chown amq-broker:amq-broker
  4. Move the installation archive to the directory you just created.

    sudo mv /opt/redhat/amq-broker
  5. As the new user amq-broker, extract the contents with a single unzip command.

    su - amq-broker
    cd /opt/redhat/amq-broker

A directory named something similar to AMQ7-7.0-redhat-1 will be created. In the documentation this location is referred to as INSTALL_DIR.

2.4. Installing on Windows


You must first download the zip version of the archive from the Red Hat Customer Portal.


  1. Use Windows Explorer to create the directory folder \redhat\amq-broker on the desired letter drive, C: for example.
  2. Use Windows Explorer to move the installation archive to the new directory and extract it.
  3. Extract the file contents into a directory by right-clicking on the zip file and choosing Extract All.

A directory named something similar to AMQ7-x.x-redhat-1 will be created. In the documentation this location is referred to as INSTALL_DIR.

2.5. Archive Contents

The directory created by extracting the archive is the top-level directory for the AMQ Broker installation. This directory is referred to as INSTALL_DIR and includes a number of important directories noted in the table below.

Table 2.1. Contents of INSTALL_DIR

If you want to find…​Look here…​

API documentation


Binaries and scripts needed to run AMQ Broker


Configuration files


JMS and Java EE examples


Jars and libraries needed to run AMQ Broker


XML Schemas used to validate AMQ Broker configuration files


Web context loaded when AMQ Broker runs.