View source for JMS server: ActiveMQ

=Manual installation=

==Installation==

===Get Apache Active MQ===
Get the latest binary version from: http://activemq.apache.org/download.html

===Program setup===
* Copy archive to /opt/ directory:
<syntaxhighlight lang="bash">
mv apache-activemq-5.9.1-bin.zip /opt/
cd /opt/
</syntaxhighlight>

* Unzip and create simlink
<syntaxhighlight lang="bash">
unzip apache-activemq-5.9.1-bin.zip
ln -s /opt/apache-activemq-5.9.1/ /opt/activemq/
</syntaxhighlight>

* Set executable flag and symlinks
<syntaxhighlight lang="bash">
chmod 755 /opt/activemq/bin/activemq
ln -s /opt/activemq/bin/activemq /usr/bin/activemq
ln -s /opt/activemq/bin/activemq /etc/init.d/activemq
</syntaxhighlight>

===Rights adjustments===
* Add non privileged account
<syntaxhighlight lang="bash">
adduser -system activemq
addgroup -system activemq
</syntaxhighlight>

* Adjust user shell
Edit:
<syntaxhighlight lang="bash">
vim /etc/passwd
</syntaxhighlight>
Adjust the user SHELL
<syntaxhighlight lang="bash">
activemq:x:116:65534::/home/activemq:/bin/bash
</syntaxhighlight>

* Adjust user group
Edit:
<syntaxhighlight lang="bash">
vim /etc/group
</syntaxhighlight>
Adjust the group membership
<syntaxhighlight lang="bash">
activemq:x:1001:activemq
</syntaxhighlight>

* Set MQ folder privileges
<syntaxhighlight lang="bash">
chown -R activemq:activemq /opt/apache-activemq-5.9.1/
chown -R activemq:activemq /opt/activemq/
</syntaxhighlight>

==Basic configuration==

===Home + User===
* Set home and user
Edit
<syntaxhighlight lang="bash">
vim /opt/activemq/bin/activemq
</syntaxhighlight>
Set after "Configuration" (line ~ 40)
<syntaxhighlight lang="bash">
ACTIVEMQ_HOME=”/opt/activemq”
ACTIVEMQ_USER=”activemq”
</syntaxhighlight>

===Runtime configuration===
* Create runtime configuration. Generate default settings
<syntaxhighlight lang="bash">
/opt/activemq/bin/activemq setup /etc/default/activemq
</syntaxhighlight>

* Adjust configuration rights
<syntaxhighlight lang="bash">
chown root:nogroup /etc/default/activemq
chmod 600 /etc/default/activemq
</syntaxhighlight>

===Add ActiveMQ to boot sequence===
<syntaxhighlight lang="bash">
cd /etc/init.d
update-rc.d activemq defaults
</syntaxhighlight>

===Remove ActiveMq from boot sequence===
<syntaxhighlight lang="bash">
update-rc.d -f activemq remove
rm /etc/init.d/activemq
</syntaxhighlight>


=Setup firewall=

This is the list of ports that are used by ActiveMQ:
* port 61616 = JMS queue access
* port 11099 = JMX remote console (connector port)
* port 8161 = HTTP manager
* port 8162 = HTTPS manager
* port 5672 = AMQP port

Edit your firewall script:
<syntaxhighlight lang="bash">
vim /etc/firewall/firewall-start.sh
</syntaxhighlight>


<syntaxhighlight lang="bash">
#### INPUT
# messages
$IPTABLES -A INPUT -p tcp -m state --state NEW --dport 5672 -j ACCEPT       # AMQP port
$IPTABLES -A INPUT -p tcp -m state --state NEW --dport 61616 -j ACCEPT     # JMS port

# web monitoring
#$IPTABLES -A INPUT -p tcp -m state --state NEW --dport 8161 -j ACCEPT     # HTTP web-console. Not required if you're using Apache2 proxy
#$IPTABLES -A INPUT -p tcp -m state --state NEW --dport 8162 -j ACCEPT     # HTTPs web-console. Not required if you're using Apache2 proxy

# JMX monitoring
$IPTABLES -A INPUT -p tcp -m state --state NEW --dport 1099 -j ACCEPT      # JVM default RMI port
#$IPTABLES -A INPUT -p tcp -m state --state NEW --dport 11099 -j ACCEPT    # JMX standalone port. Not required if you're using default JVM JMX connector on TCP 1616

