Installing Headless Services

Abstract

Installation prerequisites and methods for the Headless Services module.

To enable editing and server-side rendering with Sitecore Headless Services, you must meet the following requirements:

  • 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. Customers upgrading to 10.2 can contact their account manager to obtain a license that includes Headless Services. To check if your license is a Headless Services-enabled license, open your license.xml file in a text editor and search for Sitecore.JSS. If your license does not include Headless Services and:

    • You are a partner - recently updated partner licenses should already have the key that enables Headless Services. If you do not have the endorsement, you can request a new partner license on SPN or contact your Sitecore Partner Manager.

    • You are a customer - if you do not have a Headless Services license, please contact your Sitecore Account Manager, request a temp license for short-term needs, and discuss migration to a Headless Services license.

Installation methods

The method of installing Sitecore Headless Services depends on your deployment architecture.

You can install Sitecore Headless Services: