Installing RabbitMQ with RabbitMQ Helper

This documentation provides information about the different types of RabbitMQ and Helper installations, the usage of a Site Connector, and the validation for the RabbitMQ product.

Software Downloads and Requirements

The following table lists the download links and versions for each software element required to use the RabbitMQ Helper correctly.

Delinea is aware that certain anti-virus scanners have flagged the OpenSSL download as malware. For more information, click here. Before installing RabbitMQ Helper, you must set up inbound firewall rules on the computer that is hosting the connector.

To view the compatible versions of the RabbitMQ-related applications, see the Compatibility Matrix

Starting from v11.0.0.0, RabbitMQ Helper introduces a new installation method via a guided user interface. The installation supports all types of Online and Offline installations for TLS and non-TLS configurations.

RabbitMQ Helper Software Downloads
Software and Download Links Additional Notes

RabbitMQ Helper

(current version)

You can install RabbitMQ Helper 11.1 by double-clicking the installer.

To install RabbitMQ Helper for version 10.5.0.0 and above from a command line:

  1. Run the cmd as an administrator.

  2. Run on cmd: cd <helper-installer-directory>.

  3. Run on cmd:
    msiexec /i Delinea.RabbitMq.Helper.xx.x.x.x.msi /l*v install.log

Starting from version 10.2.0.0 the -UseDelineaMirror switch is now –UseNonMirror. This change happened because commands use Delinea download mirror links as the default.
Microsoft.NET Desktop Runtime (v6.0 or above) Installation of the RabbitMQ Helper v.11.0.0 requires Microsoft.NET Desktop Runtime (v6.0 or above) to run the User Interface.
Microsoft.NET - Windows Server Hosting (v7.0 or above) We recommend installing .NET before you install RabbitMQ Helper.
PowerShell Core (v7.3.2 or above)

Install PowerShell 7 before performing the RabbitMQ Helper installation. To install the PowerShell Core:

  1. Run the installer.

  2. Accept the terms in the license agreement.

  3. Select Install and Finish.
ErLang (current version)  
RabbitMQ Server (current version)  

Installing RabbitMQ and Setting Up a Site Connector

A Site Connector is a combination of Erlang and RabbitMQ. To view the installation requirements for setting up a site connector, see RabbitMQ Secret Server documentation.

Downloading Installers using RabbitMQ Helper

To download the Erlang and RabbitMQ Installers using the RabbitMQ Helper, run the following commands (recommended):

Copy 
Get-ErlangInstaller -Verbose 
Get-RabbitMqInstaller -Verbose 

Alternatively, you can download the installers using official CND mirrors:

Copy 
Get-ErlangInstaller -UseNonMirror -Verbose 
Get-RabbitMqInstaller –UseNonMirror -Verbose

Installing RabbitMQ Helper via command line

To install RabbitMQ Helper for v10.5.0.0 and above:

  1. Run the cmd prompt as an administrator.

  2. Switch to the directory where the .msi file exists using the cd <helper-msi-directory-path> command.

  3. Run the msiexec / i Delinea.RabbitMq.Helper.10.6.0.0.msi /l*v install.log command.

    Change the name of the .msi file as per the requirements outlined for your version.

To install RabbitMQ Helper for v10.4.2.0 and below:

  1. Double-click the RabbitMQ Helper Installer (Delinea.RabbitMq.Helper.xx.xx.xx.xx.msi).

  2. Once completed, the Installer window closes, and you can check for Delinea RabbitMQ Helper in the App drawer.

Installing RabbitMQ via the command line

Depending on your installation scenario, certain PowerShell cmdlets need to be run. For details, follow the links below to select what type of installation you need and its relevant cmdlets.

Validating the RabbitMQ Installation

After successfully installing RabbitMQ, the next step is to validate the RabbitMQ Helper installation.

