Installing OpenJMS

This document describes how to install OpenJMS from an install archive. Refer to the Downloads document for instructions on obtaining a copy.


OpenJMS will run on any platform where there is a suitable Java 2 runtime environment

Unpacking the install archive

The install archive contains everything required to run OpenJMS on your system. The archive has a single top-level directory named openjms-0.7.7-beta-1 with all the OpenJMS related files beneath that.

Install archives with a .zip extension can be unpacked using winzip, or the jar tool (distributed with the Java 2 SDK). E.g.:

jar xvf

Install archives with a .tar.gz extension can be unpacked with gzip and tar. E.g.:

gzip -cd openjms-0.7.7-beta-1.tar.gz | tar xvf -

Environment variables

The OpenJMS server uses the following environment variables:

Name Description Required?
JAVA_HOME Java runtime environment installation directory. Yes
OPENJMS_HOME OpenJMS installation directory. No

Directory structure

The bin directory contains Unix shell scripts and Windows batch files to:

  • start, stop, and administer the OpenJMS server
  • create the OpenJMS database

The docs directory contains the full set of OpenJMS documentation.

The lib directory contains:

  • JARs required to run the OpenJMS server
  • JARs required by client programs to use OpenJMS

The config directory contains:

  • the default OpenJMS server configuration file, openjms.xml
  • SQL scripts to create the OpenJMS database

The examples directory contains the sources to the sample programs.