Bitnami ActiveMQ Virtual Machine

Description

Apache ActiveMQ is an open source message broker written in Java together with a full Java Message Service (JMS) client.

First steps with the Bitnami ActiveMQ Stack

Welcome to your new Bitnami application! This guide includes some basic information you will need to get started with your application.

How to import a Bitnami Virtual Machine?

Check the following instructions to import a Bitnami Virtual Machine:

Importing a Bitnami Virtual Machine in VirtualBox
  • Select the "File -> Import Appliance" menu option and select the .ova file downloaded from the Bitnami website. Then click "Continue".
  • Once it is imported, click the "Start" button in the VirtualBox toolbar.

For a detailed walkthrough, check our Virtualbox tutorial.

Importing a Bitnami Virtual Machine in a VMware product
  • Select the "File -> Import" menu option and select the .ova file downloaded from the Bitnami website. Then click "Continue".
  • Once the import is complete, click "Finish" to start the virtual machine.

For a detailed walkthrough, check our VMware tutorial, which uses VMware Fusion as an example. To learn how to use our virtual machines with other VMware products, refer to the VMware Workstation documentation or the VMware vSphere documentation.

What credentials do I need?

You need two sets of credentials:

  • The application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.
  • The server credentials, consisting of an SSH username and password. These credentials allow you to log in to your virtual machine using an SSH client and execute commands at the virtual machine console using the command line.

What is the administrator username set for me to log in to the application for the first time?

Username: admin

What is the administrator password?

Password: The administrator password to log in to your application is randomly generated during the first boot. Check the FAQ to learn how to retrieve it.

What SSH username should I use for secure shell access to my application?

SSH username: bitnami

What is my server IP address?

The IP address is displayed on screen at the end of the boot process, but you can check it at any time by running the following command:

  $ sudo ifconfig

Check server IP address

How do I get my SSH key or password?

You can obtain the SSH password from the virtual machine console when it starts up. Click here for more information.

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without any service name arguments to start all services:

$ sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the service name as argument:

$ sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

$ sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

Port 22 is the default port for SSH connections.

The ActiveMQ access port is 8161. This port is closed by default. You must open it to enable remote access.

How to connect to the ActiveMQ admin panel?

In order to connect to the ActiveMQ admin panel, you have two options:

  • (Recommended): Access the ActiveMQ admin panel through an SSH tunnel (refer to the FAQ for more information about SSH tunnels).
  • Open the port 8161 for remote access (refer to the FAQ for more information about opening ports).

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

Once you have an active SSH tunnel or you opened the port for remote access, you can then connect to ActiveMQ admin panel by browsing to:

  • Access through an SSH tunnel: http://127.0.0.1:SOURCE-PORT/
  • Access opening ports: http://SERVER-IP:8161/

Access ActiveMQ admin panel

Enter the following credentials to log in:

How to connect to ActiveMQ from a different machine?

For security reasons, the ActiveMQ ports in this solution cannot be accessed over a public IP address. To connect to ActiveMQ from a different machine, you must open ports 61616 and 8161 for remote access. Refer to the FAQ for more information on this.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

By default, all ActiveMQ transport connectors are enabled. To disable one of them, edit the /opt/bitnami/activemq/conf/activemq.xml file, and remove the line related to that connector:

<transportConnectors>
   <!-- DOS protection, limit concurrent connections to 1000 and frame size to 100MB -->
   <transportConnector name="openwire" uri="tcp://0.0.0.0:61616?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
   <transportConnector name="amqp" uri="amqp://0.0.0.0:5672?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
   <transportConnector name="stomp" uri="stomp://0.0.0.0:61613?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
   <transportConnector name="mqtt" uri="mqtt://0.0.0.0:1883?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
   <transportConnector name="ws" uri="ws://0.0.0.0:61614?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
</transportConnectors>

In case of changes to the configuration file, restart the server to have the changes take effect:

$ sudo /opt/bitnami/ctlscript.sh restart activemq

To test the server connectivity, run one of the ActiveMQ examples from a different machine using these instructions.

How to change the ActiveMQ administration panel password?

You can modify the ActiveMQ admin panel password in the file /opt/bitnami/activemq/conf/jetty-realm.properties:

admin: NEWPASSWORD, admin

How to change the ActiveMQ connector password?

