LATEST VERSION: 3.6.5 - CHANGELOG
Pivotal RabbitMQ v3.x

Installing Pivotal RabbitMQ

Installation procedures for Pivotal RabbitMQ server differ according to the operating system you are using.

RHEL - Install Pivotal RabbitMQ from a RPM

You can install Pivotal RabbitMQ on Red Hat Linux Enterprise (RHEL) computers using the Pivotal RPM repository. See Install Pivotal RabbitMQ from a Downloaded RPM.

You can also download the RPM from the Pivotal RabbitMQ product page and install it on your RHEL computer using the rpm command, as described in Install Pivotal RabbitMQ from a Downloaded RPM.

Install Pivotal RabbitMQ from the RPM Repository

Prerequisites

  • Verify that your system meets the supported configurations described in Supported Configurations and System Requirements.
  • Install ErlangInstall Erlang.
  • Install the Pivotal repository RPM, which makes it easy to browse for the RPMs. Install the repository on each RHEL computer on which you want to install Pivotal RabbitMQ.

    1. On the RHEL computer, start a terminal either as the root user or as an unprivileged user who has sudo privileges.
    2. Install the Pivotal repository RPM using the following wget command:

      RHEL 5:

      prompt# wget -q -O - http://packages.pivotal.io/pub/rpm/rhel5/app-suite/app-suite-installer | sh 
      

      RHEL 6:

      prompt# wget -q -O - http://packages.pivotal.io/pub/rpm/rhel6/app-suite/app-suite-installer | sh 
      

      The command performs the following tasks:

      • Imports the Pivotal GNU Privacy Guard (GPG) key.
      • Installs the Pivotal repository RPM.
      • Launches the Pivotal End User License Agreement (EULA) acceptance and responsibory configuration script.
      • Outputs the EULA for you to read; you must answer yes to accept the terms and continue.
    3. Enter the command yum search pivotal to view the list of Pivotal components that you can install from the repository. For example (output truncated for clarity):

      prompt# yum search pivotal
      ======================================== Matched: pivotal ========================================
      ...
      pivotal-rabbitmq-java-client-bin.noarch : The RabbitMQ Java Client Library
      pivotal-rabbitmq-server.x86_64 : The RabbitMQ server
      
      pivotal-web-server.x86_64 : Pivotal Web Server
      ...
      

Procedure

  1. Log in to the RHEL computer on which you will install Pivotal RabbitMQ as the root user (or as an unprivileged user who has sudo privileges).
  2. Execute the following yum command:

    prompt# yum install pivotal-rabbitmq-server 
    
  3. Respond to the prompts to complete RabbitMQ installation.

What the yum command does

The yum command:

  • Installs Pivotal RabbitMQ into the /opt/pivotal/rabbitmq directory and sets the owner of the directory, along with all child directories and files, to root:root.
  • If the user does not already exist, adds a rabbitmq non-interactive user (in the group rabbitmq). The RabbitMQ server process runs as the rabbitmq user.

    You cannot log in directly as the rabbitmq user because interactive login is disabled.

What to do next

  • Start and Stop the Pivotal RabbitMQ Server to ensure that you installed it correctly.
  • Ensure that the RabbitMQ management plugin is enabled by running the following command:

    prompt# cd /opt/pivotal/rabbitmq/bin
    prompt# ./rabbitmq-plugins list
    

    Check that there is an [E] next to rabbitmq_management, which indicates the plugin is enabled, as shown:

    ...
    [E] rabbitmq_management               3.5.[x]
    [e] rabbitmq_management_agent         3.5.[x]
    [E] rabbitmq_management_visualiser    3.5.[x]
    ...
    

    If the management plugin is not enabled, enable it with the following command:

    prompt# ./rabbitmq-plugins enable rabbitmq_management 
    

    Restart the RabbitMQ server for the changes to take effect.

  • To ensure RabbitMQ Server is running, launch the management console in your browser using the following URL:

    http://host:15672 
    

    If your browser is on the same computer as the RabbitMQ server you can use http://localhost:15672.

    Enter the default credentials that were created at installation: user guest and password guest.

    Use the management console to manage exchanges, queues, bindings, virtual hosts, users and permissions.

  • Install the Pivotal RabbitMQ Java Client Libraries.

  • Read the Next Steps section for a high-level roadmap to subsequent tasks.

