Install RabbitMQ with RabbitMQ Helper

RabbitMQ and RabbitMQ Helper

RabbitMQ is an important component of Secret Server’s on-premises environment, providing a robust framework for queuing messages between Secret Server and its Distributed Engines. RabbitMQ is an enterprise-ready software package that provides reliability and clustering functionality superior to other applications. RabbitMQ is not a Delinea product and we receive no revenue from it.

We built the Delinea RabbitMQ Helper application to streamline our customers’ RabbitMQ installations. Delinea only supports RabbitMQ/Erlang installations performed using RabbitMQ Helper on the Windows OS.

The Helper provides multiple commandlets that perform the installation/un-installation steps, along with two workflow commandlets named Install-Connector and Uninstall-Connector.

RabbitMQ Helper Prerequisites

The requirements included in the following RabbitMQ Helper Software Download Links are needed to install RabbitMQ Helper.

RabbitMQ Helper Software Download Links

Software	Prerequisite
RabbitMQ Helper (current version)
Microsoft.NET - Windows Server Hosting (current version)	Yes
PowerShell Core (current version)	Yes
ErLang (current version)	No
RabbitMQ Server (current version)	No

Delinea is aware that some AV Scanners have flagged the OpenSSL download as malware. Click here for more information about the Download Win32/Win64 OpenSSL.

Install RabbitMQ and Set Up Site Connector

Check the RabbitMQ installation prerequisites and set up a Site Connector. Click Installing RabbitMQ > Installation in Secret Server.

Install RabbitMQ Helper

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

Choose the most appropriate installation scenario from the four below, but do not run the associated script yet:
Launch the Helper (Delinea.RabbitMq.Helper.exe) from the installation folder %PROGRAMFILES%\Delinea Software Ltd\RabbitMQ Helper\net6.0\Delinea.RabbitMQ.Helper.exe. Delinea.RabbitMq.Helper.exe prepares and runs a Windows PowerShell instance that is pre-configured to use the RabbitMQ Helper PowerShell module.
Run PowerShell cmdlets that apply to your installation needs, or use the most appropriate script from the four choices listed above.

RabbitMQ Helper provides the built-in cmdlet, Install-Connector, which is a prerequisite for installing any of the sample installation scripts. You MUST install RabbitMQ Helper before running any of the scripts. If you choose to use one of the Offline installation scripts, you must first install the script on this page.

After installation, the Helper opens a browser to the RabbitMQ management console, which you can close for now.

Validate the RabbitMQ Helper Installation

Return to Secret Server and go to the site connector you created previously.
Click the site connector link.
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:

Ensure that the RabbitMQ Windows service is running.
Check the logs found under C:\Program Files\Delinea Software Ltd\RabbitMq Site Connector\log.
Check the SS system log for a full error report.

Uninstall RabbitMQ

This command will remove both RabbitMQ and Erlang from the current system. Before running this, if you’re having issues with Rabbit, it’s recommended to look at the troubleshooting section first.

Uninstall RabbitMQ and Erlang

Install-Connector Workflow cmdlet Overview

The overview below is provided for informational purposes in order to explain the process in the Install-Connector cmdlet. Wherever possible, use the Install-Connector commandlet to install Rabbit and not the individual commands below. See example installation sections above.

License prompts and fine-print:

Get-ErlangInstaller - Download the installer for Erlang that it currently supported by Delinea
Get-RabbitMqInstaller - Download the installer for RabbitMQ that it currently supported by Delinea
Uninstall-RabbitMq - Uninstall prior installation (if any) of RabbitMQ and clean up
Uninstall-Erlang - Uninstall prior installation (if any) of Erlang and clean up
Set-ErlangHomeEnvironmentalVariable - Set Erlang and RabbitMQ environmental variables
Install-Erlang - Install Erlang
New-RabbitMqConfigDirectory - Create a custom RabbitMQ configuration directory
Set-RabbitMqBaseEnvironmentalVariable - Set the RabbitMQ BASE environmental variable to the created configuration directory

With TLS:

Convert-CaCerToPem - Convert CA certificate to PEM file format
Convert-PfxToPem - Convert Host PFX to PEM file format
Convert-CngOrEccToPem – Convert CNG or ECC key type certificate to PEM file format
New-RabbitMqTlsConfigFiles - Create RabbitMQ TLS configuration file
Install-RabbitMq - Install RabbitMQ
Copy-ErlangCookieFile - Copy the Erlang system cookie to the current user profile
Assert-RabbitMqIsRunning - Assert RabbitMQ is running
Enable-RabbitMqManagement - Enable RabbitMQ management UI
New-RabbitMqUser - Create a basic user
Grant-RabbitMqUserPermission - Grant permissions to the created user
Assert-RabbitMqConnectivity - Assert the newly create user can connect to RabbitMQ with TLS
Open-RabbitMqManagement - Open the RabbitMQ management UI

Without TLS:

New-RabbitMqNonTlsConfigFiles - Create RabbitMQ non-TLS configuration file
Install-RabbitMq - Install RabbitMQ
Copy-ErlangCookieFile - Copy the Erlang system cookie to the current user profile
Assert-RabbitMqIsRunning - Assert RabbitMQ is running
Enable-RabbitMqManagement - Enable RabbitMQ management UI
New-RabbitMqUser - Create a basic user
Grant-RabbitMqUserPermission - Grant permissions to the created user
Assert-RabbitMqConnectivity - Assert the newly create user can connect to RabbitMQ without TLS
Open-RabbitMqManagement - Open the RabbitMQ management UI

Uninstall RabbitMQ

Using the Uninstall-Connector Workflow cmdlet.

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