# Output
$IPTABLES -A OUTPUT -p tcp -m state --state NEW --dport 5672 -j ACCEPT 
$IPTABLES -A OUTPUT -p tcp -m state --state NEW --dport 61616 -j ACCEPT

$IPTABLES -A OUTPUT -p tcp -m state --state NEW --dport 8161 -j ACCEPT
$IPTABLES -A OUTPUT -p tcp -m state --state NEW --dport 8162 -j ACCEPT

$IPTABLES -A OUTPUT -p tcp -m state --state NEW --dport 1099 -j ACCEPT
$IPTABLES -A OUTPUT -p tcp -m state --state NEW --dport 11099 -j ACCEPT
</syntaxhighlight>



= Logs =

The application's logs are in $ACTIVEMQ/data/activemq.log

<syntaxhighlight lang="bash">
cat /opt/activemq/data/activemq.log
</syntaxhighlight>



= Advanced Configuration (all O.S)=

==Broker settings==

===Edit configuration file===
* Linux ~ manual
<syntaxhighlight lang="bash">
vim /opt/activemq/conf/activemq.xml
</syntaxhighlight>

* Linux ~ auto
<syntaxhighlight lang="bash">
vim /etc/activemq/instances-enabled/main/activemq.xml
</syntaxhighlight>

* Windows
$ACTIVEMQ/conf/activemq.xml


===Adjust broker setting===
* Set broker name
<syntaxhighlight lang="xml">
<broker     xmlns="http://activemq.apache.org/schema/core"
        brokerName="myServerName"
       dataDirectory="${activemq.base}/data">
</syntaxhighlight>

* Set listener to all interfaces (0.0.0.0)
<syntaxhighlight lang="xml">
<transportConnectors>
        <transportConnector name="openwire" uri="tcp://0.0.0.0:61616"/>
</transportConnectors>
</syntaxhighlight>

* Limit queues size
<syntaxhighlight lang="xml">
<systemUsage>
 <systemUsage>
  <memoryUsage>
   <memoryUsage limit="64 mb"/>
  </memoryUsage>
  <storeUsage>
   <storeUsage limit="100 gb"/>
  </storeUsage>
  <tempUsage>
   <tempUsage limit="50 gb"/>
  </tempUsage>
 </systemUsage>
</systemUsage>
</syntaxhighlight>


==Enable HTTP web console==

===Edit your jetty configuration===
Linux ~ Manual
<syntaxhighlight lang="bash">
vim /opt/activemq/conf/jetty.xml
</syntaxhighlight>

* Windows
$ACTIVEMQ/conf/jetty.xml

===Adjust broker name and listening port===
At the bottom, edit connector :
<syntaxhighlight lang="xml">
<property name="connectors">
  <list>
     <bean id="Connector" class="org.eclipse.jetty.server.nio.SelectChannelConnector">
         <property name="port" value="8161" />
         <property name="host" value="0.0.0.0" />
      </bean>
    ...
  </list>
</property>
</syntaxhighlight>


===Change root context for Web-Console===

Edit "jetty.xml" [look to the previous §]

Add a new ''securityConstraintMapping'' (line 40), " /activemq/* "
<syntaxhighlight lang="xml">
<bean id="securityConstraintMapping" class="org.eclipse.jetty.security.ConstraintMapping">
      <property name="constraint" ref="securityConstraint" />
      <property name="pathSpec" value="/api/*,/activemq/*,/admin/*,*.jsp" />
 </bean>
</syntaxhighlight>


Change the ''WebAppContext.contextpath'' value to " /activemq " instead of " /admin "
<syntaxhighlight lang="xml">
  <property name="handler">
     <bean id="sec" class="org.eclipse.jetty.server.handler.HandlerCollection">
         <property name="handlers">
             <list>
                 <bean class="org.eclipse.jetty.webapp.WebAppContext">
                    <!-- property name="contextPath" value="/admin" / -->
                    <property name="contextPath" value="/activemq" />
                    <property name="resourceBase" value="${activemq.home}/webapps/admin" />
                    <property name="logUrlOnStart" value="true" />
                 </bean>

                 ...
</syntaxhighlight>



===Manage web-users===
<syntaxhighlight lang="bash">
vim /opt/activemq/conf/jetty-realm.properties
</syntaxhighlight>

