1. Install the SitecoreDXG Generation Service for Developers

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.


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

Step 1a: (Optional) Install the node-canvas dependencies

Installing the dependencies for the SitecoreDXG Generation Service is optional, as they are included in the installation package. Howevere, if you are going to be making changes to the SitecoreDXG Generation Service and customizing anything related to the way that it renders objects then it is recommended that you install node-canvas yourself. This will also become necessary if you delete your ./app/node_modules folder. Unfortunatly, the node-canvas dependencies cannot be installed through a simplenpm install. Instead, the easiest way to install the node-canvas dependencies is as follows:

  1. Install node.js (verified with 6.11.4+)

  2. Install chocolatey (verified with 0.10.8+)

  3. Use chocolatey to install the rest of the dependencies

    • See below for important notes about installing the dependencies with Chocolatey

    • Be sure to adhere to the notes in the below and the installation instructions for node-canvas exactly

    • If you run into installation issues, please see the "Common installation issues and solutions" section, below, and the installation instructions for node-canvas before reaching out to me directly. If you are still unable to find the solution, reach out to me via Sitecore Community Slack (@zachary_kniebel) and I will be happy to help.

  4. Manually download GTK and unzip it to the path specified in the node-canvas documentation

Important notes about the chocolatey installation

As part of the chocolatey dependency installation, it will try to install the Standalone VS2015 Build Tools: Microsoft Build Tools 2015 Update 3 (note that this is not the same as the "Microsoft Visual C++ 2015 Redistributable Update 3"). However, if you have VS2015 already installed then this may not work. If that is the case, you will need to modify your installation and enable the C++ build tools. Note also that it MUST be VS2015 due to the expected folder path - VS2017 will not work, but you can have VS2017 installed side-by-side with VS2015 and/or the VS2015 build tools.

Once the build tools have been installed, you can easily install the rest with chocolatey, or you can install them manually. Instructions for installing the rest of the dependencies with chocolatey or manually can be found on the Installation page of the node-canvas wiki. When installing the rest of the dependencies, if you have any issues with the Visual C++ part (CL.exe errors) see this issue.

Lastly, don't forget about the Cairo installation. Even though Cairo is bundled with GTK, which will be installed by chocolatey, you still need to manually download and unzip it to C:\GTK.

Common installation issues and solutions

If you installed your dependencies with chocolatey and/or used the standalone VS 2015 build tools installer then you may need to do one or both of the following:

  • Run npm config set msvs_version 2015 --globalbefore trying to install node-canvas to avoid "The tools version "2.0" is unrecognized. Available tools versions are..." errors

  • Install the VS 2015 Build Tools from the 8.1 SDK (do this only if you have issues with missing paths, as the SDK is very big)

Step 1b: Install the SitecoreDXG Generation Service

Once you have installed all of the node-canvas dependencies in Step 1a, follow the instructions below to install the SitecoreDXG Generation Service on your machine:

  1. Download the SitecoreDXG-Dev-<version>.<build>.zip to your machine and extract in a location of your choosing. Note that it does not matter where you unzip and store the SitecoreDXG folder, but the location you choose will be the parent of your installation directory. The actual installation directory will be the ./app directory.

  2. In the extracted installation folder, cd ./app and runnpm install.

    • If you see any Node-Canvas, Cairo, GTK, C++, MSBuild, or file path issues then refer back to the instructions for installing the dependencies in Step 1a

    • If the issue persists, attempt to run npm install node-canvas --global. If the command is successful, attempt to run npm installin the folder again. Otherwise, or if the npm installfails with a new error then refer back to the Step 1a (dependency installation).

    • If the issue continues, reach out to me over Sitecore Community Slack (@zachary_kniebel) for further assistance.

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

  4. Install the SitecoreDXG Generation Service as a Windows Service by running the following command as an administrator in the installation's app folder: 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 instead

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

  5. 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 for errors or try starting the application manually from the command-line for troubleshooting

  6. (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, this article 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 ./app/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.

Last updated