Installation Guide SC82 Update 3
Installation Guide SC82 Update 3
2 Update 3 Sitecore Experience Platform Installation Guide Rev: January 26, 2018
Table of Contents
2
Sitecore Experience Platform Installation Guide
Chapter 1
Introduction
This document describes how to install Sitecore Experience Platform 8.2 rev. 170407
(Update-3).
Chapter 1 – Introduction
An introduction to the Sitecore Experience Platform 8.2 installation process.
Chapter 2 – Sitecore XP Requirements
An outline of the installation requirements for Sitecore CMS.
Chapter 3 – Installing the Sitecore XP from the .EXE File
Describes the pre-installation steps, configuration and installation process.
Chapter 4 – Installing the Sitecore XP from the .ZIP File
Step-by-step instructions for installing Sitecore CMS from the .ZIP file.
Chapter 5 – Sitecore XP Post-Installation Steps
Information about necessary actions after installation.
3
Sitecore Experience Platform 8.2 Update 3
These components are installed together. Sitecore XP is distributed as an .exe or .zip file.
The Sitecore Experience Database (xDB) is a central data repository for marketers. It collects and connects all
customer interactions in a single view, and enables immediate, personalized, automated experiences.
Sitecore xDB uses MongoDB as a collection database and it is included in the Sitecore XP package.
4
Sitecore Experience Platform Installation Guide
The configuration is stored in files such as web.config and the files under the \App_Config folder.
For information about hardening security after you install Sitecore, see the manual Security Hardening Guide
in the Sitecore Documentation site.
You can create an archive of your Sitecore XP solution to move it from one computer to another.
For assistance or to report any discrepancies between this document and the product, please contact
http://support.sitecore.net/helpdesk/.
Before installing Sitecore XP, you should decide on the:
Project name and acronym, for example, ProjectName.
Acronym/prefix, for instance PN.
Target installation file system root, for instance C:\inetpub\wwwroot\ProjectName.
Database technology:
o SQL Server
o MongoDB
Database location – locally or on a remote server.
Appropriate Sitecore license.
Hardware.
Administrative access to computers and databases.
IIS configuration – host headers, and so on.
5
Sitecore Experience Platform 8.2 Update 3
Chapter 2
Sitecore XP Requirements
This chapter describes the prerequisites, hardware, and software requirements for Sitecore
XP 8.2 host and client computers. In this document, the term “server” refers to a Windows
OS Web server and the term “host” refers to an installation of Sitecore XP on either a server
or a workstation.
6
Sitecore Experience Platform Installation Guide
Important
When you configure the Sitecore Experience Database (xDB), you must synchronize all the servers in your
solution to a single reliable time source, for example, by means of the Network Time Protocol (NTP). The
aggregation of engagement automation states depends on the system time and changing this can lead to
incorrect aggregation results or loss of data.
You must use the version of IIS that is supported by your operating system. For more information about IIS
and operating systems, see Microsoft’s documentation.
Sitecore XP does not officially support any other ASP.NET web servers such as IIS Express, or Mono Web
Server.
Important
Sitecore neither supports nor permits multiple IIS website definitions pointing to the same Sitecore web root.
Important
Run Windows Update and install all the appropriate service packs and security updates on all of your Sitecore
XP host and client computers.
Windows 10
Sitecore XP supports the following editions of the Windows 10 operating system:
Home
7
Sitecore Experience Platform 8.2 Update 3
Education
Professional
Note
Sitecore recommends that you run the database on a separate server from the web server.
Oracle
The Oracle database storage setup is only available when Sitecore XP is running in Sitecore Experience
Management mode (CMS-only mode), which lets you run Sitecore XP without the Experience Database (xDB)
enabled.
Sitecore supports:
Oracle Database 11g R2 (11.2)
8
Sitecore Experience Platform Installation Guide
For more information about the certified products, see the Windows Server Catalog website.
To ensure optimal performance, exclude the following folders from scanning by your antivirus software:
The site root folder.
The data folder that is defined in the web.config file.
The folder that contains the actual Sitecore database files.
The C:\Windows\Temp or {app_pool user profile}\Temp folder.
Recommended configuration:
4 core processor
16GB 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.
9
Sitecore Experience Platform 8.2 Update 3
Note
Sitecore XP 8.2 supports all the current stable versions of these browsers unless stated otherwise. Sitecore XP
8.2 does not support the Compatibility view in Internet Explorer 11.
For more information about configuring a browser, see the Browser Configuration Reference document on
the Sitecore Developer Network.
Silverlight
Some applications, such as Engagement Automation, and Sitecore App Center require Microsoft Silverlight 5
or later.
You do not need to install any additional software on the Sitecore XP clients that access Sitecore XP servers.
10
Sitecore Experience Platform Installation Guide
Chapter 3
This chapter describes how to use the installation program to install Sitecore XP.
You can download the Sitecore installation program from the Sitecore Developer Portal.
Troubleshooting
11
Sitecore Experience Platform 8.2 Update 3
5. In the pane on the left side, expand the Local Policies node and select Security Options.
6. In the pane on the right side, scroll to the bottom of the list of policies.
7. Verify that the User Account Control: Detect application installations and prompt for elevation policy is
set to Enabled.
If this setting is not enabled, you must enable it.
12
Sitecore Experience Platform Installation Guide
Note
The Sitecore XP configuration files are automatically modified according to the settings provided in the
wizard.
Welcome page
License Agreement
Read the license agreement and select the appropriate option. Click Next.
13
Sitecore Experience Platform 8.2 Update 3
Installation Type
Click Next.
To install Sitecore WebDAV features, you must have the WebClient service on your computer. If the
WebClient service is not available, the following message appears:
Disregard this message if you do not want to install WebDAV features. Click Next.
Instance Name
14
Sitecore Experience Platform Installation Guide
Give a unique name to this new instance of Sitecore. If you choose to create a new site at a later step, this
name is also used as the hostname of an IIS web site.
License File
Note
If you selected the Database Only installation type, the Installation Wizard skips this step.
Click Browse to navigate to the license file that you want to use, and then click Next.
Database Server
Select the database server.
If you select SQL Server, you see the following Database Server dialog box:
Select the database server from a list, or click Browse to see a list of all the database servers that are
available. Enter the login ID (SQL server user name) and the corresponding password. The installation
program uses these credentials to access the SQL server.
15
Sitecore Experience Platform 8.2 Update 3
To set the database prefix options, click Advanced and the Advanced Database Options dialog box appears.
In the Advanced Database Options dialog box, specify the database prefix for this instance of Sitecore XP,
and if you want the database prefix to be added to the names of the physical files, select the Add this prefix
to the names of the physical files check box.
In the Credentials to use in connection strings section, enter the login ID (SQL server user name) and
corresponding password. Sitecore applications will use these credentials to access the SQL server. Click OK.
Click Next.
Note
If you selected the Database Only or Client Only installation, the Credentials to use in connection strings
section is not shown.
Destination Folder
Select the folder where the Sitecore web site should be installed.
16
Sitecore Experience Platform Installation Guide
To change the database folder and the folder where various data files are stored — log files, packages, and so
on — click Advanced and the Destination Folders dialog box appears:
Note
If you selected the Database Only installation, the Sitecore Data and Sitecore Databases fields are not
shown.
If you selected the Client Only installation, the Sitecore Databases field is not shown.
Note
Ensure that SQL server has the permissions to write to the destination folder(s).
Note
If you selected the Database Only installation, the IIS Web Site step is not shown.
17
Sitecore Experience Platform 8.2 Update 3
Enter the name of the new website. Click Advanced to edit a website port and create an Application Pool.
Select the Precompile the website to improve the initial response time check box.
Click OK.
The IIS Web Site dialog box reflects the changes.
Click Next.
Review the options you selected. Click Install to install Sitecore XP.
18
Sitecore Experience Platform Installation Guide
A progress window informs you of the installation process.
Start the browser and enter the following URL:
http://MySite/sitecore
19
Sitecore Experience Platform 8.2 Update 3
3.3 Troubleshooting
If there is an error during installation
If the installation program fails, a log file is automatically created. You can find the
SitecoreInstaller.log file in the \%Temp%\ folder.
Ensure that you save the log file, and if necessary, attach it to your support request.
Important
The log file is recreated during each installation attempt. If there are errors during installation, you must save
and copy the log file to another location right after an unsuccessful installation. Otherwise, the file will be
overwritten.
"Database '...' cannot be upgraded" error message while using SQL Server
When using SQL Server, the installer returns the "Database '...' cannot be upgraded" error message. To avoid
this, the user account configured to run the SQL server application must have full access permissions to the
website root folder.
Typically, the SQL server application runs in the context of the NETWORK SERVICE account.
For more information, see the section File System Permissions for SQL Server Files.
20
Sitecore Experience Platform Installation Guide
Chapter 4
This chapter describes how to install Sitecore XP 8.2 from the ZIP file of the website root.
Uninstalling Sitecore XP
21
Sitecore Experience Platform 8.2 Update 3
9. In the IIS, configure the website as described in the section Configuring the IIS.
10. Configure the Internet Explorer browser as described in the Browser Configuration Reference manual.
11. Start the browser and enter the following URL:
http://ProjectName/sitecore
22
Sitecore Experience Platform Installation Guide
The Sitecore login screen appears:
23
Sitecore Experience Platform 8.2 Update 3
If IIS is not configured to use the default IUSR account for processing anonymous requests or if Anonymous
authentication is not enabled for the website, the previously mentioned permissions must be granted to the
corresponding account(s).
IIS 7 and later lets you change the user account that is used for processing ASP.NET requests.
If you select a different user account to process the ASP.NET requests, you must also grant this account the
Modify permissions.
24
Sitecore Experience Platform Installation Guide
Note
For more information about application pool identities and specifically about assigning rights to the
AppPoolIdentity account, see the following article: http://learn.iis.net/page.aspx/624/application-pool-
identities/
Note
ASP.NET and/or IUSR account require the modify access rights to the \temp folder to install Sitecore XP.
Note
For more information about built-in groups and accounts in IIS, refer to
http://learn.iis.net/page.aspx/140/understanding-built-in-user-and-group-accounts-in-iis-7/
25
Sitecore Experience Platform 8.2 Update 3
Note
If the required registry permissions are not granted, the “Access to the registry key 'Global' is denied” error will
be registered in the Sitecore log files whenever the application attempts to access Windows performance
counters.
To avoid this error, you must prevent Sitecore from updating the performance counters. To do that, in the
web.config file, set the Counters.Enabled setting to false.
26
Sitecore Experience Platform Installation Guide
3. In the Add Application Pool dialog box, enter the following values:
Field Value
Name ProjectNameAppPool
.NET Framework version 4.X.X
Managed pipeline mode Integrated
4. Click OK.
27
Sitecore Experience Platform 8.2 Update 3
5. In the Application Pools panel, click the application pool you have just created, and in the Actions
panel, click Advanced Settings.
28
Sitecore Experience Platform Installation Guide
2. In the Connections panel, expand Sites.
Field Value
Site name ProjectName
Application pool ProjectNameAppPool
Physical path C:\InetPub\ProjectName\Website
Host name Projectname
5. Click OK.
6. Open the hosts file – C:\Windows\System32\drivers\etc\hosts – and add the following
line:
127.0.0.1 projectname
Now you can access your website by entering the http://projectname address in your browser.
29
Sitecore Experience Platform 8.2 Update 3
\sitecore\admin
\sitecore\debug
\sitecore\shell\WebService
30
Sitecore Experience Platform Installation Guide
Note
If you have one or more processing, dedicated publishing, and/or indexing servers that does not handle
requests, you must ensure that you use Application Initialization (IIS 8.0) or the appropriate module (IIS 7.5),
so you can successfully start Sitecore after you recycle the application pool.
If you do not do this, Sitecore will not be launched and its application pool can be shut down due to inactivity.
31
Sitecore Experience Platform 8.2 Update 3
Note
You can also use Windows authentication to connect to the SQL server. For more information on connecting
to the SQL server, see http://msdn.microsoft.com/en-us/library/ff647396.aspx
6. Select the SQL Server authentication option and clear the User must change password at next
login check box (this option is not supported on some Windows operating systems).
32
Sitecore Experience Platform Installation Guide
7. Click the User Mapping page and in the User mapped to this login field, select the Sitecore
databases.
8. In the Database role membership for field, select the following check boxes:
For the Master and the Web databases:
o db_datareader
o db_datawriter
o public
For the Analytics database:
o db_datareader
o db_datawriter
o public
If you perform historical aggregation:
1) In SQL Server Management Studio, connect to the SQL Server instance that will be used for
Historical Aggregation.
2) Find the database that will be used for Historical Aggregation.
3) Open a New Query window.
4) Execute the following:
GRANT ALTER TO [Username];
GRANT REFERENCES TO [Username];
For the Core database:
o db_datareader
o db_datawriter
o public
o aspnet_Membership_BasicAccess
33
Sitecore Experience Platform 8.2 Update 3
o aspnet_Membership_FullAccess
o aspnet_Membership_ReportingAccess
o aspnet_Profile_BasicAccess
o aspnet_Profile_FullAccess
o aspnet_Profile_ReportingAccess
o aspnet_Roles_BasicAccess
o aspnet_Roles_FullAccess
o aspnet_Roles_ReportingAccess
For the Sitecore.Sessions database:
o db_datareader
o db_datawriter
o public
9. Click OK to create the user.
3. In the Database Properties window, click the Permissions section and select the user that you want
to grant rights to.
34
Sitecore Experience Platform Installation Guide
4. In the Users or roles field, select the user and in the Explicit permissions for field, in the Grant
column, give the user Execute permission.
Important
The analytics database for Sitecore xDB runs on MongoDB. For more information about configuring Sitecore
xDB on MongoDB see the xDB Configuration Guide.
35
Sitecore Experience Platform 8.2 Update 3
36
Sitecore Experience Platform Installation Guide
Note
When you install the Oracle Data Provider in a 64-bit environment, you must use Oracle Client for Windows
x64.
Configure IIS as you normally would for a Sitecore installation, and then run Sitecore.
37
Sitecore Experience Platform 8.2 Update 3
38
Sitecore Experience Platform Installation Guide
Chapter 5
This chapter describes the recommended steps that you should take after installing Sitecore
XP 8.2. rev. 170407 (Update-3).
Content Expiration
39
Sitecore Experience Platform 8.2 Update 3
40
Sitecore Experience Platform Installation Guide
6. Click After, and set the number of days to its default (7).
7. Click OK.
41
Sitecore Experience Platform 8.2 Update 3
2. In the SQL Server, register the domain user and grant the appropriate security permissions to the
Sitecore databases for the domain user.
For more information, see the section. Creating a Database Account for Sitecore XP Databases on SQL
Server.
3. On the computer that hosts Sitecore XP, add the domain user to the IIS_IUSRS group.
Note
You must adjust the permissions for the IIS_IUSRS group according to the instructions in the
sections: File System Permissions for ASP.NET Requests and File System Permissions for System
Folders.
5. Prepare your identity so that it can be used as a service account with the aspnet_regiis.exe file
and the -ga switch.
6. To add your domain service account to the local Performance Monitor Users group, follow the
instructions in the Windows Registry Permissions section.
Note
If you use the Sitecore Experience Database (xDB), the same configuration must be repeated for the
Reporting database. The connection string for the Analytics database must be:
42
Sitecore Experience Platform Installation Guide
<add name="reporting" connectionString="Data
Source=<Data-Source>;Database=Sandbox6_Analytics;Trusted_Connection=Yes" />
43
Sitecore Experience Platform 8.2 Update 3
Compatibility Level
Compatibility Level affects SQL syntax and query parsing, and should have no impact on performance.
Setting the Compatibility Level to a value of SQL Server 2008(100) takes advantage of new T-SQL features,
which are used in many of the scripts/commands.
Auto Close
When MS SQL Server opens a database, resources are allocated to maintain that state. Memory for locks,
buffers, security tokens, and so on are all assigned. These operations take time. The Auto Close property
defines how these resources are handled. If it is set to true or ON, then when the last connection is closed,
these resources are deallocated. If a new connection comes in within a short period of time (1/10 th of a second
or quicker), then all of those resources need to be activated again. Setting the Auto Close property to false or
OFF prevents this from happening.
Auto Shrink
The Auto Shrink property uses many resources when it is called, and you have no control over when it is
called. If you combine Auto Shrink with Auto Growth, you can get into a spiral of constantly growing and
shrinking the database, taking valuable resources away from other database tasks as well as causing
fragmentation issues. If a database or file requires a SHRINK command, it should be done via a script, a
command, or a scheduled maintenance plan. Setting the Auto Shrink property to false or OFF disables this
feature.
Recovery Model
In the Simple Recovery Model, MS SQL Server records a minimal amount of information in the transaction
log. MS SQL Server truncates the transaction log whenever the transaction log becomes 70 percent full or the
active portion of the transaction log exceeds the size that MS SQL Server can recover in the amount of time
that is specified in the Recovery Interval server level configuration. Setting the Recovery Model to Simple has
the lowest amount of overhead compared to Full and Bulk-logged, which is crucial to the performance
requirements needed for the Sitecore XP databases.
To configure all these Microsoft SQL Server database properties to improve performance:
1. Open MS SQL Server Management Studio.
2. In the Object explorer, right click the CMS Master database and click Properties.
3. Click the Options page and set the following parameters:
o In the Compatibility Level field, select SQL Server 2008(100).
o Set the Auto Close property to false.
o Set the Auto Shrink property to false.
o In the Recovery Model field, select Simple.
44
Sitecore Experience Platform Installation Guide
4. Click OK.
Repeat these steps for the Sitecore Core and Web databases.
45
Sitecore Experience Platform 8.2 Update 3
46
Sitecore Experience Platform Installation Guide
Note
If you do not plan to use Sitecore xDB, you do not have to perform these steps.
Note
You can create a database account with the minimum required permissions for the Analytics
database as described in the section Microsoft SQL Server Configuration.
Install MongoDB – download and install the latest version of MongoDB. For more information on
how to install MongoDB, see http://docs.mongodb.org/manual/.
Configure Sitecore to use Mongo databases – perform the actions outlined in the following
procedure for each Mongo server.
To configure Sitecore to use Mongo databases:
1. In the ConnectionStrings.config file, specify the connection strings to your MongoDB
server:
<add name="analytics" connectionString="mongodb://localhost/analytics" />
<add name="tracking.live" connectionString="mongodb://localhost/tracking_live" />
<add name="tracking.history" connectionString="mongodb://localhost/tracking_history"
/>
<add name="tracking.contact" connectionString="mongodb://localhost/tracking_contact"
/>
Important
To ensure that hashing is secure, you must also change the default salt value in the
Sitecore.Analytics.config file, in the geoIpManager section.
47
Sitecore Experience Platform 8.2 Update 3
Note
If you do not plan to use Sitecore xDB, you do not have to perform these steps.
2. In the Deploy marketing definitions dialog box, select all the definitions and taxonomies and click
Deploy.
48