Bitnami RabbitMQ Installer

NOTE: Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and Mac OS X) or by clicking the shortcut in the Start Menu under "Start -> Bitnami APPNAME Stack -> Application console" (Windows). Learn more.
NOTE: When running the commands shown on this page, replace the installdir placeholder with the full installation directory for your Bitnami stack.

Description

RabbitMQ is a messaging broker that gives your applications a common platform to send and receive messages, and your messages a safe place to live until received.

First steps with the Bitnami RabbitMQ Stack

Welcome to your new Bitnami application! Here are a few questions (and answers!) you might need when first starting with your application.

What are the system requirements?

Before you download and install your application, check that your system meets these requirements.

How do I install the Bitnami RabbitMQ Stack?

Windows, OS X and Linux installer
  • Download the executable file for the Bitnami RabbitMQ Stack from the Bitnami website.

  • Run the downloaded file:

    • On Linux, give the installer executable permissions and run the installation file in the console.
    • On other platforms, double-click the installer and follow the instructions shown.

Check the FAQ instructions on how to download and install a Bitnami Stack for more details.

The application will be installed to the following default directories:

Operating System Directory
Windows C:\Bitnami\APPNAME-VERSION
Mac OS X /Applications/APPNAME-VERSION
Linux /opt/APPNAME-VERSION (running as root user)
OS X VM
  • Download the OS X VM file for the Bitnami RabbitMQ Stack from the Bitnami website.
  • Begin the installation process by double-clicking the image file and dragging the WordPress OS X VM icon to the Applications folder.
  • Launch the VM by double-clicking the icon in the Applications folder.

What credentials do I need?

You need application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.

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

  • For Windows, Linux and OS X installers, the username was configured by you when you first installed the application.
  • For OS X VMs, the username can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

What is the administrator password?

  • For Windows, Linux and OS X installers, the password was configured by you when you first installed the application.
  • For OS X VMs, the password can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

How to start or stop the services?

Linux

Bitnami native installers include a graphical tool to manage services. This tool is named manager-linux-x64.run on Linux and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

      $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql, postgresql or apache:

      $ sudo installdir/ctlscript.sh restart mysql
      $ sudo installdir/ctlscript.sh restart postgresql
      $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

      $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

Mac OS X

Bitnami native installers include a graphical tool to manage services. This tool is named manager-osx on Mac OS X and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

    $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql or apache:

     $ sudo installdir/ctlscript.sh restart mysql
     $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

     $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

NOTE: If you are using the stack manager for Mac OS X-VM, please check the following blog post to learn how to manage services from its graphical tool.

Windows

Bitnami native installers include a graphical tool to manage services. This tool is named manager-windows.exe on Windows and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The Windows native installer creates shortcuts to start and stop services created in the Start Menu, under "Programs -> Bitnami APPNAME Stack -> Bitnami Service". Servers can also be managed from the Windows "Services" control panel. Services are named using the format APPNAMESERVICENAME, where APPNAME is a placeholder for the application name and SERVICENAME is a placeholder for the service name. For example, the native installer for the Bitnami WordPress Stack installs services named wordpressApache and wordpressMySQL.

These services will be automatically started during boot. To modify this behaviour, refer to the section on disabling services on Windows.

What is the default configuration of RabbitMQ?

  • Default access ports: 15672 port and the 5672 port.
    • Port 15672 is for the management panel and is open for connections from a different machine.
    • Port 5672 is for applications and can only be accessed from the internal network.
  • Default hostname and home: the default hostname of RabbitMQ is set to rabbitmq@localhost and the default home is installdir/rabbitmq/rabbitmq_home. Change this in the installdir/rabbitmq/etc/rabbitmq/rabbitmq-env.conf file.

How to connect to the RabbitMQ management panel?

You can connect to the RabbitMQ admin panel by browsing to http://localhost:15672/.

How to connect to RabbitMQ from a different machine?

IMPORTANT: Bitnami Native Installers do not modify the firewall configuration of your computer, therefore the RabbitMQ ports could be open which is a significant security risk. You are strongly advised to close the RabbitMQ ports (refer to the FAQ for more information on this).

If you want to use a transport connector to use RabbitMQ from a different machine, stop your RabbitMQ server and edit the installdir/rabbitmq/etc/rabbitmq/rabbitmq.config file, setting the bind address from 127.0.0.1 to 0.0.0.0:

