LibraryLink ToToggle FramesPrintFeedback
Prev   Next

Setting up the Environment on *NIX

Environment variables

Table 3.2 describes the environment variables recognized by the administration tool on *NIX (UNIX and LINUX) platforms.

Table 3.2. Admin Tool Environment Variables on *NIX

VariableDescription
ACTIVEMQ_HOMEDirectory where Fuse Message Broker is installed.
ACTIVEMQ_CLASSPATHSpecifies the classpath used by the current broker instance.
ACTIVEMQ_SSL_OPTSDefines Java properties required to support SSL/TLS protocols. See Security Guide for details.
ACTIVEMQ_CONFIG_DIRSpecifies the location of the broker's configuration directory. Default value is $ACTIVEMQ_HOME/conf.
ACTIVEMQ_DATA_DIRSpecifies the location of the broker's data directory. Default value is $ACTIVEMQ_HOME/data.
ACTIVEMQ_PIDFILESpecifies the location of the file that hold's the broker's process ID (PID).
ACTIVEMQ_USERRun the broker daemon as the specified user, which should be a user with non-root privileges. Default value is a blank string, which implies that the broker does not change user.
ACTIVEMQ_OPTS_MEMORYSpecifies the JVM memory configuration. Default value is -Xms256M -Xmx256M.
ACTIVEMQ_QUEUEMANAGERURLSpecifies the default connection URL that is used with the admin tool's browse task. Default value is --amqurl tcp://localhost:61616.
ACTIVEMQ_KILL_MAXSECONDSWhen shutting down the broker using the stop task, specifies how many seconds to wait for an orderly shutdown to complete (initiated by JMX). After this limit is reached, the admin tool kills the broker using signal -9.

Java environment

You must set the JAVA_HOME environment variable to the location of your Java installation directory. It is usually convenient to set this environment variable at the same time as the other Fuse Message Broker environment variables.

*NIX startup script

On *NIX platforms, the admin tool has the capability to find and source a startup script, immediately before it executes whatever task you have specified. The startup script is a shell script, which is normally used to set some environment variables.

Default locations of startup script

When the admin tool (activemq or activemq-admin) starts up, it looks for startup scripts in the following locations:

  1. /etc/default/activemq

  2. /home/User/.activemqrc

If both of these scripts exist, they will both be sourced by the admin tool, in the order shown.

Setting up a single broker instance

To create your own startup script, perform the following steps:

  1. Check for existing startup scripts—before creating a new startup script, check that you are not about to overwrite an existing script at either of the standard locations, /etc/default/activemq and /home/User/.activemqrc.

  2. Create a default startup script—he admin tool has a task to create a default startup script for you. For example, to create a default startup script at /home/User/.activemqrc, enter the following command:

    ./activemq setup /home/User/.activemqrc

  3. Modify the default startup script—generally, you will need to customize the default startup script, setting the environment variables to appropriate values for your broker instance. In particular, you will generally need to customize at least the JAVA_HOME, ACTIVEMQ_HOME, and the ACTIVEMQ_USER environment variables.

    [Note]Note

    If you are running Fuse Message Broker on the IBM JVM platform, some additional settings are needed. Because IBM's JVM does not support the VirtualMachine.attach(PID) operation, it is necessary for the admin tool to access the broker through a JMX port. You must configure the relevant environment variables (see the comments in the generated scripts) and ensure that the broker enables a JMX port.

Multiple broker instances

By default, the activemq script can launch only one broker at a time, because the startup scripts specify the environment for one particular broker instance only.

If you need to administer multiple broker instances, you can create a symlink of the activemq script and associate it with a specific broker instance, as follows:

  1. Given the broker named BrokerName, create a symbolic link to the activemq script, as follows:

    ln -s ActiveMQInstallDir/bin/activemq activemq-instance-BrokerName

    Now, when the script is invoked using the symbolic copy, activemq-instance-BrokerName, the script changes the algorithm it uses to find the startup scripts.

  2. Save the broker's startup script either in the file /etc/default/activemq-instance-BrokerName or in the file /home/User/.activemqrc-instance-BrokerName.

  3. When you run the launch script as activemq-instance-BrokerName, the script extracts the broker name, BrokerName, from the command name and uses the broker name to locate one (or both) of the startup scripts created in the preceding step.

Prev Up Next
 Home