Use the following commands in the RabbitMQ Helper PowerShell window:

  1. Assert-RabbitMqConnectivity—Validates the connectivity to RabbitMQ.

  2. Assert-RabbitMqIsRunning—Validates that RabbitMQ is running on the current host.

If the command executes successfully without producing any output, this indicates a successful operation.

About the Install-Connector Cmdlet

The table below lists the commands to process in the Install-Connector cmdlet. Use the Install-Connector cmdlet to install RabbitMQ and not the individual commands available.

Install-Connector Cmdlet commands
Command Description
Get-ErlangInstaller Downloads the currently supported Erlang installer.
Get-RabbitMqInstaller Downloads the currently supported RabbitMQ installer.
Uninstall-RabbitMq

Uninstalls the previous RabbitMQ installation.
Uninstall-Erlang Uninstalls the previous Erlang installation.
Set-ErlangHomeEnvironmentalVariable Sets the Erlang and RabbitMQ environmental variables.
Install-Erlang Installs Erlang.
New-RabbitMqConfigDirectory Creates a custom RabbitMQ configuration directory.
Set-RabbitMqBaseEnvironmentalVariable
  • Sets the RabbitMQ BASE environment variable to the created configuration directory.
    		•
    With TLS
    Convert-CaCerToPem Converts a CA certificate to the PEM file format.
    Convert-PfxToPem Converts a Host PFX to the PEM file format.
    Convert-CngOrEccToPem Converts a CNG or ECC key type certificate to the PEM file format.
    New-RabbitMqTlsConfigFiles Creates a RabbitMQ TLS configuration file.
    Install-RabbitMq Installs RabbitMQ.
    Copy-ErlangCookieFile Copies the Erlang system cookie to the current user profile.
    Assert-RabbitMqIsRunning Verifies that RabbitMQ is running.
    Enable-RabbitMqManagement Enables the RabbitMQ management UI.
    New-RabbitMqUser Creates a basic user.
    Grant-RabbitMqUserPermission Grants permissions to the created user.
    Assert-RabbitMqConnectivity Verifies that the newly created user can connect to RabbitMQ with TLS.
    Delete-RabbitMqUser
  • Deletes a default Admin(guest) in RabbitMQ.
    		•
    Create RabbitMQ Management Admin Creates an Admin User for RabbitMQ Management UI access and for running commands that need Admin access.
    Enable-RabbitMqFeatureFlags

    Enables all the stable feature flags in RabbitMQ. 

    All feature flags will eventually become mandatory. For example, RabbitMQ 3.12 requires enabling feature flags introduced in the 3.11 series before the upgrade, RabbitMQ 3.11 graduates all 3.8 flags, and so on. 
    Without TLS
    New-RabbitMqNonTlsConfigFiles Creates a RabbitMQ non-TLS configuration file.
    Install-RabbitMq Installs RabbitMQ.
    Copy-ErlangCookieFile Copies the Erlang system cookie to the current user profile.
    Assert-RabbitMqIsRunning Verifies that RabbitMQ is running.
    Enable-RabbitMqManagement Enables the RabbitMQ management UI.
    New-RabbitMqUser Creates a basic user.
    Grant-RabbitMqUserPermission Grants permissions to the created user.
    Assert-RabbitMqConnectivity

    Asserts that the newly created user can connect to RabbitMQ without TLS.
    Delete-RabbitMqUser Deletes a default Admin(guest) in RabbitMQ.
    Create RabbitMQ Management Admin Creates an Admin User for RabbitMQ Management UI access and for running commands that need Admin access.
    Enable-RabbitMqFeatureFlags

    Enables all the stable feature flags in RabbitMQ.

    All feature flags will eventually become mandatory. For example, RabbitMQ 3.12 requires enabling feature flags introduced in the 3.11 series before the upgrade, RabbitMQ 3.11 graduates all 3.8 flags, and so on. 

    After a successful installation, you must create an Admin User to access RabbitMQ Management. Therefore, the Install-Connector command process now includes a provision to add an Admin User.