SC-XP-10.3.0-Quick Install Guide Developer Workstation-En
SC-XP-10.3.0-Quick Install Guide Developer Workstation-En
Developer Workstation
A quick guide to installing the Sitecore XP Single topology.
Table of Contents
1. Choosing a topology .................................................................................................................. 3
1.1. On-premise topology options .............................................................................................. 3
1.2. Sitecore XP developer installation options ........................................................................... 5
2. Server requirements .................................................................................................................. 6
2.1. Hardware requirements for a server running a single Sitecore installation .......................... 6
2.2. IIS requirements ................................................................................................................. 6
2.3. Operating system requirements .......................................................................................... 6
2.4. .NET requirements .............................................................................................................. 7
2.5. Microsoft Visual C++ 2015 redistributable requirements ..................................................... 7
2.6. Database requirements ....................................................................................................... 8
2.7. Enable Contained Database Authentication ......................................................................... 8
2.8. Search indexing requirements ............................................................................................. 9
2.9. Installing Solr ...................................................................................................................... 9
2.10. Antivirus software considerations ................................................................................... 10
2.11. Prerequisites for using the Sitecore Installation Framework ............................................ 10
3. Installing Sitecore XP with the Sitecore Install Assistant ............................................................ 11
3.1. Download the Sitecore Install Assistant ............................................................................. 11
3.2. Review prerequisites and requirements ............................................................................ 11
3.3. Use SIA to install Sitecore XP ............................................................................................. 12
4. Sitecore Installation Framework ............................................................................................... 14
5. Install Sitecore XP Single Developer (XP0) using SIF .................................................................. 15
5.1. XP Single Developer (XP0) topology ................................................................................... 15
5.2. Download and organize the prerequisite and installation files ........................................... 16
5.3. Install the prerequisites ..................................................................................................... 16
5.4. Run the installation script for the XP Single Developer topology ........................................ 17
5.5. Rebuild the search indexes and the Link database ............................................................ 18
6. Uninstall a Sitecore Single Developer topology ......................................................................... 19
6.1. Uninstall a SIF configuration file ........................................................................................ 19
6.2. Uninstall the Sitecore XP Single Developer topology .......................................................... 19
7. Common issues ....................................................................................................................... 21
1. Choosing a topology
Before you install Sitecore Experience Platform, you must choose the topology or the type of instance
that you want to install.
If you want to install one of the other topologies, download the installation guide for that topology.
You can configure the topology to match your business needs. There are several scalability options
that you can use to achieve better performance, cope with greater website demand, and manage
large amounts of website traffic. For more information about scaling, see Scaling options.
Sitecore also provides a number of cloud-based offerings. For more information, see our Cloud
Services.
Deployment Description
topology
NOTE
For security and scalability reasons, in production environments,
it is best practice to use the XM Scaled (XM1) or XP Scaled (XP1)
configuration.
Deployment Description
topology
XM Scaled (XM1) Use this topology if you are not planning to use the analytics and marketing features in
the Sitecore Experience Platform.
The Sitecore Experience Manager configuration (similar to CMS-only mode) runs the
Content Delivery (CD), Content Management (CM) server roles and the Sitecore Identity
server.
NOTE
When you select this topology, xDB and xConnect are not available.
XP Scaled (XP1) Use this topology if you are planning a fully featured Sitecore Experience Platform
installation.
The Sitecore Experience Platform configuration runs the following separated server
roles:
• Content Delivery
• Content Management
• Sitecore Identity
• Processing
• xConnect Collection
There are different ways to install Experience Manager (XM). You can use:
In a Sitecore Experience Manager installation, the functionality that you can use is different depending
on how you installed Sitecore XM.
NOTE
This document does not describe how to configure the Sitecore Email Experience
Manager. For more information, see the the Sitecore Email Campaign Manager
documentation.
Sitecore Installation Framework (SIF) is a Microsoft® PowerShell module that supports local and
remote installations of Sitecore Experience Platform.
Sitecore Install Assistant (SIA) was introduced in Sitecore XP 9.2.0 and contains an intuitive graphical
user interface that guides you through the installation process. In addition to being easier to use than
SIF, it also:
• Optionally installs and configures the required version of the Solr search service.
Solr is a prerequisite for installing all Sitecore Experience platform topologies.
• Optionally installs Sitecore Experience Accelerator (SXA).
• Configures the Microsoft Windows Server options, configuration settings, and applications
required by Sitecore Experience Platform.
• Validates the specified installation parameters and settings.
2. Server requirements
Before installing Sitecore Experience Platform, you must ensure that you have all of the requirements
and prerequisites in place.
If you are using Sitecore Install Assistant (SIA) to install Sitecore XP, most of the software prerequisites
and requirements are managed by SIA.
• 4 core processor
• 16 GB of RAM
NOTE
The recommended hardware requirements are for running the software on a
single computer. For more information about running Sitecore on different kinds of
hardware, consult your Sitecore partner or technical sales representative.
Sitecore Experience Platform does not officially support any other ASP.NET web servers such as IIS
Express, or Mono Web Server.
Sitecore Experience Platform neither supports nor allows multiple IIS website definitions to point to
the same Sitecore web root.
Sitecore Experience Platform can be hosted on the following Microsoft operating systems:
IMPORTANT
If the Transport Layer Security (TLS) protocol version 1.2 is not activated by default, you
must enable it on all of your Sitecore Experience Platform content management and
Dedicated Dispatch servers (DDS).
For Windows 11 and Windows Server 2022, TLS protocol version 1.3 is enabled by
default.
You must disable the TLS 1.3 on all of your Sitecore Experience Platform content
management and Dedicated Dispatch servers(DDS) and enable TLS 1.2.
For more information about enabling TLS 1.2, see Microsoft’s documentation.
IMPORTANT
Run Windows Update and install all the appropriate service packs and security updates.
Sitecore Identity server requires .NET Core 6.0 Windows Hosting Bundle or later.
You must apply any available updates to the .NET Framework on every Sitecore installation.
NOTE
This redistributable may already be installed with Microsoft Windows. Without it,
Sitecore Experience Platform will fail to start up with the message:
Could not load file or assembly 'ChilkatDotNet46.dll' or one of its dependencies. The
specified module could not be found.
NOTE
All of the databases in Sitecore Experience Platform use the
SQL_Latin1_General_CP1_CI_AS collation, except the Reference Data database that uses
the case sensitive Latin1_General_CS_AS collation. This is because comparisons in the
Reference Data database are case sensitive and they are not case sensitive in the other
databases.
NOTE
For more information about the contained database authentication option, see
Microsoft's documentation.
NOTE
Support for Lucene was removed in Sitecore XP 9.3.0.
For more information about how to install and manage these index providers in Sitecore Experience
Platform, see the Sitecore documentation.
NOTE
If you plan to use the Sitecore Installation Assistant to install Sitecore XP, it can install
Solr for you and you can skip this section.
If you plan to use the Sitecore Installation Framework (SIF) to install Sitecore XP, you
must follow the steps described in this section.
The standard Sitecore Experience Platform configuration requires Solr. The Sitecore Experience
Platform is secure by default, you must, therefore, enable SSL for Solr.
The Solr-Singledeveloper.json deployment configuration file installs and configures Solr with
SSL.
For local testing and development, you can set up a self-signed certificate. The Apache Solr Reference
guide has more information about creating a self-signed certificate.
For more information about the certified products, see the Windows Server Catalog website.
For optimal performance, ensure that the following folders are not scanned by your antivirus
software:
NOTE
Active file scans from antivirus tools can significantly impact the performance of search
indexing software. This can lead to poor user experience or slow system performance.
Consider turning off any antivirus tools or modifying antivirus settings on the search
index server to exclude the application data folders from scans. For more information
about your search indexing software, consult the related documentation.
This chapter describes how to use the Sitecore Install Assistant (SIA) to install the Sitecore XP for
developing and testing purposes.
• After you download the file, unpack SIA and store it on the computer where you want to install
Sitecore XP.
The package includes:
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:
Page Notes
Welcome Review the information on this page to ensure you are ready to start the installation
process.
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 Solr This 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, Red Hat OpenJDK 8 (64-bit) is also installed.
Sitecore settings The Sitecore settings including the installation prefix, the administrator password, and
the location of the Sitecore license file.
Microsoft SQL The Microsoft SQL Server settings including the instance name, the admin user name,
Server settings and the admin password.
Page Notes
Solr settings The Solr settings including the service URL, the file system root, and the name of the
Solr Windows service.
Optional The optional Sitecore modules that you can install. Currently, Sitecore Experience
modules Accelerator (SXA) is the only available module.
Review the information on this page and ensure that no changes are required. To
make some changes, click Back.
Validate This page checks that all the requirements are installed and configured correctly.
Install A 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.
If the installation has been successful, you can open the Sitecore Launchpad.
Before you can install Sitecore Experience Platform, you must set up the latest Sitecore Installation
Framework (SIF).
The Sitecore Installation Framework (SIF) is a Microsoft® PowerShell module that supports local and
remote installations of Sitecore Experience Platform.
SIF deploys Web Deploy Packages (WDP) by passing parameters to SIF configuration files through a
Microsoft® PowerShell module and is fully extensible.
The Sitecore Experience Platform is designed to be secure-by-default. For developer environments all
the required self-signed certificates are created automatically if you do not provide any.
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.
• A Sitecore stand-alone website that handles content management, content delivery, and
processing.
• The Sitecore Identity server - a stand-alone website that acts as an OpenID Connect compliant
security token service (STS).
• 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.
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.
• createcert.json
• IdentityServer.json
• Prerequisites.json
• sitecore-solr.json
• sitecore-XP0.json
• xconnect-solr.json
• xconnect-xp0.json
• XP0-SingleDeveloper.json
• XP0-SingleDeveloper.ps1
To automatically install the prerequisites for any of the topologies on a single server:
When the installation is complete, you might be informed that a server reboot is required.
IMPORTANT
The default Sitecore administrator password is not valid when you use this
script to install Sitecore XP.
.\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.
1. On a Sitecore CM or Index Manager instance, open the Sitecore Launchpad, click Control
Panel, and in the Indexing section, click Indexing manager.
2. In the Indexing Manager dialog box, click Select all, and then click Rebuild.
To rebuild the Link databases for the Master and Core databases:
1. On the Sitecore Launchpad, click Control Panel, and in the Database section, click Rebuild
Link Databases.
2. Select the Master and Core databases and then click Rebuild.
You can also use SIF to uninstall the SIF configuration files and the Sitecore XM Single Developer or
Sitecore XP Single Developer topologies.
2. Run the Uninstall-SitecoreConfiguration cmdlet, and specify the path to your SIF
configuration file.
For example, using the sitecore-XP0.json file:
Alternatively, you can pass in the parameters declared in the SIF configuration files by
prefixing their name with a dash “ -" in the command line.
For example:
In a PowerShell command line, you can pass additional parameters to control the uninstall
process.
For example, running the Verbose cmdlet increases the amount of information that is logged,
and the -Skip <taskname> cmdlet skips one or more tasks.
To correctly uninstall a SIF configuration, you must pass the same parameters that were used during
the installation.
The uninstallation is performed by a separate list of tasks within the configuration file. For more
information, see the SIF documentation.
to
The example scripts contain this line already. You only need to uncomment and comment out
the appropriate lines.
2. Run the script and the topology is removed.
7. Common issues
• Check that your root certificate is in the Trusted Root Certificates Authority store of the Local
Computer, not the current user and that the Issued To and Issued By properties of the root
certificate match.
• Ensure you imported the certificates into the Local Computer’s certificate store, not the current
user’s certificate store.
• Ensure the certificate you created in IIS has a name that matches the site.
For example, CM_test.
• Ensure you pasted your thumbprint into a PowerShell command line window, and that you
removed the hidden character at the start of the string.
• Ensure your thumbprint is in uppercase letters.
For example: 3D703B5198D6D3CEE1D0C1B1BC9ECB6D34989BA4.
You can find the thumbprint in the following locations:
• Sitecore\App_Config\ConnectionStrings.config
• XConnect\App_Config\ConnectionStrings.config
• XConnect\App_Data\jobs\continuous\AutomationEngine\App_Config\Connecti
onStrings.config
• Ensure the self-signed certificate you created in IIS has the same name as your xConnect
instance.
• Ensure the client authentication certificate (under the local machine’s Personal store) has read
permissions for the IIS_IUSR group and the NETWORK SERVICE group.
If you have an error that says your remote certificate is invalid according to the validation
procedure, ensure that the indexer’s ConnectionStrings.config file is using localhost rather
than 127.0.0.1 for the Solr core URL.
Failed installations
If an installation fails for any reason, you must clean up the partial installation before attempting
another installation.
To clean up a partial installation, run the configurations again with the Uninstall-
SitecoreConfiguration command with the same parameters as you used for the installation.
The createcert.json configuration file does not contain uninstallation tasks that remove
certificates because it is highly likely that the certificates, particularly the root certificates, are used
elsewhere.
1. To open the Certificate Management console, in the Windows command prompt, enter
certlm.msc and press Enter.
To open the Certificate Management console for the Current User, enter certmgr.msc.
2. In the left pane, in the tree, expand the Personal node and select Certificates.
3. Select the incorrect certificate, right click it and then click Delete.
4. To remove the Root certificates, in the console, in the left hand pane, expand Certificates,
Trusted Root Certification Authorities, Certificates and select the incorrect certificate, right click it
and then click Delete.
After you have removed the failed installation, correct the errors in the launch script or configuration
files before attempting a new installation.
1. On the Sitecore Launchpad, click Control Panel, and in the Indexing section, click Populate
Solr Managed Schema.
2. In the Schema Populate dialog box, click Select all, and then click Populate.