HabitatHome Demo and the tools and processes in it is a Sitecore® solution example built using Sitecore Experience Accelerator™ (SXA) on Sitecore Experience Platform™ (XP) following the Helix architecture principles.
Please read the LICENSE carefully prior to using the code in this repository
The code, samples and/or solutions provided in this repository are unsupported by Sitecore PSS. Support is provided on a best-effort basis via GitHub issues or Slack #habitathome (see end of README for additional information).
It is assumed that you already have a working instance of Sitecore XP and all prerequisites prior to installing the demo. Support for product installation issues should be directed to relevant Community channels or through regular Sitecore support channels.
The code, samples and/or solutions provided in this repository are for example purposes only and without warranty (expressed or implied). The code has not been extensively tested and is not guaranteed to be bug free.
Prior to attempting the demo installation, ensure you have a working Sitecore XP 9.0.2 instance. Detailed installation instructions can be found at doc.sitecore.com.
In addition to a base XP 9.0.2 installation, the following modules are required:
- Sitecore PowerShell Extensions 4.7.2 for Sitecore 8/9 on Marketplace
- Sitecore Experience Accelerator for 9.0 version 1.7.1 on dev.sitecore.com
- Data Exchange Framework v2.0.1 on dev.sitecore.com as well as relevant Providers on same page
- Data Exchange Framework 2.0.1 Dynamics Connectors on dev.sitecore.com
Some gulp tasks have been included to help with repetitive tasks. These tasks require the SPE Remoting Module.
- SPE Remoting 4.7 Marketplace The "SPE" folder is assumed to be in the ~Documents\WindowsPowerShell\Modules folder
SECURITY WARNING - The default configuration for the Habitat Home demo uses admin/b and allows this user to access SPE Remoting.
Additional Windows Components
- Url Rewrite 2.1
- Can be installed using Web Platform Installer in IIS Manager
The demo is configured for HTTPS/SSL. Please ensure that you create an HTTPS binding with appropriate self-signed certificates.
Build / Deployment
In order to deploy the assets, you need either Visual Studio 2017 or MSBuild Tools for Visual Studio 2017.
Custom install - before you start
The following is a list of default values / assumptions for install locations
Habitat Site domain
The hostname habitathome.dev.local is used in the SXA Hostname (Site Grouping).
If you do not use habitathome.dev.local you will need to modify the Host Name in
/sitecore/content/Habitat Sites/Habitat Home/Settings/Site Grouping/Habitat Home after successfully deploying the site.
The Habitat Home site will not respond / render correctly until this value is modified.
If you do not want to use the default settings, you need to adjust the appropriate values in
The cake script will automatically create a publishSettings.targets.user file with the value of the InstanceUrl specified in the cake-config.json file.
All installation instructions assume using PowerShell 5.1 in administrative mode.
1. Clone this repository
Setting Git for Long Paths
- Before cloning, you need to configure git to allow long paths, which is not the default.
git config --system core.longpaths true
Clone the Sitecore.HabitatHome.Platform repository locally - defaults are configured for C:\Projects\Sitecore.HabitatHome.Platform.
git clone https://github.com/Sitecore/Sitecore.HabitatHome.Platform.git-- ssh:
git clone firstname.lastname@example.org:Sitecore/Sitecore.HabitatHome.Platform.git
2. Deploy Sitecore.HabitatHome.Platform
IMPORTANT: Publish site BEFORE trying to deploy Habitat Home
From the root of the solution
if you plan on installing the Commerce (XC) demo:
.\build.ps1 -Target "Quick-Deploy"
if you are only installing this demo:
- If you the deployment failed at
Sync-Unicornstep, evaluate and fix the error and then run
.\build.ps1 -Target "Post-Deploy".
- If you the deployment failed at
3. Validating deployment
- Browse to https://habitathome.dev.local (or whatever hostname you selected)
- You should see the Habitat Home landing page with a full-width carousel
- If you do not see the full-width carousel and instead see the initial Sitecore default landing page, ensure that your Host Name was configured correctly in
/sitecore/content/Habitat Sites/Habitat Home/Settings/Site Grouping/Habitat Home
- Browse to https://habitathome.dev.local
- You should see the Habitat landing page (not Habitat Home)
1. Disable Unicorn Serialization
When Unicorn is active, the Content Editor will display warnings that certain items are controlled by Unicorn. If you wish to disable Unicorn serialization, open the Web.config file in your webroot and update the following appSetting
<add key="unicorn:define" value="Off"/>
This appSetting is
On by default. Setting it to
Off ensures that none of the Unicorn serialization configuration files are loaded.