installation

Sitecore XP 9.1 – Step by step Install Guide on your machine

Update (06-Apr-2019): for Sitecore 9.1 Update 1 (aka 9.1.1) installation, please have a look at this post

This one is a summary of my own experience for Sitecore Experience Platform 9.1 Initial Release (aka Sitecore XP 9.1.0) installation on my machine. I’ve had much experience in Sitecore XP 9.0 installation so I decided to go only with:

I do hope that this blog post is helpful for your own journey as well.

Note: personally, I wanted to use my own install directory rather than the default one

Setup Prerequisites

Step by step guide

  1. create a new folder D:\sc91_install
  2. install SOLR 7.2.1 if not yet
    • copy / paste install-solr.ps1 and helper.psm1 into D:\sc91_install
    • note 1: the original ones are here and here of Sitecore.HabitatHome.Utilities
    • note 2: you may want to use your own settings rather than default settings by opening install-solr.ps1 and editing the following ones:
    • sc91_2
    • open Windows PowerShell (run as administrator)
    • execute .\install-solr
    • sc91_1
  3. (optional) install Sitecore Install Framework (SIF) if not yet
    • if you have never installed Sitecore 9 before, you will probably want to execute Set-ExecutionPolicy -Scope CurrentUser Unrestricted
    • sc9_14
    • refer to 3.2.1 Installing the Installation Framework Module Using MyGet (Page 26) in Sitecore 9.1 Installation Guide
    • open Windows PowerShell (run as administrator)
    • use the following commands to install the latest version of SIF
      1. Register-PSRepository -Name SitecoreGallery -SourceLocation https://sitecore.myget.org/F/sc-powershell/api/v2
      2. Install-Module SitecoreInstallFramework
      3. Update-Module SitecoreInstallFramework -force
  4. enable Contained Database Authentication if not yet
  5. download and unzip Package for XP Single (Note: must log into https://dev.sitecore.net/ before downloading)
    • copy / paste the following ones to D:\sc91_install
      1. Sitecore 9.1.0 rev. 001564 (OnPrem)_single.scwdp.zip
      2. Sitecore 9.1.0 rev. 001564 (OnPrem)_xp0xconnect.scwdp.zip
      3. Sitecore.IdentityServer 2.0.0 rev. 00157 (OnPrem)_identityserver.scwdp.zip
    • unzip XP0 Configuration files 9.1.0 rev. 001564.zip and copy / paste all files to D:\sc91_install
    • sc91_4
  6. override sitecore-XP0.json + xconnect-xp0.json + IdentityServer.json + XP0-SingleDeveloper.json in order to inject the custom install directory
  7. copy / paste your Sitecore licence file license.xml to D:\sc91_install
  8. (optional) if you have never installed Sitecore 9 before, you will probably want to install the prerequisites
    • open Windows PowerShell (run as administrator)
    • execute Install-SitecoreConfiguration -Path .\prerequisites.json
    • sc91_3.png
  9. download sc91_install.ps1 and copy / paste it to D:\sc91_install then open it to correct the following parameters:
    • (optional) $InstallDirectory (this one is to specify your own install directory)
      • Note: it’s “D:\websites\” by default, you should update it if the disk space is low
    • (optional) $Prefix
    • $SqlServer
    • $SqlAdminUser
    • $SqlAdminPassword
    • (optional) $SitecoreAdminPassword
      • Note: leave the example value “SIF-Default” unchanged, a random password is generated for you
  10. open Windows PowerShell (run as administrator)
    • change directory to D:\sc91_install
    • execute .\sc91_install
    • sc91_5.png
  11. hopefully there is nothing can stop the installation process and then note Sitecore Admin Password
    • sc91_6.png
  12.  open a browser:
  13. DO NOT forget to perform Post-Installation Steps

 

How to uninstall it?

Option 1: using the uninstall function of SIF
  • open D:\sc91_install\sc91_install.ps1 and uncomment the line 79 + comment out the line 76 then save it
  • sc91_10.png
  • open Windows PowerShell (run as administrator)
  • change directory to D:\sc91_install
  • execute .\sc91_install
  • sc91_11
Option 2: using the custom script
  • download sc91_uninstall.ps1 and put it into D:\sc91_install then open it to correct 07 parameters below:
    1. $Prefix
    2. $InstallDirectory
    3. $SolrService
    4. $PathToSolr
    5. $SqlServer
    6. $SqlAccount
    7. $SqlPassword
  • open Windows PowerShell (run as administrator)
  • change directory to D:\sc91_install
  • execute .\sc91_uninstall
  • sc91_8.png
  • hopefully, it runs well and cleans everything up

 

Got issues?

Please send your issues (with screenshots if possible) to viet.hoang.sitecore@gmail.com so that I have a chance to understand your problem and be able to suggest the solution.

Happy Sitecore 9.1 Installation!

33 thoughts on “Sitecore XP 9.1 – Step by step Install Guide on your machine

  1. There is a built in uninstall function now in the configs.

    If you comment out line 76 and uncomment line 79 in the authors example sc91_install.ps1 script you can re-run the script to remove an installation.

    Liked by 1 person

  2. Great guide! Needed to stand up a dev site asap. I didn’t have time to update my copy of SIFless for 9.1, so I used this to make sure I didn’t miss anything. Went flawlessly. Thanks for your efforts.

    Liked by 1 person

  3. Hello everyone! Thansk for the guide. The download link for the SiteCore XP Single 9.1 is not working. (even after login) Do you have an alternative link?
    Thank you.

    Like

  4. sc91_install.ps1 throws error.
    Install-SitecoreConfiguration : A parameter cannot be found that matches parameter name ‘InstallDirectory’.

    Like

      1. Its a great article. Helped me a lot installing sitecore 9.1. Just I was not able to understand “Install Directory” Parameter. Which I managed doing with XP0-SingleDeveloper.ps1. I made changes in XP-SingleDeveloper.ps1 and executed it. Rest run smoothly.
        Thank Viet.

        Liked by 1 person

  5. Hi Viet,
    I am getting an error.

    PS D:\sc91_install> .\sc91_install
    Install-SitecoreConfiguration : Cannot retrieve the dynamic parameters for the cmdlet. Invalid JSON primitive: .
    At D:\sc91_install\sc91_install.ps1:76 char:1
    + Install-SitecoreConfiguration @singleDeveloperParams *>&1 | Tee-Objec …
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : InvalidArgument: (:) [Install-SitecoreConfiguration], ParameterBindingException
    + FullyQualifiedErrorId : GetDynamicParametersException,Install-SitecoreConfiguration

    Like

    1. Hi Navneet,

      You should ensure to “open raw” and then copy / paste the files in Step #6.

      The error “Invalid JSON primitive” is due to an unrecognized escape sequence.

      Like

  6. I have successfully installed it, but when I log in, it always reminds me that my password is not correct. What is the problem? Do you have a method to troubleshoot it ?

    Like

    1. Did you note the auto-generated password in Step #11? If not yet, you will have to open “XP0-SingleDeveloper.log” to get it.

      If your admin account is locked out due to multiple invalid login attempts, you may want to try https://kamsar.net/index.php/2016/10/Become-a-Sitecore-admin-without-a-login/

      (Note: you will have to disable Sitecore Identity as well https://doc.sitecore.com/developers/91/sitecore-experience-management/en/understanding-sitecore-authentication-behavior-changes.html#UUID-153eb49e-9b9c-c95e-1e0c-c368778c900d_section-idm45851236122672)

      Like

  7. hi Viet Hoang
    I facing the following error while installing the last point

    Install-SitecoreConfiguration : Cannot retrieve the dynamic parameters for the cmdlet. Invalid JSON primitive: .
    At C:\sc91_install\sc91_install.ps1:76 char:1
    + Install-SitecoreConfiguration @singleDeveloperParams *>&1 | Tee-Objec …
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : InvalidArgument: (:) [Install-SitecoreConfiguration], ParameterBindingException
    + FullyQualifiedErrorId : GetDynamicParametersException,Install-SitecoreConfiguration

    Like

      1. Thank you so much, its work now>
        one more error i’m facing is related to sql instance. I have installed MSSQL 2016 with sp2 and instance is working on local machine. here is error:

        SQLCMD.EXE : Sqlcmd: Error: Microsoft ODBC Driver 11 for SQL Server : The client cannot connect to the server because
        the requested instance was not available. Use SQL Server Configuration Manager to make sure the SQL Server instance is
        configured correctly. .
        At C:\Program Files\WindowsPowerShell\Modules\SitecoreInstallFramework\2.1.0\Public\Tasks\Invoke-CommandTask.ps1:31
        char:13
        + & $Path $Arguments | Out-Default
        + ~~~~~~~~~~~~~~~~~~
        + CategoryInfo : NotSpecified: (Sqlcmd: Error: …ed correctly. .:String) [], RemoteException
        + FullyQualifiedErrorId : NativeCommandError

        Install-SitecoreConfiguration : Command sqlcmd returned a non-zero exit code – (1)
        At C:\sc91_install\sc91_install.ps1:76 char:1
        + Install-SitecoreConfiguration @singleDeveloperParams *>&1 | Tee-Objec …
        + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        + CategoryInfo : NotSpecified: (:) [Write-Error], WriteErrorException
        + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,Install-SitecoreConfiguration

        Like

  8. Hi,
    Viet Hoang
    Thank you it’s all done!
    just I repeat the point 6, may be i miss some file to copy paste of raw data.
    It’s so easy explanation and save my time.
    Now have you any blog how to connect it with visual studio to work as a developer?

    Like

  9. Thank you! It is very helpful. But when I try to run this on my personal laptop on Windows 10 machine. I get the following error. I checked many articles but none helped to resolve this. Any help from your side would be really appreciated.
    Error: Install-SitecoreConfiguration : Cannot retrieve the dynamic parameters for the cmdlet. Unrecognized escape
    sequence. (2548): {
    “Parameters”: {
    “InstallDirectory”: {
    “Type”: “String”,
    “Description”: “The install directory for all the sites.”,
    “DefaultValue”: “”
    }, …….

    Like

Leave a Reply

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.