Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Prerequisites

...

ItemsHow to get them

Windows 10 or greater

(All versions but Enterprise)

Windows 10 or greater will be needed to install all items needed for Sitecore 10.1

Sitecore 10.1.0 rev. 005207 (WDP XP0 packages)

Powershell 7.1.3

Release v7.1.3 Release of PowerShell · PowerShell/PowerShell · GitHub

Powershell Extensions 6.0Installation - Sitecore PowerShell Extensions

NSSM 2.24

https://nssm.cc/release/nssm-2.24.zip
Sitecore TDS (download the latest version, you might have to scroll down the page to see the download link)https://www.teamdevelopmentforsitecore.com/Download/TDS-Classic

Microsoft Visual C++ 2015 Redistributable

https://www.microsoft.com/en-us/download/details.aspx?id=53587
Visual Studio 2019 Professional

Please check that this is already installed on your computer.    If not you might have to talk to your manager about how to get a license to install it.   Other versions of VS 2019 should work as well but I didn't have any other version to test it out so I can't say that you won't run into any issues.

SQL Server 2019  or SQL Server 2017

(Standard Edition)

Please check that this is already installed on your computer.    If not you might have to talk to your manager about how to get a license to install it.   


To determine what version you have you can open SQL Server Management Studio and run this query

SELECT @@VERSION

If should return something like this below

Microsoft SQL Server 2017 (RTM-GDR) (KB4583456) - 14.0.2037.2 (X64) Nov 2 2020 19:19:59 Copyright (C) 2017 Microsoft Corporation Express Edition (64-bit) on Windows 10 Enterprise 10.0 <X64> (Build 19041: ) (Hypervisor)

Microsoft SQL Server Data-Tier Application Framework (DacFx)

Download Microsoft® SQL Server® Data-Tier Application Framework (18.3.1) from Official Microsoft Download Center

SQL Server System CLR Types

Download Microsoft SQLSysCLRTypes from Official Microsoft Download Center

Microsoft .Net Framework 4.8.0

If you would like to know what version of .Net you have installed you can go to this page to figure it out
https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed

Download .NET Framework 4.8 | Free official downloads (microsoft.com)


Web Platform Installer 5.0

  • Web Deploy 3.6 for Hosting Servers (Use Web Platform Installer to install)
  • URL Rewrite 2.1 (Use Web Platform Installer to install)
https://www.microsoft.com/web/downloads/platform.aspx#additionalDownloads

Solr 8.4.0

