Installing RabbitMQ with RabbitMQ Helper

Software Downloads and Requirements

The following table lists the download links and versions for each software piece needed to use RabbitMQ Helper.

RabbitMQ Helper Software Downloads
Software and Download Links Additional Notes
RabbitMQ Helper (current version)  
Microsoft.NET - Windows Server Hosting (v7.0 or above) Install .NET before you install RabbitMQ Helper.
PowerShell Core (v7.3.2 or above)

Install PowerShell before you install RabbitMQ Helper.

To install PowerShell Core:

  1. Run the installer.

  2. Accept the terms in the license agreement.

  3. In Optional Actions, select Add PowerShell to Path Environment Variable and click Next.

  4. Click Install and Finish.

ErLang (current version)  
RabbitMQ Server (current version)  

Delinea is aware that some antivirus scanners have flagged the OpenSSL download as malware. For more information, click here.

Installing RabbitMQ and Setting Up a Site Connector

Check the RabbitMQ installation requirements and set up a site connector. To do so, open Secret Serverand navigate to Installing RabbitMQ > Installation.

Installing RabbitMQ Helper

Before installing RabbitMQ Helper, you must set up inbound firewall rules on the computer that is hosting the connector.

To install RabbitMQ Helper

  1. Run the RabbitMQ Helper executable from the installation folder:

    %PROGRAMFILES%\Delinea Software Ltd\RabbitMQ Helper\net6.0\Delinea.RabbitMQ.Helper.exe

    This program prepares and runs a Windows PowerShell instance that is pre-configured to use the RabbitMQ Helper PowerShell module.

  2. Run the Install-Connector cmdlet.

    RabbitMQ Helperr provides the built-in cmdlet, Install-Connector, which is a prerequisite for installing any of the sample installation scripts. You MUST install RabbitMQ Helperr before running any of the scripts.

  3. Depending on your installation scenario, run some PowerShell cmdlets. For details, follow the links below.

    Simple installations (without TLS):

    Advanced installations (with TLS):

    After you complete the installation, RabbitMQ Helper opens a browser window to the RabbitMQ management console. You can close that window for now.

Validating the RabbitMQ Installation

  1. Return to Secret Server and go to the site connector you created previously.

  2. Click the site connector link.

  3. On the Site Connector Details page, click Validate Connectivity.

    If you see Validation Succeeded, everything is set up correctly.

    If you see Validation Failed, do the following:

    1. Ensure that the RabbitMQ Windows service is running.

    2. Check the log files in C:\Program Files\Delinea Software Ltd\RabbitMq Site Connector\log.

    3. Check the Secret Server system log file for a full error report.

Uninstalling RabbitMQ

If you're having issues with RabbitMQ, be sure to review the Troubleshooting section before uninstalling.

To uninstall RabbitMQ and Erlang installations:

  • Run the Uninstall-Connector cmdlet.

    This cmdlet removes both RabbitMQ and Erlang from the system.

To uninstall just Rabbit MQ: run the Uninstall-RabbitMq cmdlet.

To uninstall just Erlang, run the Uninstall-Erlang cmdlet.

About the Install-Connector Cmdlet

The overview below is provided for informational purposes in order to explain the process in the Install-Connector cmdlet. Wherever possible, use the Install-Connectorcmdlet to install RabbitMQ and not the individual commands available.

  • 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 PEM file format
  • Convert-PfxToPem- Converts a Host PFX to PEM file format
  • Convert-CngOrEccToPem –Converts a CNG or ECC key type certificate to 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- Creatse 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.

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- Assert the newly create user can connect to RabbitMQ without TLS
  • Delete-RabbitMqUser-Deletes a default Admin('guest') in RabbitMQ

At the end of the successful installation, you must create an Admin User to access the RabbitMQ Management UI.

Uninstall RabbitMQ

Uninstall-Connector Workflow cmdlet takes care of the Erlang and RabbitMQ uninstallation. The Uninstall-Connector Workflow executes a series of sequential steps, outlined below, to uninstall Erlang and RabbitMQ:

  • Uninstall-RabbitMq-Uninstall prior installation (if any) of RabbitMQ and clean up

  • Uninstall-Erlang - Uninstall prior installation (if any) of Erlang and clean up