Getting Started Guide

This guide will help you install, setup and run an Apollo broker and validate that the broker is operating correctly.


  1. Download the Apollo distribution that is most appropriate for your operating system.

  2. Extract the distribution archive:

    Unix/Linux/OS X

    tar -zxvf apache-apollo-1.5-unix-distro.tar.gz


    jar -xvf

The distribution will be extracted into a directory called, apache-apollo-1.5. The rest of dis document will refer the full path to this directory as ${APOLLO_HOME}.

Optional Windows Prerequisites

If your on Windows Vista, Server 2008, or later you should install the MS VC++ 2010 Redistributable package so that Apollo can use the JNI implementation of LevelDB.

Creating a Broker Instance

A broker instance is the directory containing all the configuration and runtime data such as logs and data files associated with a broker process. It is recommended that you do not create the instance directory under ${APOLLO_HOME}. This separation is encouraged so that you can more easily upgrade when the next version of Apollo is released.

On unix systems, it is a common convention to store this kind of runtime data under the /var/lib directory. For example, to create an instance at '/var/lib/mybroker', run:

cd /var/lib
${APOLLO_HOME}/bin/apollo create mybroker

A broker instance directory will contain the following sub directories:

At this point you may want to adjust the default configuration located in the etc directory.

Running a Broker Instance

Assuming you created the broker instance under /var/lib/mybroker all you need to do start running the broker instance is execute:

/var/lib/mybroker/bin/apollo-broker run

Now that the broker is running, you can optionally run some of the included examples to verify the the broker is running properly.

Web Administration

Apollo provides a simple web interface to monitor the status of the broker. Once the admin interface will be accessible at:

The default login id and password is admin and password.