Install Pivotal RabbitMQ from a Downloaded RPM

You can install Pivotal RabbitMQ on RHEL by downloading the RPM from the Pivotal download center and executing the rpm command.

Prerequisites

Procedure

  1. Log in to the RHEL computer on which you will install Pivotal RabbitMQ as the root user (or as an unprivileged user who has sudo privileges).
  2. From the Pivotal RabbitMQ product page, click Downloads.
  3. Download the RabbitMQ RPM file, and save it to a directory on your computer. The RPM file is called pivotal-web-server-version.noarch.rpm.

    Chose the architecture (32- or 64-bit) appropriate for your computer.

  4. Start a terminal and change to the directory in which you downloaded the RPM.

  5. Execute the following rpm command to install RabbitMQ:

    prompt# rpm -ivhf pivotal-rabbitmq-server-version.noarch.rpm
    
  6. In the previous section, see What the yum install command does for post-installation information, such as the installation directory. (The yum install command corresponds to the rpm command in this procedure.)

See What to do next for the suggested next steps.

RHEL - Start and Stop the RabbitMQ Server

You must first start the RabbitMQ server to use it. The default configuration for the server is usually adequate to start it.

Prerequisites

Procedure

  1. Log in as the root user and open a terminal window.
  2. Start the RabbitMQ server using the /sbin/service rabbitmq-server command, passing it the start option. For example:

    prompt# /sbin/service rabbitmq-server start 
    

    The RabbitMQ server process runs as the rabbitmq user, which is non-interactive.

  3. To stop the server:

    prompt# /sbin/service rabbitmq-server stop 
    
  4. To get status about the server (only partial output shown):

    prompt# /sbin/service rabbitmq-server status
    Status of node rabbit@localhost ...
    [{pid,6184},
     {running_applications,
         [{rabbitmq_management,"RabbitMQ Management Console","3.5.[x]"},
          {rabbitmq_web_dispatch,"RabbitMQ Web Dispatcher","3.5.[x]"},
          {webmachine,"webmachine","1.10.3-rmq3.5.[x]-gite9359c7"},
          {mochiweb,"MochiMedia Web Server","2.7.0-rmq3.5.[x]-git680dba8"},
          {rabbitmq_management_agent,"RabbitMQ Management Agent","3.5.[x]"},
          {rabbit,"RabbitMQ","3.5.[x]"},
          {os_mon,"CPO  CXC 138 46","2.2.10"},
          {inets,"INETS  CXC 138 49","5.9.1"},
          {xmerl,"XML parser","1.3.2"},
          {mnesia,"MNESIA  CXC 138 12","4.7.1"},
          {amqp_client,"RabbitMQ AMQP Client","3.5.[x]"},
          {sasl,"SASL  CXC 138 11","2.2.1"},
          {stdlib,"ERTS  CXC 138 10","1.18.2"},
          {kernel,"ERTS  CXC 138 10","2.15.2"}]},
     {os,{unix,linux}},
     {erlang_version,
         "Erlang R15B02 (erts-5.9.2) [source] [64-bit] [async-threads:30] [kernel-poll:true]\n"},
     {memory,
         [{total,32983488},
          {connection_procs,5296},
    ... 
    

What to do next

  • The RabbitMQ server does not start as a daemon by default when your system starts. If, however, you want it to start by default, then run the following command as the root user or a user with sudo privileges:

    prompt# chkconfig rabbitmq-server on
    
  • You can also use the rabbitmqctl command to stop and start the RabbitMQ server, as well as perform a number of other tasks, such as get the status of the server, rotate the logs, and so on. The rabbitmqctl command is located in the /opt/pivotal/rabbitmq/bin directory. Run the command as the root user or as a user with sudo privileges. For example, to get the status of the RabbitMQ server (full output removed for simplicity):

    prompt# cd /opt/pivotal/rabbitmq/bin
    prompt# ./rabbitmqctl status
       Status of node 'rabbit@rhel-5-64-svr' ...
    

    For complete information about this command, see the rabbitmqctl manual page.

RHEL - Install Pivotal RabbitMQ Java Client Libraries from RPM

Pivotal RabbitMQ provides client libraries for Java. The Java client library allows Java code to interface to AMQP servers, such as Pivotal RabbitMQ Server. The library is platform-neutral. The Java client library is distributed as an RPM for RHEL computers.

Procedure

  1. Log in to the RHEL computer on which you will install Pivotal RabbitMQ as the root user (or as an unprivileged user who has sudo privileges).
  2. From the Pivotal RabbitMQ product page, click Downloads.
  3. Download the RabbitMQ Java Library RPM file, and save it to a directory on your computer. The RPM file is called pivotal-rabbitmq-java-client-bin-version.noarch.rpm.
  4. Start a terminal and change to the directory in which you downloaded the RPM.
  5. Execute the following rpm command to install the RabbitMQ Java client libraries:

    prompt# rpm -ivhf pivotal-rabbitmq-java-client-bin-version.noarch.rpm 
    

What to do next

SLES - Install Pivotal RabbitMQ

You can install Pivotal RabbitMQ on SUSE Linux Enterprise Server (SLES) computers from a tar.gz file.

Install Pivotal RabbitMQ from a tar.gz file

Prerequisites

Procedure

  1. Install the server.

    1. Download the pivotal-rabbitmq-server-3.5.x.tar.gz file.
    2. Contained in the tarball is a directory named rabbitmq_server-3.5. [x]. Extract this directory into an appropriate directory for application binaries on your system. The sbin folder is located in this directory.
  2. Start the server.

    1. Invoke the sbin/rabbitmq-server shell script. The script displays a short banner message, concluding with the message “completed with [n] plugins.”, indicating that the RabbitMQ broker has been started successfully.

      You can also start the server in “detached” mode with the following command:rabbitmq-server -detachedIn this case, the server process runs in the background.

  3. Configure the server.

    Customise the RabbitMQ environment by setting environment variables in the $RABBITMQ_HOME/etc/rabbitmq/rabbitmq-env.conf file.

    Configure server components in the RabbitMQ configuration file located at $RABBITMQ_HOME/etc/rabbitmq/rabbitmq.config.

    Neither of these files exists after installation.

File locations

The generic Unix tarball is designed as far as possible to run without requiring configuration changes or special permissions. The directories and files used by default are all held under the installation directory rabbitmq_server-3.5. [x], which is in the $RABBITMQ_HOME variable in the scripts. Should you want to install RabbitMQ such that it uses the conventional system directories for configuration, database, log files, plugins etc, it is possible to do this. Find the line:SYS_PREFIX=${RABBITMQ_HOME}in the sbin/rabbitmq-defaults script and change this line to:SYS_PREFIX=but do not modify any other line in this script.

Note: After this modification the default directory locations may require different permissions. In particular, RABBITMQ_MNESIA_BASE and RABBITMQ_LOG_BASE may need to be created. (The server will attempt to create the permissions at startup.) The RABBITMQ_ENABLED_PLUGINS_FILE will need to be writable (forrabbitmq-plugins). The configuration files are accessed in the/etc/rabbitmq/ directory.

What to do next

  • Start and Stop the Pivotal RabbitMQ Server to ensure that you installed it correctly.
  • Ensure that the RabbitMQ management plugin is enabled by running the following command:

    prompt# cd <rabbitmq_dir>/bin
    prompt# ./rabbitmq-plugins list 
    

    Check that there is an [E] next to rabbitmq_management, which indicates the plugin is enabled, as shown:

    ...
    [E] rabbitmq_management               3.5.[x]
    [e] rabbitmq_management_agent         3.5.[x]
    [E] rabbitmq_management_visualiser    3.5.[x]
    ...
    

    If the management plugin is not enabled, enable it with the following command:

    prompt# ./rabbitmq-plugins enable rabbitmq_management 
    

    Restart the RabbitMQ server for the changes to take effect.

  • To ensure RabbitMQ Server is running, launch the management console in your browser using the following URL:

    http://host:15672 
    

    If your browser is on the same computer as the RabbitMQ server you can use http://localhost:15672.

    Enter the default credentials that were created at installation: user guest and password guest.

    Use the management console to manage exchanges, queues, bindings, virtual hosts, users and permissions.

  • Install the Pivotal RabbitMQ Java Client Libraries.

  • Read the Next Steps section for a high-level roadmap to subsequent tasks.

Ubuntu - Install Pivotal RabbitMQ from the Pivotal Debian Package Repository

It is recommended that you install Pivotal RabbitMQ on a computer running Ubuntu by first installing the Pivotal Debian package repository and then using apt-get to perform the RabbitMQ installation.

Prerequisites

  • Verify that your system meets the supported configurations described in Supported Configurations and System Requirements.
  • Install ErlangInstall Erland.
  • Install the Pivotal Debian package repository that contains the Pivotal RabbitMQ *.deb packages.

    1. On the Ubuntu computer, start a terminal either as the root user or as an unprivileged user who has sudo privileges.
    2. Install the Pivotal Debian package repository using the following wget command:

      Important: Run the entire wget command on a single line. Be sure you include the | sh at the end, or the installation fails.

      prompt# wget -q -O - http://packages.pivotal.io/ | sh  
      

      If necessary, use sudo to run the preceding commands if you are not logged in as the root user. Use the following sudo command:

      prompt$ wget -q -O - packages.pivotal.io/ | sudo sh
      

      The command performs the following tasks:

      • Imports the Pivotal GNU Privacy Guard (GPG) key.
      • Installs the Pivotal Debian package repository.
      • Launches the Pivotal End User License Agreement (EULA) acceptance and repository configuration script.
      • Outputs the EULA for you to read; you must answer yes to accept the terms and continue.
    3. Use the apt-cache search pivotal command to view the list of Pivotal components that you can install from the Pivotal Debian package repository. For example:

      prompt# apt-cache search pivotal
      rabbitmq-server - Pivotal RabbitMQ Server
      pivotal-rabbitmq-java-client-bin - The RabbitMQ Java Client Library
      pivotal-repo-precise - Pivotal EULA and APT repo configuration utility
      
      pivotal-web-server - Pivotal Web Server
      pivotal-web-server-devel - Pivotal Web Server Libraries and Headers
      ...
      

Procedure

  1. From the Ubuntu computer on which you will install Pivotal RabbitMQ, log in as the root user (or as an unprivileged user who has sudo privileges) and start a terminal.
  2. Execute the following apt-get command:

    prompt# apt-get install rabbitmq-server 
    

    The apt-get command begins the install process, resolves dependencies, and displays the packages it will install.

    If necessary, use sudo to run the preceding command if you are not logged in as the root user:

    prompt$ sudo apt-get install rabbitmq-server 
    

What the apt-get install command does

The apt-get install command:

  • Installs Pivotal RabbitMQ into the /opt/pivotal/rabbitmq directory and sets the owner of the directory, along with all child directories and files, to root:root.
  • If the user does not already exist, adds a rabbitmq non-interactive user (in the group rabbitmq). The RabbitMQ server process runs as the rabbitmq user.

    You cannot log in directly as the rabbitmq user because interactive login is disabled.

What to do next

  • Start and Stop the Pivotal RabbitMQ Server to ensure that you installed it correctly.
  • Ensure that the RabbitMQ management plugin is enabled by running the following command:

    prompt# cd /opt/pivotal/rabbitmq/bin
    prompt# ./rabbitmq-plugins list 
    

    Check that there is an [E] next to rabbitmq_management, which indicates the plugin is enabled, as shown:

    ...
    [E] rabbitmq_management               3.5.[x]
    [e] rabbitmq_management_agent         3.5.[x]
    [E] rabbitmq_management_visualiser    3.5.[x]
    ...
    

    If the management plugin is not enabled, enable it with the following command:

    prompt# ./rabbitmq-plugins enable rabbitmq_management 
    

    Restart the RabbitMQ server for the changes to take effect:

    prompt# invoke-rc.d rabbitmq-server restart 
    
  • To ensure RabbitMQ Server is running, launch the management console in your browser using the following URL:

    http://host:15672 
    

    If your browser is on the same computer as the RabbitMQ server you can use http://localhost:15672.

    Enter the default credentials that were created at installation: user guest and password guest.

    Use the management console to manage exchanges, queues, bindings, virtual hosts, users and permissions.

  • Install the Pivotal RabbitMQ Java Client Libraries.

  • Read the Next Steps section for a high-level roadmap to subsequent tasks.

Ubuntu - Start and Stop the RabbitMQ Server

The RabbitMQ server is started as a daemon by default when you first installed the RabbitMQ server package. This section describes how to manually start and stop it.

Prerequisites

Procedure

  1. Log in as the root user (or as an unprivileged user who has sudo privileges) and open a terminal window.
  2. Start the RabbitMQ server using the invoke-rc.d rabbitmq-server command, passing it the start option. For example:

    prompt# invoke-rc.d rabbitmq-server start 
    

    The RabbitMQ server process runs as the rabbitmq user, which is non-interactive.

  3. To stop the server:

    prompt# invoke-rc.d rabbitmq-server stop 
    
  4. To get status about the server (only partial output shown):

    prompt# invoke-rc.d rabbitmq-server status
    Status of node 'rabbit@vmc-ssrc-ub1056' ...
    [{pid,20045},
     {running_applications,
         [{rabbitmq_management,"RabbitMQ Management Console","3.5.[x]"},
          {rabbitmq_web_dispatch,"RabbitMQ Web Dispatcher","3.5.[x]"},
          {webmachine,"webmachine","1.10.3-rmq3.5.[x]-gite9359c7"},
          {mochiweb,"MochiMedia Web Server","2.7.0-rmq3.5.[x]-git680dba8"},
          {rabbitmq_management_agent,"RabbitMQ Management Agent","3.5.[x]"},
          {rabbit,"RabbitMQ","3.5.[x]"},
          {os_mon,"CPO  CXC 138 46","2.2.7"},
          {inets,"INETS  CXC 138 49","5.7.1"},
          {xmerl,"XML parser","1.2.10"},
          {mnesia,"MNESIA  CXC 138 12","4.5"},
          {amqp_client,"RabbitMQ AMQP Client","3.5.[x]"},
          {sasl,"SASL  CXC 138 11","2.1.10"},
          {stdlib,"ERTS  CXC 138 10","1.17.5"},
          {kernel,"ERTS  CXC 138 10","2.14.5"}]},
     {os,{unix,linux}},
     {erlang_version,
         "Erlang R14B04 (erts-5.8.5) [source] [64-bit] [rq:1] [async-threads:30] [kernel-poll:true]\n"},
    ...
    

What to do next

  • You can use the rabbitmqctl command to stop and start the RabbitMQ server, as well as perform a number of other tasks, such as get the status of the server, rotate the logs, and so on. The rabbitmqctl command is located in the /opt/pivotal/rabbitmq/bin directory. Run the command as the root user or as a user with sudo privileges. For example, to get the status of the RabbitMQ server (full output removed for simplicity):

    prompt# cd /opt/pivotal/rabbitmq/bin
    prompt# ./rabbitmqctl status
       Status of node 'rabbit@rhel-5-64-svr' ... 
    

    For complete information about this command, see the rabbitmqctl manual page .

Ubuntu - Install Pivotal RabbitMQ Java Client Libraries from the Pivotal Debian Repository

Pivotal RabbitMQ provides client libraries for Java. The Java client library allows Java code to interface to AMQP servers, such as Pivotal RabbitMQ Server. The library is platform-neutral. The Java client library is distributed as Debian package for Ubuntu computers.

Prerequisites

If you have not already done so, install the Pivotal Debian package repository from which you will install the Java client library. See Install the Pivotal Debian Package Repository.

Procedure

  1. From the Ubuntu computer on which you will install the Java libraries, log in as the root user (or as a user who has sudo privileges) and start a terminal.
  2. Execute the following apt-get command:

    prompt# apt-get install pivotal-rabbitmq-java-client-bin 
    

    The apt-get command begins the install process, resolves dependencies, and displays the packages it will install.

    If necessary, use sudo to run the preceding command if you are not logged in as the root user:

    prompt$ sudo apt-get install pivotal-rabbitmq-java-client-bin 
    

    The apt-get install command installs the Pivotal RabbitMQ Java libraries into the /opt/pivotal/rabbitmq-java-client directory and sets the owner of all the sub-directories and files to root:root.

What to do next

Windows - Install Pivotal RabbitMQ Server

Prerequisites

Procedure

  1. Log in to your Windows computer as the user who will install Pivotal RabbitMQ server.

    Although not required, Pivotal recommends that you install and run Pivotal RabbitMQ as the Administrator user. If you decide not to do this, read Windows Quirks for additional information.

  2. From the Pivotal RabbitMQ product page, click Downloads.

  3. Download the Pivotal RabbitMQ Server for Windows *.exe installer, and save it to your Windows computer.

  4. Launch the Windows installer.

    The installer guides you through the installation process. It is recommended that you accept the default installation options, which include installing RabbitMQ server as a Windows service.

    If the installer finds a previous version of Pivotal RabbitMQ, it prompts you to uninstall it. You must remove the old version if you want to install a newer one. When the uninstall of the old version of RabbitMQ is complete, relaunch the installer to install the new version.

    Warning: Do not install Pivotal RabbitMQ in a Windows path that includes non-ASCII characters. If you do, the server fails to start. This is due to an Erlang limitation.

    The installer program indicates whether the installation was successful.

    By default, the server is installed in the C:\Program Files\rabbitmq directory, C:\Program Files (x86)\rabbitmq on 64-bit computers. The installation process also adds a RabbitMQ Server entry to the Windows Start menu that you can use to control (start, stop) the server and easily view log files, and so on.

  5. Verify that the RabbitMQ service is installed by starting the Windows Services window and searching for RabbitMQ. You can start the Services window by typing services.msc from a Windows command prompt.

    The Services window should show RabbitMQ in a list of services, with Started in the Status column.

  6. To check the status of RabbitMQ server, start a Windows command prompt by selecting All Programs > RabbitMQ Server > Command Prompt (sbin dir) from the Windows Start menu and type the following command:

    prompt> rabbitmqctl status 
    

    You should see something like the following output (truncated for clarity):

    Status of node rabbit@JSHACKELL7 ...
    [{pid,3708},
     {running_applications,
         [{rabbitmq_management,"RabbitMQ Management Console","3.5.[x]"},
          {rabbitmq_web_dispatch,"RabbitMQ Web Dispatcher","3.5.[x]"},
          {webmachine,"webmachine","1.10.3-rmq3.5.[x]-gite9359c7"},
          {mochiweb,"MochiMedia Web Server","2.7.0-rmq3.5.[x]-git680dba8"},
          {rabbitmq_management_agent,"RabbitMQ Management Agent","3.5.[x]"},
          {rabbit,"RabbitMQ","3.5.[x]"},
          {os_mon,"CPO  CXC 138 46","2.2.11"},
          {inets,"INETS  CXC 138 49","5.9.4"},
          {mnesia,"MNESIA  CXC 138 12","4.8"},
          {amqp_client,"RabbitMQ AMQP Client","3.5.[x]"},
          {xmerl,"XML parser","1.3.3"},
          {sasl,"SASL  CXC 138 11","2.3.1"},
          {stdlib,"ERTS  CXC 138 10","1.19.1"},
          {kernel,"ERTS  CXC 138 10","2.16.1"}]},
     {os,{win32,nt}},
     {erlang_version,"Erlang R16B (erts-5.10.1) [smp:4:4] [async-threads:30]\n"},
     {memory,
         [{total,18588080},
          {connection_procs,2792},
          {queue_procs,2792},
    ... 
    

What to do next

  • See Windows: Start and Stop the RabbitMQ Server for additional information about controlling the RabbitMQ server.
  • Ensure that the RabbitMQ management plugin is enabled by selecting All Programs > RabbitMQ Server > Command Prompt (sbin dir) from the Windows Start menu and typing the following command:

    prompt> rabbitmq-plugins list 
    

    Check that there is an [E] next to rabbitmq_management, which indicates the plugin is enabled, as shown:

    ...
    [E] rabbitmq_management               3.5.[x]
    [e] rabbitmq_management_agent         3.5.[x]
    [E] rabbitmq_management_visualiser    3.5.[x]
    ...
    

    If the management plugin is not enabled, enable it with the following command:

    prompt> rabbitmq-plugins enable rabbitmq_management 
    

    Restart the RabbitMQ server for the changes to take effect.

  • To ensure that RabbitMQ Server is running, launch the management console in your browser using the following URL:

    http://host:15672 
    

    If your browser is on the same computer as the RabbitMQ server you can use http://localhost:15672.

    Enter the default credentials that were created at installation: user guest and password guest.

    Use the management console to manage exchanges, queues, bindings, virtual hosts, users and permissions.

  • Install the Pivotal RabbitMQ client libraries.

  • Read the Next Steps section for a high-level roadmap to subsequent tasks.

Windows - Start and Stop the RabbitMQ Server

You must first start the RabbitMQ server to use it. The default configuration for the server is usually adequate to start it.

The Windows Pivotal RabbitMQ installation process installs the server as a Windows service and configures it so that it starts automatically when you start your Windows computer. The install process also added a RabbitMQ Server entry to the Windows Start menu that you use to control (start, stop) the server, easily view the log files, and so on. The installation process also starts a server by default.

Prerequisites

Procedure

  1. Log in to your Windows machine as the user who installed Pivotal RabbitMQ server, such as the Administrator.
  2. From the Windows Start menu, select All Programs > RabbitMQ Server > Start Service to start the RabbitMQ server.

    The service runs in the security context of the system account without requiring a user to be logged in on a console.

    Use the same process for stopping, reinstalling, and removing the service.

What to do next

  • You can also use the rabbitmqctl command to stop and start the RabbitMQ server, as well as perform a number of other tasks, such as get the status of the server, rotate the logs, and so on.

    Run the rabbitmqctl commands from a command prompt that you start from All Programs > RabbitMQ Server > Command Prompt (sbin dir), which automatically opens in the correct directory.

    For example, to get the status of the RabbitMQ server (full output removed for simplicity):

    prompt> rabbitmqctl.bat status
       Status of node 'rabbit@host-E4310' ... 
    

    See the rabbitmqctl manual page for complete information about this command.

  • For information on other RabbitMQ commands such as rabbitmq-plugins and rabbitmq-service, see the manual pages.

Windows - Install Pivotal RabbitMQ Client Libraries

Pivotal RabbitMQ provides client libraries for Java and .NET languages such as C# for Windows platforms.

The Java client library allows Java code to interface to AMQP servers, such as Pivotal RabbitMQ server. The library is platform neutral.

The RabbitMQ .NET client is an implementation of an AMQP client library for C# and other .NET languages. It is also a binding that exposes AMQP services via Microsoft’s Windows Communication Foundation (WCF).

The Pivotal RabbitMQ .NET client libraries include compilations for the following versions of .NET: 2.0 and 3.0.

Prerequisites

  • To compile or run the Pivotal RabbitMQ .NET/C# client library, you need an appropriate .NET SDK or runtime environment available, respectively.

Procedure

  1. From the Pivotal RabbitMQ product page, click Downloads.
  2. Download the Pivotal RabbitMQ client library *.exe installer, and save it to your Windows computer. You can download Java or .NET libraries.
  3. Launch the Windows installer.

    The installer guides you through the installation process. It is recommended that you accept the default installation options.

    The installer program displays whether the installation was successful.

    By default, the client libraries are installed in the following directories, although these might differ in your environment if you did not take the default values during installation:

    • .NET: C:\Program Files\RabbitMQ Clients\dotnet-client-version
    • Java: C:\Program Files\RabbitMQ Clients\java-client-version

    On 64-bit computers, the top-level directory is C:\Program Files (x86).

What to do next

Upgrade Pivotal RabbitMQ

To upgrade a non-clustered Pivotal RabbitMQ server from a previous release to the most current, simply install the new version. All configuration and persistent message data is retained.

To upgrade a clustered Pivotal RabbitMQ server, in the Clustering Guide see “Upgrading Clusters.”

Troubleshooting Installation Problems

RHEL - RabbitMQ Server Does Not Start

Problem: When you first try to start the Pivotal RabbitMQ server on RHEL after installing it, you immediately get an error that the startup FAILED, and you see the following in the /var/log/rabbitmq/startup_log file:

=ERROR REPORT==== 6-Apr-2012::16:08:17 ===
failed to start TCP Listener on [::]:5672 - eaddrinuse (address already in use)

Solution: An existing process (such as Apache Qpid) that is running and listening on port 5672, which is the default AMQP port. You must stop this process before you can start Pivotal RabbitMQ.

For example, if Apache Qpid is running, you can stop it and make sure it does not restart by default:

prompt$ sudo /sbin/service qpidd stop & chkconfig --del qpidd

Check with your system administrator for the specific steps that you should perform on your particular environment.