(You can check the SOLR compatibility of each Sitecore instance here: https://kb.sitecore.net/articles/227897)

Solr 8.4.0 downloads

JRE (Java Runtime Environment) 

(This might not be needed if you have installed Solr before)

Java SE Runtime Environment 8 - Downloads (oracle.com)
SCORE Visual Studio Solution Template

SCORE Visual Studio Solution Scaffolding v3.5.8

SCORE Tenant ScaffoldingSCORE 3.1.1.0 Tenant Scaffolding Automation

...

  1. Visual Studio 2019

    • You might already have Visual Studio 2017 but Sitecore 10.1 recommends you use Visual Studio 2019.   Please install Visual Studio 2019 if you don't already have it installed
    • If you have VS 2017 or earlier you do NOT need to remove them in order to install Visual Studio 2019.
  2. Sitecore TDS 6.0

    • In case there is a newer version you should probably use that.
  3. Powershell 5.1 and 7.1.3+

    • To check your powershell version open a DOS command window as an Administrator and type `powershell $PSVersionTable.PSVersion` and make sure it says version '5.1'
    • Install Powershell 7.1.3 from the list above if you don't have that version installed
  4. Microsoft .Net Framework 4.8.0

  5. Microsoft Web Platform Installer 5.0

    • Install Web Platform Installer 5.0 from the list above
    • Open IIS > Actions > Get New Web Platform Components

...

  • Do a search for the following items and then click the button "Add" and then "Install"
    • URL Rewrite 2.1
    • Web Deploy 3.6 for Hosting Servers
    • Microsoft® SQL Server® Data-Tier Application Framework (18.3.1 DacFx) if you can not find it over the Web Platform then install it from the Prerequisites list above

Sass (Dart)

  • Dart

    • Go here dart-sass and download dart-sass which is suitable for your operating system
    • Extract it where you want.
    • Open windows search and search this "system environment variables" then click it to open.
    • enter image description hereImage Modified
    • Click "Environment Variables" 
    • enter image description hereImage Modified
    • Under system variables find the PATH variable, select it, and click "Edit"
    • enter image description hereImage Modified
    • If there is no PATH variable, click "New" and write here PATH. 
    • enter image description hereImage Modified
    • enter image description hereImage Modified
    • Go to your dart-sass folder and copy directory (Yours will probably be different from mine below). Make sure none of your intermediary folders is a .zip folder, you may run into problems.
    • enter image description hereImage Modified
    • Add your directory to the beginning of the variable value followed by ; (a semicolon). For example, if the value was C:\Windows\dart-sass, change it to C:\Users\Me\bin;C:\Windows\dart-sass. If there is not another directory just add your directory here. Then click "Ok". 
    • enter image description hereImage Modified
    • Open "Command Prompt".
    • enter image description hereImage Modified
    • Write here "sass --version" and click enter to be sure it installed correctly and then you should be done
    • enter image description hereImage Modified

Create MySite folder with VS Scaffold

  • Create a folder C:\Projects and then under that add a folder called MySite so you should now have path called C:\Projects\MySite ( You can do it differently as long as you understand what you are doing)
  • Extract SCORE+Visual+Studio+Solution+Scaffold+v3.5.8.zip (this should have been downloaded from your prerequisites and it was called SCORE Visual Studio Solution Template) into MySite
  • It should look something like the screenshot below once it is extracted

...

  • Copy your Sitecore license (license.xml) file to C:\Projects\MySite  (You will have to get this from your company so please talk to your manager about how to get this license)
  • Copy 'Sitecore 10.1.0 rev. 005207 (WDP XP0 packages)' to C:\Projects\MySite (This is the first item that you would have downloaded from our prerequisite list above)

Install SQL Server 2019

  • Install SQL Server 2019

  • Install Microsoft Visual C++ 2015 Redistributable

  • Install SQL Server System CLR Types from the Prerequisites list above

...

  • Download JRE from the Prerequisites list above (this might not be needed if you already have Solr installed)
    • Install JRE
    • Add a system environment variable called JAVA_HOME that points to your java installation:
      • Variable Name: JAVA_HOME
      • Variable Value (set as necessary): C:\Program Files (x86)\Java\jre1.8.0_77 (Your version of jre will most likely be different so don't just copy the value but adjust it based on the version of jre you've installed)
  • Download Solr 8.4.0 from the Prerequisites list above
  • Create a folder called C:\solr-8.4.0
  • Unzip the Solr zip file and place it in C:\solr-8.4.0
    • Hint: Remove any intermediary folders to avoid a folder structure like C:\solr-8.4.0\solr-8.4.0\server
    • It should now be a valid path on your file system: C:\solr-8.4.0\server
  • Download NSSM from the Prerequisites list above
    • Unzip it into C:\nssm
    • Open a DOS Window with Administrator rights
    • Type "powershell" (without double quotes)
    • cd C:\nssm\win64
    • ./nssm install "Solr - MySite"
    • The NSSM Service Installer application window will open. Set the following values:
      • Path: C:\solr-8.4.0\bin\solr.cmd
        Startup Directory: C:\solr-8.4.0\bin
        Arguments: start -f -p 8983   (If you already have Solr installed then you might want to change 8983 to a different port number else you will run into issues, I used 8999 and it worked for me but you might have to use something else if that port is already used)
        Display Name (under Details tab): SOLR - MySite
        Description (under Details tab): C:\solr-8.4.0\bin\solr.cmd start -f -p 8983
        Startup type: Automatic
      • Open your services and start the newly created "Solr - MySite" service
  • Verify that you can see the SOLR Dashboard at http://localhost:8983/solr/#/
  • Troubleshooting
    • Reboot your computer and then verify that you can see SOLR Dashboard at http://localhost:8983/solr/#/
    • If you can't see it then make sure your Startup Type in Services for "Solr - MySite" is set to Automatic
    • Also make sure that if you have another Solr instance installed that is using the same port (8983) that you stop that service and set it to Manual in Services
    • Double check about the port you decided to use and if it is different from 8983 then use that number in the url instead

...

  • Double check that you have placed your Sitecore License under C:\Projects\MySite
  • Double check that you have placed the package `Sitecore 10.1.0 rev. 005207 (WDP XP0 packages)` under C:\Projects\MySite
  • Double check that the install.ps1 script exists under C:\Projects\MySite\Automation\Sitecore-Versions\10.1\
  • Open Windows Powershell as Administrator
  • Type "cd C:\Projects\MySite" (without the double quotes)
  • Run the powershell script below
    • This is a sample script so please change the variables values that fit your instance

...