Step-by-Step Publishing Service Configuration

 In the previous blog, I have explained the overview of Publishing Service.

Here is the detailed blog on overview of publishing service.

Making Sitecore Publishing Service work has 2 part.

1. Installing and Configuring Sitecore Publishing Service
This installs SPS as a .Net core based service that runs on IIS and does the real job of publishing.

2. Installing and configuring Sitecore Publishing Module
This module will integrate SPS with our Sitecore Client. So that publishing operations can be done from there.

Note: Sitecore Publishing Service – compatibility tables 

Installing and Configuring Sitecore Publishing Service

To install the Sitecore Publishing Service manually:

  1. Download the Sitecore Publishing Service package from the Sitecore Downloads  page .

  2. Extract the contents of the archive to a folder of your choice. For example: C:\inetpub\wwwroot\sitecorepublishing

  3. In IIS, create a new site pointing to the folder.

  4. Start the IIS Manager and in the Connections panel, expand Sites. Right-click Sites and then click Add Website.

  5. In the Add Website dialog, fill in the required fields.

  6. In the IIS Manager, right-click the application pool for the website that you created, and then click Basic Settings.

  7. In the Edit Application Pool dialog, in the .NET CLR version field, select No Managed Code                                                 Note: The Application Pool user must have Read, Execute, and Write permissions to the site’s physical path.

  8. In the IIS Manager, right-click the application pool for the website that you created, and then click Advanced Settings.

  9. In the Advanced Settings dialog, in the Idle Time-out (minutes) field, enter 0.

  10. Configure the core, master, web, and service connection strings for the service along with any additional configuration values.Under your root folder for publisingservice, go to config/global folder, duplicate sc.global.xml.example, remove .example from its host name. And make sure it has entries for the connectionstrings for your sitecore instance. See below –

  11. To upgrade the database schema, run the schema upgrade command from the extracted folder: Sitecore.Framework.Publishing.Host.exe schema upgrade --force. This updates schema of your DBs to support Sitecore Publishing service. You should see below if command ran properly.



  12. To access your website, enter http://<sitename>/api/publishing/operations/status in your browser.
    If you receive a value of { "status" : 0, “statusType”: “Ok” }, the application is installed correctly. If you receive any other value, check the application logs for further details.


Installing and configuring Sitecore Publishing Module

  1. Install the SPM package into Sitecore client by downloading from here 

  2. Go to C:\inetpub\wwwroot{Your sitecore site}\App_Config\Modules\PublishingService, and update PublishingServiceUrlRoot with http://sitecore.publishing/ 

  3.  Done. Now Its good to use Sitecore Publishing service.

  4. We can see the new Publishing icon in Launchpad.


  • If we click on it, it will open publishing dashboard.


Configuring Cache Clearing and Indexing

    The Sitecore.Publishing.Service.Delivery.config is responsible for raising events to rebuild the search indexes and clear data caches on the target instance.
If additional custom indexes have been created on a Sitecore instance, each index name must be added to the publishingservice:searchindex.rebuild setting in the IndexNames section.


All these steps will provide the complete configuration of publishing service in Sitecore.

Happy Publishing 😀😀


Comments