...
{rabbit,
  [%%
   %% Network Connectivity
   %% ====================
   %%

   %% By default, RabbitMQ will listen on all interfaces, using
   %% the standard (reserved) AMQP port.
   %%
    {tcp_listeners, [5672]},
...

If you don't want to connect to the management console from a different machine, edit the same file with the following configuration:

...
{rabbitmq_management,
[%% Pre-Load schema definitions from the following JSON file. See
 %% http://www.rabbitmq.com/management.html#load-definitions
 %%
 %% {load_definitions, "/path/to/schema.json"},

 %% Log all requests to the management HTTP API to a file.
 %%
 %% {http_log_dir, "/path/to/access.log"},

 %% Change the port on which the HTTP listener listens,
 %% specifying an interface for the web server to bind to.
 %% Also set the listener to use SSL and provide SSL options.
 %%
  {listener, [{port, 15672},{ip, "127.0.0.1"}]}
...

Restart the server for the changes to come into effect.

Once you have an active SSH tunnel or if you did not close the port for remote access, you can connect to RabbitMQ from a different machine, use a command like the one below:

$ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD list vhosts

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

Load the Bitnami Console and then run the command as usual.

How to enable a plugin on RabbitMQ?

To enable a plugin on RabbitMQ you have to follow the next steps:

  • Log in to your server console.

  • Run the following command to list all the plugins:

    $ sudo installdir/rabbitmq/sbin/rabbitmq-plugins list
    
  • Run this command to enable one of them:

    $ sudo installdir/rabbitmq/sbin/rabbitmq-plugins enable PLUGIN_NAME
    

Find out more about RabbitMQ's plugins.

How to use the admin console of RabbitMQ?

To use the RabbitMQ admin console, follow these steps:

  • Download the rabbitmqadmin application from http://localhost:15672/cli/. You will need Python 2.5, 2.6 or later.

  • Copy rabbitmqadmin to /usr/local/bin/ and give it execution permissions.

       $ chmod +x rabbitmqadmin
    
  • Invoke the following for usage instructions:

       $ rabbitmqadmin --help
    

    This command allows you to:

    • list exchanges, queues, bindings, vhosts, users, permissions, connections and channels.
    • show overview information.
    • declare and delete exchanges, queues, bindings, vhosts, users and permissions.
    • publish and get messages.
    • close connections and purge queues.
    • import and export configuration.

Examples:

  • To connect to your machine and list the vhosts that there are created:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD list vhosts
    
  • To declare a new user:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD declare user name=NEW_USER_NAME password=NEW_PASSWORD tags=username
    
  • To give access to the new user:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD declare permission vhost=/ user=NEW_USER_NAME configure=.* write=.* read=.*
    
    NOTE: You have to specify where the new user can configure, write or write. Use .* to specify all the exchanges in the vhost.
  • To delete a user:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD delete user name=NEW_USER_NAME
    
  • To declare an exchange:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD declare exchange name=NEW_EXCHANGE_NAME type=fanout
    
  • To declare a queue with optional parameters:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD declare queue name=NEW_QUEUE_NAME durable=false
    
  • To publish a message:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD publish exchange=amq.default routing_key=QUEUE_NAME payload="hello, world"
    
  • And to get it back:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD  get queue=QUEUE_NAME requeue=false
    
  • To export a configuration:

     $ rabbitmqadmin -H -u USER_NAME -p PASSWORD export rabbit.config
    
  • To import a configuration:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD -q import rabbit.config
    
  • To close all connections:

     $ rabbitmqadmin -H localhost -u USER_NAME -p PASSWORD -f tsv -q list connections name | while read conn ; do rabbitmqadmin -q close connection name=${conn} ; done
    

How to upgrade RabbitMQ?

It is strongly recommended to create a backup before starting the update process. If you have important data, create and try to restore a backup to ensure that everything works properly.

You can upgrade the application only without modifying any other stack components. Follow these steps:

  • Stop your server.

     $ sudo installdir/ctlscript.sh stop rabbitmq
    
  • Copy the etc/, var/ and rabbitmq_home/ folders in the rabbitmq/ folder.

     $ mkdir ~/rabbitmq_backup
     $ sudo cp -r installdir/rabbitmq/etc ~/rabbitmq_backup/
     $ sudo cp -r installdir/rabbitmq/var ~/rabbitmq_backup/
     $ sudo cp -r installdir/rabbitmq/rabbitmq_home ~/rabbitmq_backup
    
  • Download the latest version of RabbitMQ and uncompress it.

     $ tar -xvf rabbitmq-server-generic-unix-3.4.2.tar.g
    
  • Copy the uncompressed folder to installdir/rabbitmq:

     $ sudo cp -r rabbitmq_server-3.4.2/* installdir/rabbitmq/
    
  • Recover your backup files.

     $ sudo cp -r ~/rabbitmq_backup/* installdir/rabbitmq/
    
  • Restart your server.

     $ sudo installdir/ctlscript.sh start rabbitmq
    

How to create a full backup of RabbitMQ?

The Bitnami RabbitMQ 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.

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

Backup on Linux and Mac OS X

Follow these steps:

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

     $ cd /your/directory
    
  • Stop all servers.

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

     $ sudo tar -pczvf application-backup.tar.gz installdir
    
  • Start all servers.

     $ sudo installdir/ctlscript.sh start
    
  • Download or transfer the application-backup.tar.gz file to a safe location.

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

Backup on Windows

Follow these steps:

  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Create a compressed file with the stack contents. You can use a graphical tool like 7-Zip or WinZip or just right-click the folder, click "Send to", and select the "Compressed (zipped) folder" option.

  • Download or transfer the compressed file to a safe location.

  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

Restore on Linux and Mac OS X

Follow these steps:

  • Change to the directory containing your backup:

    $ cd /your/directory
    
  • Stop all servers.

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

    $ sudo mv installdir /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directory:

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

    $ sudo installdir/ctlscript.sh start
    
IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as the root user on Linux, make sure that the restored files are owned by root as well.

Restore on Windows

  • Change to the directory containing your backup:

       $ cd /your/directory
    
  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Uninstall the previous services by executing the following command:

        $ serviceinstall.bat
    
  • Create a safe folder named Backups in the desktop and move the current stack to it. Remember to replace PATH with the right location of your folder:

        $ move installdir \PATH\Backups
    
  • Uncompress the backup file using a tool like 7-Zip or Winzip or just double-click the .zip file to uncompress it, and move it to the original directory.
  • Install services by running the following commands from an elevated command prompt:

      $ cd installdir
      $ serviceinstall.bat INSTALL
    
  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

How to debug RabbitMQ errors?

To debug RabbitMQ's errors, check the log files of RabbitMQ at installdir/rabbitmq/var.

How to change the RabbitMQ user password?

You can modify the RabbitMQ user password by running the following command:

$ sudo rabbitmqctl change_password USER_NAME NEW_PASSWORD
nativeInstaller

Bitnami Documentation