Now that Publishing service is deployed, configure and up in Part – 1, the next bit is to install and configure Sitecore publishing service module in Sitecore CM and CD. This part is very simple and strait forward. So lets get started…
The Sitecore publishing module is nothing but Sitecore package and needs to be installed the same way as other Sitecore packages. This package contains all the necessary artifacts for this module to perform it’s job.
The Sitecore Publishing Module can be downloaded from here.
NoteJust check the the version compatibility with Sitecore version where you wanted to implement this publishing service/module. For this you need to navigate to individual release page and check the compatibility detail at start of the page under the main heading.
Install publishing module
To install Sitecore publishing module, one can use OOTB Sitecore installation wizard.
========================================================== ***Important! Copy and save this information*** ========================================================== BEFORE YOU CLICK NEXT: - Ensure you have installed and configured the Sitecore Publishing Service (this module only enables integration with the service) Documentation detailing how to install the service is available seperately. [Warning] This module will not work without a properly configured service instance. No items will be able to be published. AFTER YOU CLOSE THE WIZARD: After the package is installed, follow these steps to complete the Sitecore Publishing Module installation: - Configure the service endpoints: Add a configuration file which overrides the 'PublishingServiceUrlRoot' setting to point to your service module Make sure the address contains a trailing slash e.g. <?xml version="1.0" encoding="utf-8"?> <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"> <sitecore> <settings> <setting name="PublishingServiceUrlRoot">http://sitecore.publishing/</setting> </settings> </sitecore> </configuration> - Configure the Content Delivery Servers: Ensure that the following file is in the website 'App_Config/Modules/PublishingService' directory: * Sitecore.Publishing.Service.Delivery.config Ensure that the following files exist in the website 'bin' directory: * Sitecore.Publishing.Service.dll * Sitecore.Publishing.Service.Abstractions.dll * Sitecore.Publishing.Service.Delivery.dll
NoteJust before installation process starts, installer will prompt the information about configurations and artifacts needed for the Sitecore Module and services to work. As instructed, copy and save that instruction shown in above(From version 3.1.3).
Once installation of the module is successful, in CM perform following steps:
- Navigate to <website root>/App_Config/Modules/PublishingService folder in CM app service
- Open Sitecore.Publishing.Service.config file and search for PublishingServiceUrlRoot setting
- replace http://localhost:5000/ with the URL of the publishing service created in Part – 1 of this series.
NoteMake sure the URL is post-fix with forward slash(/) at the end.
- Navigate to <website root>/App_Config/Modules/PublishingService folder in both the CM and CD app services
- Copy Sitecore.Publishing.Service.Delivery.config file from CM to above folder in CD
- Navigate to <website root>/bin folder in both the CM and CD app services
- Copy below library files to CD’s bin folder from CM
At this point, the publishing will start working, if there is only one default Internet publishing target is there. The Publishing Module has overwritten few of Sitecore default settings for publishing. So after installation of publishing module, one may notice change in UI for the Publishing. Please read here for more details about visual changes and changes in types of publishing.
The last part -3 will cover some specific configuration for Azure PaaS environment and some advance setting of Sitecore Publishing Service. So stay tuned and enjoy content publishing….!!!
Working with Sitecore CMS for more than 10 years now and in total around 14 years of experience working on Microsoft web technologies stack.
Challenges are something which keeps me motivated and moving. I am Sitecore Certified Professional Developer as well as Microsoft Certified Professional Developer. Feel free to hit me up for your Sitecore or web development related queries.