Create a headless tenant and site

Current version: 10.3

The Sitecore JavaScript Rendering SDKs (JSS) lets front-end developers build a JavaScript app on top of Sitecore. With the Sitecore Headless Services, you can create headless tenants and sites that make it easier to work with JSS apps. The headless tenants and sites help you scaffold your site and help you to import your JSS app in a structured way.

The SXA content architecture includes tenants and sites. SXA supports multitenancy, which means that you can run multiple sites on a single instance of Sitecore. Each tenant can include multiple related sites, for example, to support multiple brands for a single company or multiple languages or locations for a single brand. Organizations can support multiple languages through one-to-one translated versions or use a model with a separate site for each supported language.

For example, an international clothing company could have different tenants for the different brands of clothing and different sites for the specific countries.

Create a headless tenant

If you have multiple sites that need to share resources they must be created within one tenant. With SXA's multitenant architecture, you can provide each tenant a dedicated share of the Sitecore instance including its data templates, configuration, user management, tenant individual functionality, and non-functional properties. 

To create a headless tenant:

  1. In the Content Editor, right-click the Content item in the content tree, click Insert, and then click Headless Tenant.

  2. In the wizard, enter a name for the tenant, select the modules, and click OK.

Create a headless site

The tenant is a top-level container for the sites underneath. Sites in the same tenant are related, for example, because they share the same set of templates or part of the media library. Sites are the items that represent the website and consist of pages, data, designs, and partial layouts.

To create a headless site:

  1. In the Content Editor, right-click the tenant to which you want to add the site, click Insert , and then click Headless Site.

  2. In the wizard, on the General tab, enter the name for the site.

    Important

    SXA site names cannot contain blank spaces.

  3. Optionally, specify a host name, a virtual folder, and select the language for your site.

  4. On the Modules tab, select the modules you need.

  5. On the Settings tab, you can enter GraphQL end point and deployment secret, but it is best practice to do it later.

  6. Click OK to create the headless site. The following site structure is created:

    Folder

    Subfolder

    Description

    Home

    Contains the site pages.

    Media

    Includes all the media items available for the site.

    Data

    Contains the data sources that can be reused across multiple pages within the website.

    Dictionary

    Multilingual apps need a dictionary of static phrases that require translation. JSS imports translations to this folder.

    Presentation

    Page Designs

    Headless sites come with SXA page design functionality.

    Partial Designs

    Headless sites come with SXA partial design functionality.

    Placeholder Settings

    Headless sites come with SXA placeholder settings functionality.

    Settings

    Contains the default configuration items that make the app work. Customization is possible. For example, if you want to use a new template for your pages.

    Site Grouping

    SXA lets you define sites using the Site Grouping items. Contains all the data needed for the site definition such as the host name, the start item, and the virtual folder.

    By default, SXA headless sites use live mode. In live mode, Sitecore reads the website content from the master database.

    SXA headless live mode.

    If you want switch to the web database, you must publish both the API keys and the SXA headless site.

  7. Next step: When you have finished creating your headless tenant and site, you can import classic JSS apps.

Note

You can create a duplicate of a site, by using the clone script.

Do you have some feedback for us?

If you have suggestions for improving this article,