SitecoreDXG Documention
OverviewGetting StartedDownloadsGitHub Repository
Search…
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
Upgrading and Downgrading
Downloads
Using SitecoreDXG
Architecture
Architecture Overview
Roles
Components
Plugins
Middlemen
Understanding the Default RabbitMQ Middleman and Trigger
How To
CI/CD Integration
Creating a Custom Trigger
Slack and Microsoft Teams Integration
Creating a Custom Completion Handler
Creating a Custom Middleman
Viewing Helix Validation Errors
About the Generated Documentation
Overview
Models
Views
Diagrams
Samples
Powered By GitBook
General Installation
This section will walk you through the process of installing SitecoreDXG using the out of the box components provided with the software.
One of the things that should be noted about the default setup of SitecoreDXG using RabbitMQ is that not all of the components need to be installed together on the same machine. For example, the SitecoreDXG Generation Service can be on one server, while RabbitMQ is on another (or cloud hosted) and the middleman is on yet another server.
With that in mind, the following instructions will guide you through the installation.

Installation Steps

    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​
Getting Started - Previous
Installing SitecoreDXG
Next
1. Install the SitecoreDXG Generation Service
Last modified 2yr ago
Copy link
Contents
Installation Steps