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
  • Prerequisites
  • Install the SitecoreDXG Generation Service
  • Important Note on When to Restart the SitecoreDXG Service
  1. Getting Started
  2. Installing SitecoreDXG
  3. General Installation

1. Install the SitecoreDXG Generation Service

PreviousGeneral InstallationNext2. Install RabbitMQ

Last updated 6 years ago

The first step in installing SitecoreDXG is installing the Generation Service on the desired machine, keeping in mind that the SitecoreDXG Generation Service does not have to be installed on the same machine as the RabbitMQ server, the middleman or the Sitecore instance.

Prerequisites

The installation instructions for the SitecoreDXG Generation Service assume that you have and installed on the target machine prior to beginning the installation.

Install the SitecoreDXG Generation Service

Once you have installed all of prerequisites installed, follow the instructions below to install the SitecoreDXG Generation Service on your machine:

  1. Download the to your machine and extract in a location of your choosing. Note that it does not matter where you store it, and that the resulting directory will be your installation directory for the SitecoreDXG Generation Service.

  2. (Optional) Open the ./settings.js file and confirm or update the settings (documented inline) as needed

  3. Install the SitecoreDXG Generation Service as a Windows Service by running the following command as an administrator in the installation directory: npm run-script install-windows-service.

    • Note that you can skip this step if you want to start the SitecoreDXG Generation Service manually from the command-line/PowerShell instead

    • Note that to uninstall the SitecoreDXG Generation Service, you can use the command npm run-script uninstall-windows-service

  4. Go to the Services manager and ensure that the SitecoreDXG Generation Service is started

    • If it is started then feel free to customize startup and account settings for the service as desired

    • If it is not, check your SitecoreDXG logs (stored in C:/SitecoreDXG/Logs by default, or in a custom location of your choosing if you have specified a different path in your ./Settings.js file) for errors or try starting the application manually from the command-line for troubleshooting

  5. (Optional) Because SitecoreDXG doesn't automatically delete old output or log files, it is suggested that you set up a custom Windows scheduled task or something similar to perform the cleanup, in order to avoid your server running out of storage space. If you would like to set up a custom Windows scheduled task, can help to guide you through the process. Note that you can find the location of your logs and work directories by looking at your ./settings.js file (the default paths are C:/SitecoreDXG/Work and C:/SitecoreDXG/Logs).

Important Note on When to Restart the SitecoreDXG Service

Anytime you change the ./settings.js file you should restart your SitecoreDXG Generation Service. Some settings are okay to change without restarting the service, but most are not and the safest thing to do is restart the service.

node.js
npm
SitecoreDXG-Generation-Service-<version>.<build>.zip
this article