Installing Sitecore XP with the Sitecore Install Assistant

Version: 10.5

This chapter describes how to use the Sitecore Install Assistant (SIA) to install the Sitecore XP for developing and testing purposes.

You can use SIA to install the:

  • Sitecore XP Single Developer (XP0) topology.
  • Sitecore XM Scaled (XM1) topology

If you are using Sitecore Install Assistant (SIA) to install Sitecore XP, most of the software prerequisites and requirements are managed by SIA.

Download the Sitecore Install Assistant

To download the Sitecore Install Assistant:

  • After you download the file, unpack SIA and store it on the computer where you want to install Sitecore XP.

    The package includes:

    • setup.exe - the SIA executable file.
    • JSON configuration files.
    • ZIP program files.

Review prerequisites and requirements

SIA requires .NET Framework 4.8.0.

Before you use SIA to install Sitecore XP, you must:

  • Install SQL Server.

  • Install all the operating system updates.

  • Have a valid Sitecore license file.

  • Ensure that your computer meets the minimum hardware requirements.

    For more information, see Server requirements.

Use SIA to install Sitecore XP

To use SIA:

  1. Go to the folder where you unpacked SIA.

  2. Run setup.exe - it runs with administrator permissions by default.

  3. Review the information on the Welcome page and click Start.

  4. SIA guides you through the installation process.

    SIA-example-SOLR.png

    The left-hand panel contains the title of each SIA page. Green indicates that the page has been completed and blue indicates the active page.

The following table contains a summary of the information required in each page of SIA:

PageNotes
WelcomeReview the information on this page to ensure you are ready to start the installation process.
PrerequisitesThis page installs the prerequisites:

  • Sitecore Installation Framework (SIF) - a Microsoft® PowerShell module that supports local and remote installations of Sitecore XP. This module is required.
  • Windows Server prerequisites – the operating system applications and settings required to run Sitecore XP.


To ensure that you have the latest version of SIF and that your operating system meets the system requirements, we recommend that you select both options and click Install.
Install SolrThis page installs the Solr search provider. If you already have Solr installed, click Skip. Otherwise, enter the appropriate information on the page and click Install.

If you choose to install Solr, Amazon Corretto 21 OpenJDK 21 (64-bit) is also installed.
Sitecore settingsThe Sitecore settings including the installation prefix, the administrator password, and the location of the Sitecore license file.
Microsoft SQL Server settingsThe Microsoft SQL Server settings including the instance name, the admin user name, and the admin password.
Solr settingsThe Solr settings including the service URL, the file system root, and the name of the Solr Windows service. Starting from Sitecore 10.5, Solr Admin Credential is required.
Optional modulesThe optional Sitecore modules that you can install. Currently, Sitecore Experience Accelerator (SXA) is the only available module.
SummaryAll the settings that you specified.

Review the information on this page and ensure that no changes are required. To make some changes, click Back.
ValidateThis page checks that all the requirements are installed and configured correctly.

When all requirements are in place, click Install.
InstallA summary of the installation process. An error terminates the installation process.

To review the installation process errors, as well as any errors that occurred, click Log.
CompleteTells you whether the installation has been successful.

If the installation has been successful, you can open the Sitecore Launchpad.
If you have suggestions for improving this article, let us know!