Install Sitecore headless rendering services
- Sridharan Padmanabhan
- Nov 27, 2024
- 1 min read
Updated: Dec 13, 2024
Prerequisites
A running Sitecore instance with a valid license
In order to be able to implement server-side rendering using Sitecore headless renderings, following requirements must be met -
Sitecore 9.0 Update-1 or later - note that to use some JavaScript Rendering SDKs, such as Next.js, you must have Sitecore 10.0 or later.
Sitecore Headless Services license - for Sitecore 10.2 and later, this license is included in subscription licenses. For perpetual licenses, the Headless Services license can be purchased as an add-on.
Official information at Installing Headless Services | Sitecore Documentation
Installing the Sitecore headless rendering
Download the package from this official download page, make sure to download the right version of the headless rendering with respect to your Sitecore version.
On your Sitecore, go to Start > Development tools > Installation wizard
Upload and install the package.
This package will install DLLs, config files, and Sitecore items etc., needed to render the Sitecore item layouts as JSON through the Layout service APIs
NOTE: For Sitecore 9.0.x only (not 9.1), in your /Web.config file, alter the binding redirect for Newtonsoft.Json:
<dependentAssembly> <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" />
<!-- change the oldVersion from 9.0.0.0 to 11.0.0.0. Leave newVersion alone (do not make it 11.0). -->
<bindingRedirect oldVersion="0.0.0.0-11.0.0.0" newVersion="9.0.0.0" /></dependentAssembly>Refer official documentation here for additional information - Install Headless Services using the package .zip file | Sitecore Documentation
Creating Sitecore API Key
Sitecore API key would be needed to authorize layout service requests from the JSS app while connecting and consuming data from Sitecore.
Right-click and insert an "API key" under /sitecore/system/Settings/Services/API Keys in the Sitecore content tree.
The item ID of this item would be the Sitecore API Key while connecting the JS app to Sitecore.
Comments