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
  • Sitecore Compatibility
  • Versions
  • Deployment Models
  • System Requirements
  • SitecoreDXG Generation Service
  • SitecoreDXG RabbitMQ Middleman
  • SitecoreDXG TeamCity RabbitMQ Middleman Runner
  • RabbitMQ
  1. Getting Started

Compatibility and System Requirements

PreviousHelix Dependency ValidationNextInstalling SitecoreDXG

Last updated 6 years ago

The following compatibility and system requirements must be satisfied in order to run SitecoreDXG.

Sitecore Compatibility

Technically, SitecoreDXG integrates with the , rather than implementing directly with Sitecore itself. However, as SitecoreDXG is a member of the SitecoreUML family, this section describes its compatibility with the available Sitecore versions and deployment models.

Versions

The below are the versions of Sitecore that SitecoreDXG is compatible with:

  • Sitecore 7.2+ (not tested with earlier versions, but may work)

  • Sitecore 8+

  • Sitecore 9+

Deployment Models

SitecoreDXG is compatible with the following Sitecore deployment models:

  • PaaS (Platform as a Service)

  • IaaS (Infrastructure as a Service)

  • On-Premises

System Requirements

This section describes the system requirements of SitecoreDXG infrastructure.

SitecoreDXG Generation Service

The SitecoreDXG Generation Service requires the following minimum specifications:

  • 1x CPU Core 2 GHz

  • 2+ GB RAM (8 GB recommended)

  • 1+ GB Storage (20 GB recommended)

  • Windows (any version supported by node.js)

  • Can be cloud-hosted via IaaS,

SitecoreDXG RabbitMQ Middleman

The SitecoreDXG RabbitMQ Middleman requires the following minimum specifications:

  • Any Windows, Linux or Mac OS supported by node.js (tested with Windows only)

SitecoreDXG TeamCity RabbitMQ Middleman Runner

The SitecoreDXG TeamCity RabbitMQ Middleman Runner requires the following minimum specifications:

  • Windows-based agent compatible with SitecoreDXG RabbitMQ Middleman

RabbitMQ

In addition to the minimum specifications required by , the following minimum specifications must be met:

Any deployment of RabbitMQ is supported, including on-premises, IaaS (infrastructure as a service) and SaaS (software as a service; e.g. )

SitecoreUML Service for Sitecore
RabbitMQ
CloudAMQP