Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.42 KB

preparing-installation.md

File metadata and controls

77 lines (52 loc) · 3.42 KB
Raw

Preparing Installation Configuration

Assets

Review the assets.json file to ensure everything is configured correctly.

By default, only the SPE and SXA modules get installed automatically. If you would like to install additional modules you will need to set the appropriate flags in this file. See installing-modules.md for more details.

Setting up Defaults

Many settings in the Sitecore XP installation don't need to be changed. set-installation-defaults.ps1 takes care of the most common settings. Don't worry, you can still override many settings to make the installation your own in the next step!

.\set-installation-defaults.ps1

Parameters

All paremeters listed below are optional and have defaults configured (see each one below for default value).

  • ConfigurationFile:
    • Default Value: .\configuration-xp0.json
    • Specify your own configuration file name if you would like to manage multiple configurations. This is useful when trying to maintain side-by-side Sitecore instances/installations. If you're simply trying to install this for the first time, the default file is set.
  • assetsRoot:
    • Default Value: $PSScriptRoot\assets
    • Unless you're modifying this for advanced scenarios, leave this one alone.
  • packageRepository:
    • Default value: .\assets
    • Important - This location is where Sitecore installation assets are downloaded and extracted. Ensure the location you choose is acceptable.
    • If you already have Sitecore assets downloaded you can move them to the location you specify here.
    • It is also the location where you should place your license.xml file.
  • sitecoreVersion:
    • Default Value: Currently released product version.
    • This is normally set during branching/upgrade and shouldn't need to be modified.

License File

Copy your license file to the packageRepository folder you specified above.

copy license.xml c:\sitecore-repository

Overriding Default Settings

Now that we have some defaults configured, let's override some settings to match your local configuration.

  • Make a copy of set-installation-overrides.ps1.example file and rename it to remove the .example extension ie: set-installation-overrides.ps1.

    • We avoid simply renaming the file from .example to .ps1 since it causes changes in source control.
    copy set-installation-overrides.ps1.example set-installation-overrides.ps1

  • Edit set-installation-overrides.ps1 to set the Site, Solr and SQL settings relevant to your environment.

  • Apply overrides

    .\set-installation-overrides.ps1

NOTE: Remember to always execute set-installation-defaults.ps1 prior to executing set-installation-overrides.ps1

Override Parameters

  • ConfigurationFile: Specify the configuration file you've set when calling set-installation-defaults.ps1 or don't specify if you left the default (configuration-xp0.json).
  • prefix: What would you like to call your site. The default is habitathome but it can be anything you want.

    NOTE: The default suffix is dev.local. Your site will be your-prefix.dev.local

  • assetsJsonPath: The default is assets.json but this allows you to create your own list of assets.json files to be used.

Next Steps

Continue to Next Step (Installing Sitecore XP)

Return to Index

Return to main docs index