Edit last line
<syntaxhighlight lang="bash">
     admin: admin, admin
</syntaxhighlight>


===Apache 2 mod proxy===
If you like to use Apache 2 mod_proxy instead of opening your ports:

Edit either your ''Virtual Host'' configuration of ''mod_proxy''.conf :
<syntaxhighlight lang="bash">
	ProxyPass /activemq http://localhost:8161/activemq/
	ProxyPassReverse /activemq http://localhost:8161/activemq 	
</syntaxhighlight>



=Enable JMX remote management and monitoring=

Official documentation: http://activemq.apache.org/jmx.html


==Add JMX support==
Edit configuration:
<syntaxhighlight lang="bash">
vim /opt/activemq/conf/activemq.xml
</syntaxhighlight>


Adjust the broker tag (line 35), add '''useJmx="true"'''
<syntaxhighlight lang="xml">
<broker xmlns="http://activemq.apache.org/schema/core" useJmx="true" brokerName="preprodrtd.vehco.com" dataDirectory="${activemq.data}">
...
</broker>
</syntaxhighlight>


Make sure that you're using a new JVM connector (line 65):
<syntaxhighlight lang="xml">
<broker xmlns="http://activemq.apache.org/schema/core" useJmx="true" brokerName="preprodrtd.vehco.com" dataDirectory="${activemq.data}"> 
  ... 
  <managementContext>
     <managementContext createConnector="true" />
  </managementContext>
   ...
 </broker>
</syntaxhighlight>


==Create JMX users==
* User creation

<syntaxhighlight lang="bash">
vim /opt/activemq/conf/jmx.access
</syntaxhighlight>

Add some users. As a reminder:
<syntaxhighlight lang="bash">
userMq readonly
adminMq readwrite
</syntaxhighlight>


* User password

<syntaxhighlight lang="bash">
vim /opt/activemq/conf/jmx.password
</syntaxhighlight>

Set passwords. Usernames must match!
<syntaxhighlight lang="bash">
userMq abc123
adminMq abcd1234
</syntaxhighlight>


==JMX settings==
Edit activemq launcher
<syntaxhighlight lang="bash">
vim /opt/activemq/bin/activemq
</syntaxhighlight>

Search for ACTIVEMQ_JMX and adjust the lines to:
<syntaxhighlight lang="bash">
# ACTIVEMQ_SUNJMX_START="-Dcom.sun.management.jmxremote.port=11099 "
ACTIVEMQ_SUNJMX_START="-Dcom.sun.management.jmxremote.rmi.port=1099 "
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=${ACTIVEMQ_CONF}/jmx.password"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=${ACTIVEMQ_CONF}/jmx.access"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote"
</syntaxhighlight>

!! Note that the '''default JVM RMI port''' will be used [TCP 1099] instead of the standalone one. !!


No you can access the console remotely using Jconsole or any other client. 

URL:   service:jmx:rmi:///jndi/rmi://'''<your hostname>''':1099/jmxrmi 



=Automatic installation=

!! Depending on your distro, you might not have the web console !! This is NOT recommended.

==Get binary==
<syntaxhighlight lang="bash">
apt-get install activemq
</syntaxhighlight>

==Enable instance==
* Check instance
<syntaxhighlight lang="bash">
cd /etc/activemq/instances-enabled/
ls
</syntaxhighlight>
... By default you should have an instance enable.

If not:
<syntaxhighlight lang="bash">
ln -s /etc/activemq/instances-available/main /etc/activemq/instances-enabled/main
cp /usr/share/activemq/activemq-options /etc/activemq/instances-available/main/options
</syntaxhighlight>

* Edit settings
<syntaxhighlight lang="bash">
vim /etc/activemq/instances-available/main/options
</syntaxhighlight>

* Adjust $INSTANCE (use 'main')
<syntaxhighlight lang="bash">
ACTIVEMQ_BASE="/var/lib/activemq/main"
</syntaxhighlight>
   
==Create directories==

<syntaxhighlight lang="bash">
mkdir -p /var/lib/activemq/main/data
mkdir -p /var/lib/activemq/main/data/kahadb                
chown -R activemq:activemq /var/lib/activemq/main
chmod -R 755 /var/lib/activemq/main
</syntaxhighlight>

Kahadb == MQ embedded DB