Skip to main content

Sitecore module reference

Abstract

Describes the modules Sitecore makes available as Docker asset images.

This topic describes the Sitecore modules that are available as Docker asset images and the Sitecore runtime Dockerfile instructions that you must include for each role when you build custom images. For a more detailed explanation of Sitecore module images and how they are included, refer to this topic on how to add Sitecore modules, which includes the Sitecore PowerShell Extensions (SPE) and Sitecore Experience Accelerator (SXA) modules.

There is a list of available module asset images and tags on the Sitecore Docker Images repository on GitHub.

Image repository

  • scr.sitecore.com/sxp/modules/sitecore-spe-assets

Dockerfile instructions

  • mssql-init:

    # escape=`
    
    ARG BASE_IMAGE
    ARG SPE_RESOURCES_IMAGE
    
    FROM ${SPE_RESOURCES_IMAGE} AS spe_resources
    
    FROM ${BASE_IMAGE} AS spe
    
    SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]
    
    COPY --from=spe_resources C:\module\db C:\resources\spe
  • cm:

    COPY --from=<spe_image> C:\module\cm\content C:\inetpub\wwwroot

Image repository

  • scr.sitecore.com/sxp/modules/sitecore-sxa-xm1-assets

  • scr.sitecore.com/sxp/modules/sitecore-sxa-xp1-assets

Dockerfile instructions

  • solr-init:

    COPY --from=<sxa_image> C:\module\solr\cores-sxa.json C:\data\cores-sxa.json
    
  • cd:

    COPY --from=<sxa_image> C:\module\cd\content C:\inetpub\wwwroot
    COPY --from=<sxa_image> C:\module\tools C:\module\tools
    RUN C:\module\tools\Initialize-Content.ps1 -TargetPath C:\inetpub\wwwroot; `
      Remove-Item -Path C:\module -Recurse -Force;
  • cm:

    COPY --from=<sxa_image> C:\module\cm\content C:\inetpub\wwwroot
    COPY --from=<sxa_image> C:\module\tools C:\module\tools
    RUN C:\module\tools\Initialize-Content.ps1 -TargetPath C:\inetpub\wwwroot; `
      Remove-Item -Path C:\module -Recurse -Force;

Image repository

Headless Services v14, v15:

  • scr.sitecore.com/sxp/modules/jss-xm1-assets

  • scr.sitecore.com/sxp/modules/jss-xp1-assets

Headless Services v16+:

  • scr.sitecore.com/sxp/modules/sitecore-headless-services-xm1-assets

  • scr.sitecore.com/sxp/modules/sitecore-headless-services-xp1-assets

Dockerfile instructions

  • mssql-init:

    COPY --from=<headless_services_image> C:\module\db C:\jss_data
    
  • cd:

    COPY --from=<headless_services_image> C:\module\cd\content C:\inetpub\wwwroot
    COPY --from=<headless_services_image> C:\module\tools C:\module\tools
    RUN C:\module\tools\Initialize-Content.ps1 -TargetPath C:\inetpub\wwwroot; `
      Remove-Item -Path C:\module -Recurse -Force;
  • cm:

    COPY --from=<headless_services_image> C:\module\cm\content C:\inetpub\wwwroot
    COPY --from=<headless_services_image> C:\module\tools C:\module\tools
    RUN C:\module\tools\Initialize-Content.ps1 -TargetPath C:\inetpub\wwwroot; `
      Remove-Item -Path C:\module -Recurse -Force;

Image repository

  • scr.sitecore.com/sxp/modules/sitecore-management-services-xm1-assets

  • scr.sitecore.com/sxp/modules/sitecore-management-services-xp1-assets

Dockerfile instructions

  • cm:

    COPY --from=<management_services_image> C:\module\cm\content C:\inetpub\wwwroot

Image repository

  • scr.sitecore.com/sxp/modules/horizon-integration-xm1-assets

  • scr.sitecore.com/sxp/modules/horizon-integration-xp0-assets

  • scr.sitecore.com/sxp/modules/horizon-integration-xp1-assets

Dockerfile instructions

  • cm:

    COPY --from=<horizon_image> C:\module\cm\content C:\inetpub\wwwroot

Image repository

  • scr.sitecore.com/sxp/modules/dds-xp1-assets

Dockerfile instructions

  • cm:

    COPY --from= <dds_asset_image>
    C:\module\cm\content C:\inetpub\wwwroot
    
    COPY --from=<dds_asset_image>
    C:\module\tools C:\module\tools
    
    COPY --from=<sitecore-docker-tools-assets> C:\tools C:\module\tools 
    
    RUN C:\module\tools\Initialize-Content.ps1
    -TargetPath C:\inetpub\wwwroot; `
    
        Remove-Item -Path C:\module -Recurse
    -Force;
  • Dedicated Dispatch Server (DDS)

    COPY --from=<dds_asset_image>
    C:\module\dds\content C:\inetpub\wwwroot
    
    COPY --from=<dds_asset_image>
    C:\module\tools C:\module\tools
    
    COPY --from=<sitecore-docker-tools-assets> C:\tools C:\module\tools 
    
    RUN C:\module\tools\Initialize-Content.ps1
    -TargetPath C:\inetpub\wwwroot; `
    
        Remove-Item -Path C:\module
    -Recurse -Force;

Image repository

scr.sitecore.com/sxp/modules/sps-assets

Dockerfile instructions

  • CD:

    COPY --from=<sps_image> 
    C:\module\cd\content C:\inetpub\wwwroot 

    If you are running Sitecore Publishing Service 7.0, and you are using Sitecore 10.2 or earlier, or upgrading to Sitecore 10.3, run this command to enable multiple link support:

    RUN Remove-Item -Path
    C:\inetpub\wwwroot\App_Config\Modules\PublishingService\Sitecore.Publishing.Service.SingleLinkDatabase.config
    -Force; 
    
  • CM:

    COPY --from=<sps_image>
    C:\module\cm\content C:\inetpub\wwwroot 

    If you are running Sitecore Publishing Service 7.0, and you are using Sitecore 10.2 or earlier, or upgrading to Sitecore 10.3, run this command to enable multiple link support:

    RUN Remove-Item -Path
    C:\inetpub\wwwroot\App_Config\Modules\PublishingService\Sitecore.Publishing.Service.SingleLinkDatabase.config
    -Force;