This document describes how to install the Apache Qpid Broker for Java on both Windows and UNIX platforms.

The Apache Qpid Broker for Java is an 100% Java implementation and as such it can be used on any operating system supporting Java 1.8 or higherJava Cryptography Extension (JCE) Unlimited Strength policy file are required for some features. This includes Linux, Solaris, Mac OS X, and Windows Vista/7/8/10. The broker has been tested with Java implementations from both Oracle and IBM. Whatever platform you chose, it is recommended that you ensure it is patched with any critical updates made available from the vendor. Verify that your JVM is installed properly by following these instructions.

The Broker installation requires approximately 20MB of free disk space. The Broker also requires a working directory. The working directory is used for the message store, that is, the area of the file-system used to record messages whilst they are passing through the Broker. The working directory is also used for the default location of the log file. The size of the working directory will depend on the how the Broker is used. The performance of the file system hosting the work directory is key to the performance of Broker as a whole. For best performance, choose a device that has low latency and one that is uncontended by other applications. Be aware that there are additional considerations if you are considering hosting the working directory on NFS.

Qpid caches messages in memory for performance reasons, so in general, the Broker will benefit from as much memory as possible. However, on a 32bit JVM, the maximum addressable memory range for a process is 4GB, after leaving space for the JVM's own use this will give a maximum usable size of approximately ~3.7GB. See for a full description of how memory is used.

Installation or operation of Qpid does not require a privileged account (i.e. root on UNIX platforms or Administrator on Windows). However it is suggested that you use an dedicated account (e.g. qpid) for the installation and operation of the Broker.

You can download the latest Broker package from the Download Page. It is recommended that you confirm the integrity of the download by verifying the PGP signature matches that available on the site. Instructions are given on the download page.

Firstly, verify that your JVM is installed properly by following these instructions. Now chose a directory for Qpid broker installation. This directory will be used for the Qpid JARs and configuration files. It need not be the same location as the work directory used for the persistent message store or the log file (you will choose this location later). For the remainder this example we will assume that location c:\qpid has been chosen. Next extract the qpid-broker-${project.version}-bin.zip package into the directory, using either the zip file handling offered by Windows (right click the file and select 'Extract All') or a third party tool of your choice. The extraction of the broker package will have created a directory qpid-broker\\${project.version} within c:\qpid Directory of c:\qpid\qpid-broker\\${project.version} 25/11/2015 11:29 <DIR> . 25/11/2015 11:29 <DIR> .. 25/11/2015 10:56 <DIR> bin 03/07/2015 08:06 <DIR> etc 25/11/2015 11:25 <DIR> lib 25/11/2015 10:56 28,143 LICENSE 25/11/2015 10:56 3,409 NOTICE 29/04/2015 09:13 116 README.txt 3 File(s) 31,668 bytes 5 Dir(s) 25,981,767,680 bytes free

Qpid requires a work directory. This directory is used for the default location of the Qpid log file and is used for the storage of persistent messages. The work directory can be set on the command-line (for the lifetime of the command interpreter), but you will normally want to set the environment variable permanently via the Advanced System Settings in the Control Panel. set QPID_WORK=C:\qpidwork If the directory referred to by QPID_WORK does not exist, the Broker will attempt to create it on start-up.

Firstly, verify that your JVM is installed properly by following these instructions. Now chose a directory for Qpid broker installation. This directory will be used for the Qpid JARs and configuration files. It need not be the same location as the work directory used for the persistent message store or the log file (you will choose this location later). For the remainder this example we will assume that location /usr/local/qpid has been chosen. Next extract the qpid-broker-${project.version}-bin.tgz package into the directory. mkdir /usr/local/qpid cd /usr/local/qpid tar xvzf qpid-broker-${project.version}-bin.tgz The extraction of the broker package will have created a directory qpid-broker/${project.version} within /usr/local/qpid ls -la qpid-broker/${project.version}/ total 56 drwxrwxr-x. 5 alex alex 4096 Nov 25 11:43 . drwxrwxr-x. 3 alex alex 4096 Nov 25 11:43 .. drwxr-xr-x. 2 alex alex 4096 Nov 24 23:38 bin drwxr-xr-x. 2 alex alex 4096 Nov 24 23:38 etc drwxrwxr-x. 2 alex alex 4096 Nov 25 11:43 lib -rw-r--r--. 1 alex alex 28143 Nov 24 23:38 LICENSE -rw-r--r--. 1 alex alex 3409 Nov 24 23:38 NOTICE -rw-r--r--. 1 alex alex 116 Nov 24 23:38 README.txt

Qpid requires a work directory. This directory is used for the default location of the Qpid log file and is used for the storage of persistent messages. The work directory can be set on the command-line (for the lifetime of the current shell), but you will normally want to set the environment variable permanently the user's shell profile file (~/.bash_profile for Bash etc). export QPID_WORK=/var/qpidwork If the directory referred to by QPID_WORK does not exist, the Broker will attempt to create it on start-up.

If you wish to utilise storage options using Oracle BDB JE or an External Database, see and for details of installing their dependencies.