Author: buildbot
Date: Mon Apr 13 18:22:17 2015
New Revision: 947434
Log:
Production update by buildbot for activemq
Modified:
websites/production/activemq/content/cache/main.pageCache
websites/production/activemq/content/unix-shell-script.html
Modified: websites/production/activemq/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/activemq/content/unix-shell-script.html
==============================================================================
--- websites/production/activemq/content/unix-shell-script.html (original)
+++ websites/production/activemq/content/unix-shell-script.html Mon Apr 13
18:22:17 2015
@@ -36,6 +36,7 @@
<link
href='http://activemq.apache.org/styles/highlighter/styles/shThemeEclipse.css'
rel='stylesheet' type='text/css' />
<script
src='http://activemq.apache.org/styles/highlighter/scripts/shCore.js'
type='text/javascript'></script>
<script
src='http://activemq.apache.org/styles/highlighter/scripts/shBrushJava.js'
type='text/javascript'></script>
+ <script
src='http://activemq.apache.org/styles/highlighter/scripts/shBrushBash.js'
type='text/javascript'></script>
<script type="text/javascript">
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -81,11 +82,45 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><p>From version <strong>5.4.0</strong>
onwards, ActiveMQ comes with a enhanced shell script for starting, stopping and
managing the broker in Unix environment. For basic <a shape="rect"
href="activemq-command-line-tools-reference.html#ActiveMQCommandLineToolsReference-activemq">activemq</a>
and <a shape="rect"
href="activemq-command-line-tools-reference.html#ActiveMQCommandLineToolsReference-activemq-admin">activemq-admin</a>
scripts functionality take a look at <a shape="rect"
href="activemq-command-line-tools-reference.html">ActiveMQ Command Line Tools
Reference</a>.</p><p>This new <code>activemq</code> script incorporate these
two scripts into one and adds some new functionalities. On top of regular
<code>activemq</code> and <code>activemq-admin</code> scripts, it adds the
following features:</p><ul><li><strong>start</strong> - starts the broker in
background. It saves process id in the
<code>${ACTIVEMQ_DATA_DIR}/activemq.pid</code> for futur
e reference. It accepts the same command line arguments like the original
<code>activemq</code> script, so you can do something like</li></ul><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<div class="wiki-content maincontent"><h2
id="UnixShellScript-Functionaloverview">Functional overview</h2><p>From version
<strong>5.4.0</strong> onwards, ActiveMQ comes with a enhanced shell script for
starting, stopping and managing the broker in Unix environment. For basic <a
shape="rect"
href="activemq-command-line-tools-reference.html#ActiveMQCommandLineToolsReference-activemq">activemq</a>
and <a shape="rect"
href="activemq-command-line-tools-reference.html#ActiveMQCommandLineToolsReference-activemq-admin">activemq-admin</a>
scripts functionality take a look at <a shape="rect"
href="activemq-command-line-tools-reference.html">ActiveMQ Command Line Tools
Reference</a>.</p><p>This <code>activemq</code> script incorporate these two
scripts into one and adds some new functionalities. On top of regular
<code>activemq</code> and <code>activemq-admin</code> scripts, it adds the
following features:</p><ul><li><p><strong>start</strong> - starts the broker in
background. It saves process
id in the <code>${ACTIVEMQ_DATA_DIR}/activemq.pid</code> for future
reference. It accepts the same command line arguments like the original
<code>activemq</code> script, so you can do something like</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq start
xbean:conf/activemq-stomp.xml]]></script>
-</div></div><ul><li><strong>console</strong> - starts the broker in
foreground. It is basically the replacement for the old <code>activemq</code>
script</li></ul><ul><li><strong>stop</strong> - stops the broker that is
running in the background. It tries first to stop the broker using <a
shape="rect"
href="activemq-command-line-tools-reference.html#ActiveMQCommandLineToolsReference-shutdown">shutdown</a>
task. If that task doesn't return in 30 seconds (configurable), it will kill
the process.</li></ul><ul><li><strong>restart</strong> - stops the running
instance (if there's one) and starts the new
one</li></ul><ul><li><strong>status</strong> - checks if activemq process is
running</li></ul><ul><li><strong>create</strong> - create an ACTIVEMQ_BASE
directory that separates a broker instance from its binaries, i.e., it creates
copies of the ActiveMQ configuration files into the command-line specified
directory and points to the binaries. You can start the broker with the
<code>/bin</co
de> scripts in the newly created instance.</li></ul><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ ACTIVEMQ_HOME/bin/activemq create
/path/to/brokers/mybroker ]]></script>
-</div></div><h2 id="UnixShellScript-Configuringthescript"><strong>Configuring
the script</strong></h2><p>For ActiveMQ server to run properly some basic
system variables must be set. These variables define how much memory broker
will have, SSL, logging, JAAS options and similar. Prior to version 5.11.0
these parameters were configurable in <code>activemq</code> script itself. You
could use <code>setup</code> command to create additional system wide scripts
to configure the broker.</p><p><strong>setup</strong> - create the specified
configuration file for this Unix script. The configuration of the script can be
placed at <code>/etc/default/activemq</code> or <code>$HOME/.activemqrc</code>.
Note, this is the configuration for the <em>script</em> not for configuring
ActiveMQ.</p><p>To use addtional configurations for running multiple instances
on the same operating system rename or symlink script to a name matching to
<code>activemq-instance-<INSTANCENAME></code>. This changes the
configuration location to
<code>/etc/default/activemq-instance-<INSTANCENAME></code> and
<code>$HOME/.activemqrc-instance-<INSTANCENAME></code>. Configuration
files in /etc have higher precedence.</p><p>Since <strong>5.11.0</strong>, all
configuration variables are moved to the new <code>env</code> script, so that
they can be easily configured at one place. This script can be copied
to <code>/etc/default/activemq</code> or
<code>$HOME/.activemqrc</code> to provide system-wide settings, so the
<code>setup</code> command has been removed. System variables set in the
environment will take precedence. </p></div>
+</div></div></li><li><p><strong>console</strong> - starts the broker in
foreground. It is basically the replacement for the old <code>activemq</code>
script<br clear="none">(you can interrupt the
)</p></li></ul><ul><li><strong>stop</strong> - stops the broker that is running
in the background. It tries first to stop the broker using <a shape="rect"
href="activemq-command-line-tools-reference.html#ActiveMQCommandLineToolsReference-shutdown">shutdown</a>
task. If that task doesn't return in 30 seconds (configurable), it will kill
the process.</li></ul><ul><li><strong>restart</strong> - stops the running
instance (if there's one) and starts the new
one</li></ul><ul><li><strong>status</strong> - checks if activemq process is
running<br clear="none">(exitcode: 1 = broker is down, 0 = broker is
up)</li></ul><ul><li><p><strong>create</strong> - create an ACTIVEMQ_BASE
directory that separates a broker instance from its binaries, i.e., it creates
copies of the ActiveMQ configuration files i
nto the command-line specified directory and points to the binaries. You can
start the broker with the <code>/bin</code> scripts in the newly created
instance.</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq create
/path/to/brokers/mybroker ]]></script>
+</div></div></li><li><p><strong>browse</strong> - Display selected messages in
a specified destination</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq browse FOO.BAR # use broker
connection from configuration
+$ bin/activemq browse --amqurl tcp://localhost:61616 FOO.BAR]]></script>
+</div></div></li><li><p><strong>bstat</strong> - Performs a predefined query
that displays useful statistics regarding the specified
broker</p></li><li><p><strong>dstat</strong> - Performs a predefined query that
displays useful tabular statistics regarding the specified destination
type</p></li><li><p><strong>decrypt</strong> - Decrypts given text</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq decrypt --input
'BkiT42A0CZfL1SanJIgxvQ==' --password asdasdasdasd]]></script>
+</div></div></li><li><p><strong>encrypt</strong> - Encrypts given text</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq encrypt --password
TESTPASSWORD --input FOOBAR]]></script>
+</div></div></li><li><p><strong>export</strong> - Exports a stopped brokers
data files to an archive file</p></li><li><p><strong>list</strong> - Lists all
available brokers in the specified JMX
context</p></li><li><p><strong>purge</strong> - Delete selected destination's
messages that matches the message selector</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq purge FOO.BAR # use jmx access
data from configuration
+$ bin/activemq purge --jmxurl
service:jmx:rmi:///jndi/rmi://127.0.0.1:11098/jmxrmi --jmxuser controlRole
--jmxpassword abcd1234 FOO.BAR]]></script>
+</div></div></li><li><p><strong>query</strong> - Display selected broker
component's attributes and statistics</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ bin/activemq query # use jmx access data
from configuration
+$ bin/activemq query --jmxurl
service:jmx:rmi:///jndi/rmi://127.0.0.1:11098/jmxrmi --jmxuser controlRole
--jmxpassword abcd1234]]></script>
+</div></div></li></ul><h2
id="UnixShellScript-DaemonInstallation/ScriptInstallation">Daemon Installation
/ Script Installation</h2><ul><li><p>Install activemq broker as "root" to be
run as "activemq"</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ useradd -m activemq -d /srv/activemq
+$ cd /srv/activemq
+$ tar zxvf apache-activemq-<version>-bin.tar.gz$ ln -snf
apache-activemq-<version> current
+$ chown -R activemq:users apache-activemq-<version>
+
+]]></script>
+</div></div></li><li><p>Create a global default configuration and edit the
configuration</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[$ cp apache-activemq-<version>/bin/env
/etc/default/activemq
+$ vim /etc/default/activemq]]></script>
+</div></div></li><li><p>Install the init script</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[ln -snf /srv/activemq/current/bin/activemq
/etc/init.d/activemq]]></script>
+</div></div></li><li><p>Activate the init script at system startup<br
clear="none">(TODO: uncomplete)</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[# RHEL
+chkconfig --add activemq
+chkconfig activemq on
+
+# Debian/Ubuntu
+update-rc.d defaults activemq]]></script>
+</div></div></li></ul><h2
id="UnixShellScript-Configuringthescript">Configuring the script</h2><p>For
ActiveMQ server to run properly some basic system variables must be set. These
variables define how much memory broker will have, SSL, logging, JAAS options
and similar.</p><h3 id="UnixShellScript-Version5.11.0andhigher">Version 5.11.0
and higher</h3><p>Since version 5.11.0, all configuration variables are moved
to the new <code>env</code> script file, so that they can be easily configured
at one place.</p><p>The script scans the following locations for configurations
in the following
order:</p><ol><li>/etc/default/activemq</li><li>$HOME/.activemqrc</li><li>$INSTALLDIR/apache-activemq-<version>/bin/env</li></ol><p>The
first existing file is read exclusively - all other files are irgnored. <br
clear="none">Undefined values are discovered in a automated way.</p><p>To use
addtional configurations for running multiple instances on the same operating
system rename or symlink script
to a name matching to <code>activemq-instance-<INSTANCENAME></code>.<br
clear="none">This changes the configuration location to
<code>/etc/default/activemq-instance-<INSTANCENAME></code> and
<code>$HOME/.activemqrc-instance-<INSTANCENAME></code>. Configuration
files in /etc have higher precedence.</p><h3
id="UnixShellScript-Versionsprior5.11.0">Versions prior 5.11.0</h3><p>These
parameters were configurable in <code>activemq</code> script itself. <br
clear="none"><br clear="none">You could use <code>setup</code> command to
create additional system wide defaults file to configure the broker.<br
clear="none">(modify the settings in this file if neccessary - the default
entries look a bit garbled due to an accidentally applied bugfix in this
release)</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="theme: Default; brush: bash; gutter: false"
type="syntaxhighlighter"><![CDATA[./activemq setup
/etc/default/activemq]]></script>
+</div></div><p>The configuration of the script can be placed at
<code>/etc/default/activemq</code> or <code>$HOME/.activemqrc</code>. Note,
this is the configuration for the <em>script</em> not for configuring
ActiveMQ.</p><p>To use addtional configurations for running multiple instances
on the same operating system rename or symlink script to a name matching to
<code>activemq-instance-<INSTANCENAME></code>. This changes the
configuration location to
<code>/etc/default/activemq-instance-<INSTANCENAME></code> and
<code>$HOME/.activemqrc-instance-<INSTANCENAME></code>. Configuration
files in /etc have higher precedence.</p><p> </p></div>
</td>
<td valign="top">
<div class="navigation">
