Install Sitecore XP Single Developer (XP0) using SIF

Version: 10.5

This chapter describes how to install Sitecore XP Single Developer (XP0) on a single computer using Sitecore Installation Framework (SIF).

For information about how to use the Sitecore Install Assistant, see Installing Sitecore XP with the Sitecore Install Assistant.

The Sitecore installation is a combination of .json configuration files and Web Deploy Packages (WDPs).

You can download the relevant SIF configuration files and the WDPs for each of the topologies from the Sitecore Downloads page.

SIF uses the .json configuration files to configure the environment and uses the WDP packages to install the application and databases.

XP Single Developer (XP0) topology

The predefined XP Single Developer topology configures:

  • A Sitecore stand-alone website that handles content management, content delivery, and processing.
  • The xConnect and xDB web services.
  • The Sitecore Identity server - a stand-alone website that acts as an OpenID Connect compliant security token service (STS).
  • Search indexes on the Solr search engine.
  • A Windows service that runs the Marketing Automation engine.
  • A Windows service that runs the xConnect indexer.
  • A Windows service that runs the Sitecore Cortex™ Processing Engine.
  • The Sitecore Cortex™ Reporting service.
  • The Sitecore content and xDB databases.
  • A self-signed client certificate for secure communication between Sitecore and xConnect.
  • A self-signed server certificate for running HTTPS on the xConnect and xDB web services.
  • A self-signed server certificate for running HTTPS on the Sitecore Identity server.

Download and organize the prerequisite and installation files

The installation files must be located in a single folder. We recommend that you create a folder named c:\resourcefiles.

To download the installation files:

  1. On the Sitecore Experience Platform download site, download Sitecore 10.X.X rev. XXXXXX (WDP XP0 packages).zip. This file is listed in the Download options for On Premises deployment section as Packages for XP Single.
  2. Move this file to the C:\resourcefiles folder.
  3. Unpack the ZIP file. The four files unpacked include:
    • Sitecore 10.X.x rev. XXXXXX (OnPrem)_single.scwdp.zip 
    • Sitecore 10.X.x rev. XXXXXX (OnPrem)_xp0xconnect.scwdp.zip 
    • Sitecore.IdentityServer 9.0.X rev. XXXXXX (OnPrem)_identityserver.scwdp.zip 
    • XP0 Configuration files 10.X.X rev. XXXXXX.zip 
  4. Copy the four ZIP files to the C:\resourcefiles folder.
  5. Unpack the XP0 Configuration files 10.X.x rev. XXXXXX.zip file.
  6. Copy the following unpacked files to the C:\resourcefiles folder:
    • createcert.json 
    • IdentityServer.json 
    • Prerequisites.json 
    • sitecore-solr.json 
    • sitecore-XP0.json 
    • xconnect-solr.json 
    • xconnect-xp0.json 
    • XP0-SingleDeveloper.json 
    • XP0-SingleDeveloper.ps1 

Install the prerequisites

For information about manually installing the prerequisites, see the Installation Guide for the XP Scaled Topology.

To automatically install the prerequisites for any of the topologies on a single server:

  1. Open PowerShell as an administrator and navigate to the c:\resourcefiles command line.

  2. Run the following cmdlet:

    Install-SitecoreConfiguration -Path .\Prerequisites.json

When the installation is complete, you might be informed that a server reboot is required.

Run the installation script for the XP Single Developer topology

To simplify your installation, use a PowerShell script to install the Sitecore XP Single Developer (XP0) topology.

To edit and run the installation script:

  1. Save your Sitecore license file in the c:\resourcefiles folder as license.xml.

  2. In the c:\resourcefiles folder, edit the XP0-SingleDeveloper.ps1 script and update each line with the settings that are appropriate for your environment.

    The settings that you must edit are SitecoreAdminPassword, as well as SolrAdminPassword and SolrAdminUserName that must match the Solr's admin credentials.

    Important

    Solr admin should have at least the following permissions:

    • collection-admin-read (for solrCloud setup)

    • collection-admin-edit (for solrCloud setup)

    • core-admin-read

    • core-admin-edit

    • security-read

    • security-edit

    • health

    If you do not specify the Sitecore administrator password in the script and leave the example value "SIF-Default" unchanged, a random password is generated for you. This password is stored in the XP0-SingleDeveloper.log file, and displayed when the sitecore-xp0.json file has been processed. To locate the password, search for Sitecore Admin Password.

    Important

    The default Sitecore administrator password is not valid when you use this script to install Sitecore XP.

  3. Open PowerShell as an administrator, navigate to the c:\resourcefiles command line, and run the following cmdlet:

    .\XP0-SingleDeveloper.ps1

    All the passwords for DB users and other secrets such as the Identity Server client secret and the TelerikEncryptionKey are not displayed on the screen. They are automatically generated and inserted into the appropriate configuration files.

    If you add a DDS server, you must pass the generated passwords for the CM server to the DDS SIF installation parameters. You can find the generated passwords in the installation logs and in the App_Config/connectionStrings.config file on the CM server.

    If the SqlCollectionUser parameter is not set to a custom value during the installation, the prefix that is specified in the installation script is added to it.

We recommend that you keep these scripts. You can use them to uninstall this topology.

If you have suggestions for improving this article, let us know!