To change the connector password, follow these steps:

  • Generate a new secret-password pair:

     $ /opt/bitnami/activemq/bin/activemq encrypt --password NEWSECRET --input NEWPASSWORD
    
  • Substitute the encrypted password (from the last line of the previous command output) in /opt/bitnami/activemq/conf/credentials-enc.properties:

     activemq.password=ENC(NEWENCRYPTEDPASSWORD)
    
  • Change the value of the secret in the file /opt/bitnami/activemq/conf/activemq.xml:

     <bean id="configurationEncryptor" class="org.jasypt.encryption.pbe.StandardPBEStringEnc\    ryptor">
        <property name="algorithm" value="PBEWithMD5AndDES"/>
        <property name="password" value="NEWSECRET"/>
     </bean>
    

How can I run a command in the Bitnami ActiveMQ Stack?

Log in to the server console as the bitnami user and run the command as usual. The required environment is automatically loaded for the bitnami user.

How to run an ActiveMQ example?

The following steps walk you through running an ActiveMQ example using the Java source code.

  • First, ensure that you have Maven installed on the server. If you don't, install it following these instructions:
    • Debian:

      $ sudo apt-get install maven
      
    • CentOS:

      $ sudo wget http://repos.fedorapeople.org/repos/dchen/apache-maven/epel-apache-maven.repo -O /etc/yum.repos.d/epel-apache-maven.repo
      $ sudo yum install apache-maven
      
  • Next, activate a Maven profile. To do this, modify the Maven settings.xml file (usually located in /etc/maven/settings.xml or /etc/maven2/settings.xml, although the path might differ on your server) and include the following:

     <profiles>
       ...  
       <profile>
         <id>env-dev</id>
         <activation>
           <property>
             <name>target-env</name>
             <value>dev</value>
           </property>
         </activation>
         <properties>
           <maven.compiler.compilerVersion>1.7</maven.compiler.compilerVersion>
           <maven.compiler.fork>true</maven.compiler.fork>
         </properties>
       </profile>
     </profiles>
    
      <activeProfiles>
       <activeProfile>env-dev</activeProfile>
     </activeProfiles> 
    
  • Go to the examples/ folder and install it using maven:

     $ cd /opt/bitnami/activemq/examples/amqp/java
     $ sudo mvn install
    
  • Export the environment variables you need and run the example. Note that you can obtain your server's private IP address by using the /sbin/ifconfig command.

     $ export ACTIVEMQ_USER=admin
     $ export ACTIVEMQ_PASSWORD=PASSWORD
     $ export ACTIVEMQ_HOST=SERVER-IP
     $ java -cp target/amqp-example-0.1-SNAPSHOT.jar example.Listener &
     $ java -cp target/amqp-example-0.1-SNAPSHOT.jar example.Publisher
    

Execute the Listener and Publisher on different machines. You should now see the example running.

How to run the ActiveMQ web demos?

ActiveMQ comes with a number of Web demos that illustrate how to use the ActiveMQ broker with REST and AJAX. The Web demos are not activated in the default configuration, so you must follow the steps below to get them running:

  • Edit the /opt/bitnami/activemq/examples/conf/activemq-demo.xml file and change the 'locations' property to reflect the location of the encrypted credentials file, located at /opt/bitnami/activemq/conf/credentials-enc.properties:

     <property name="locations">
           <value>file:${activemq.conf}/credentials-enc.properties</value>
     </property>
    
  • If the ActiveMQ server is currently running, stop it:

     $ sudo /opt/bitnami/ctlscript.sh stop activemq
    
  • Run the example:

     $ cd /opt/bitnami/activemq
     $ sudo ./bin/activemq console xbean:/opt/bitnami/activemq/examples/conf/activemq-demo.xml
    

    The ActiveMQ broker should now start.

  • Log in to the Web administration panel and view the demos by browsing to http://DOMAIN:8161/demo. If needed, use the credentials obtained from the server dashboard to log in.

How to create a full backup of ActiveMQ?

Backup

The Bitnami ActiveMQ Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

  • Change to the directory in which you wish to save your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Create a compressed file with the stack contents:

      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    
  • Restart all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

  • Change to the directory containing your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Move the current stack to a different location:

      $ sudo mv /opt/bitnami /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directoryv

      $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to debug ActiveMQ errors?

The main ActiveMQ log file is created at /opt/bitnami/activemq/data/activemq.log.

virtualMachine

Bitnami Documentation