SitecoreDXG Documention
  • SitecoreDXG: The Documentation Experience Generator
  • Overview
    • SitecoreDXG: The Documentation Experience Generator
    • Comparison with SitecoreUML
    • CI/CD Integration
    • Helix Dependency Validation
  • Getting Started
    • Compatibility and System Requirements
    • Installing SitecoreDXG
      • General Installation
        • 1. Install the SitecoreDXG Generation Service
        • 2. Install RabbitMQ
        • 3. Install the SitecoreUML Service for Sitecore
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. Install the Default RabbitMQ Middleman in a Custom Location
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline
      • Developer Installation
        • 1. Install the SitecoreDXG Generation Service for Developers
        • 2. Install RabbitMQ for Developers
        • 3. Install the SitecoreUML Service for Sitecore for Developers
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. (Optional) Install the Default RabbitMQ Middleman for Developers
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline for Developers
    • Upgrading and Downgrading
    • Downloads
    • Using SitecoreDXG
      • Using the Default RabbitMQ Middleman and Trigger
        • Using the DocumentationConfiguration Object
      • Using the Provided AWS S3 Deploy Completion Handler
      • Using the Provided Azure Blob Storage Deploy Completion Handler
  • Architecture
    • Architecture Overview
    • Roles
      • Role Combinations
    • Components
    • Plugins
      • Trigger Plugins
      • Completion Handler Plugins
    • Middlemen
    • Understanding the Default RabbitMQ Middleman and Trigger
  • How To
    • CI/CD Integration
      • Integrating SitecoreDXG into your CI/CD Pipeline
      • Integrating the Default TeamCity RabbitMQ Meta-Runner
    • Creating a Custom Trigger
      • Executing Documentation Generation
      • Executing Meta-Data JSON Generation
    • Slack and Microsoft Teams Integration
      • Integrating with Slack via Webhooks
      • Integrating with Microsoft Teams via Webhooks
    • Creating a Custom Completion Handler
    • Creating a Custom Middleman
    • Viewing Helix Validation Errors
  • About the Generated Documentation
    • Overview
    • Models
      • Template Model
      • Template Field Model
      • Template Folder Model
      • Parent-Child Relationships of Models
      • Inheritance Relationship Model
      • Dependency Relationship Model
    • Views
      • Template View
      • Template Field View
      • Template Folder View
      • Parent-Child Relationship View
      • Inheritance Relationship View
      • Dependency Relationship View
    • Diagrams
      • SitecoreUML Syntax
      • Templates Diagram
      • Template Folders Diagram
      • Layer Diagrams
      • Module Diagrams
      • Module Templates Diagrams
    • Samples
Powered by GitBook
On this page
  • Step 2a: Install RabbitMQ (verified with 3.7.6+)
  • Step 2b: Configure SitecoreDXG to Connect to RabbitMQ
  1. Getting Started
  2. Installing SitecoreDXG
  3. General Installation

2. Install RabbitMQ

Previous1. Install the SitecoreDXG Generation ServiceNext3. Install the SitecoreUML Service for Sitecore

Last updated 6 years ago

The second step in the installation is to install RabbitMQ, keeping in mind that RabbitMQ can be installed on the same machine as other components, on its own dedicated machine, or it can be cloud hosted.

The below documentation assumes that you are installing RabbitMQ on a Windows machine, though you should be able to adapt these instructions to your desired deployment topology, as needed.

Step 2a: Install RabbitMQ (verified with 3.7.6+)

Install RabbitMQ by following the .

Additionally, make sure that if you install RabbitMQ on a server that is reachable by the public domain that you to secure your message queues.

Step 2b: Configure SitecoreDXG to Connect to RabbitMQ

Once you have finished configuring RabbitMQ you should have a working connection string, e.g."amqp://localhost". Be sure that you call the middleman with this connection string.

Next, add a heartbeat parameter to the connection string, e.g."amqp://localhost?heartbeat=60", and update your SitecoreDXG Generation Server's ./settings.js file with the updated connection string value. The heartbeat parameter will help to keep the connection alive. Note that you do not need to call the Middleman with the heartbeat parameter.

Finally, after updating the settings, be sure to go into your Services manager (type services.msc into the Windows Start Menu), find the SitecoreDXG Generation Service in the list and restart it.

RabbitMQ installation documentation
configure the necessary TLS/SSL settings