EPiServer CMS 6.0
Document last saved:
Installation of EPiServer CMS is achieved with EPiServer Deployment Center, which is used to install and maintain EPiServer products.
This document describes how to install, upgrade and delete EPiServer CMS 6 and its components.The EPiServer CMS 6 installation comprises of EPiServer CMS 6 assemblies and various components for installation of Web sites. The Express Installation is a "one click installation" scenario - making it very quick and easy to install a first version of EPiServer CMS.
EPiServer Deployment Center is based on PowerShell Scripts, which makes it easy for any third party company to use the same installer for their products as well.
EPiServer CMS 6 can be found in the download section - here on EPiServer World. Included in the downloaded EPiServer CMS 6 file are the Microsoft Installer files and the Setup.exe. Running the "Setup.exe" file will start the installation of the various components, the EPiServer Deployment Center and optionally a database and an example Web site. The EPiServer Deployment Center also supports installation of other EPiServer modules, packages and connectors
After setup of EPiServer CMS 6 is complete, installation of the integrated Visual Studio 2008 tools and EPiServer CMS 6 SDK can be carried out. This is performed by running the EPiServerVsIntegration.msi file that is part of the installation package.
Here is an overview of the EPiServer CMS 6 installation components:
If during EPiServer CMS installation Microsoft Windows Powershell is not found on the target machine then the EPiServer CMS installer will install it as part of the installation process. EPiServer Shared Components will be installed as well as database and Web site creation - if opted for. When performing a first installation the followling steps should be carried out:
Selecting an "Express" installation will create a sample Web Site on the local machine without dialog interaction. The file structure of this Web Site should be similar to the image below. The EPiServer CMS 6 installation file structure is described in the section EPiServer Structure On Disk.
To perform an Express Installation an SQL server is required to be installed on the local machine otherwise the option will be disabled - see the system requirements concerning which SQL Server databases are supported.
Currently an express installation is only available when you you install EPiServer CMS 6 for the first time. Though it is possible to carry out an express installation from a command prompt, see this blog post for further information.
After selecting "Custom" complete the additional steps that are required:
Installation of Live Monitor in EPiServer CMS 6 is performed separately - download and run the Live Monitor msi file - see the Live Monitor 2.0 Installation Instructions.
Choosing "Application Files" will only deploy EPiServer CMS components on the target machine. Selecting this will not give you any more options in the wizard.
When opening the EPiServer Deployment Center, the different versions of EPiServer CMS currently installed on your machine will be listed. The EPiServer CMS Web sites currently on the machine will be listed under the relevant version of EPiServer CMS. Select the task you wish to perform on a listed Web Site and click on the Run button.
Choose this option if you wish to delete a Web site and optionally its database, users and VPP.
For information see the document EPiServer CMS Mirroring 2.0.
Choosing this option install the EPiServer CMS Public Templates on an existing website.
Choosing this option installs a Web site with a database. Most of the steps for this option are identical to that when performing a Custom Installation. See the information from Step 2 in the Custom Installation section.
Choosing this option installs EPiServer CMS application files and VPP folders without installing a database. Most of the steps for this option are identical to that when performing a Custom Installation - though not Step 3 (select/create database) . See the information in Step 2 and from Steps 4 to 6 in the Custom Installation section.
Choosing this option installs a database with EPiServer CMS schema only. The steps for installing a database only are the same as Steps 3 and 7 in the Custom Installation section except that you can not choose an existing database.
Migrates the data in the EPiServer CMS website from version 5.2 format to version 6.0
Upgrades a website and SQL Server database EPiServer CMS 5.2 SP2 to EPiServer CMS 6.0
It is possible to configure EPiServer CMS 6 with an Oracle database. See the document Configuring EPiServer CMS with an Oracle Database for further information.
Code examples for the new EPiServer CMS 6 functionality are available, see the following:
An SDK for EPiServer CMS 6 is not available.
The EPiServer CMS 6 SDK (.chm) help-file is installed on your machine after running the EPiServerVsIntegration.msi file. It should be listed with the EPiServer Deployment Center (..\Program Files\EPiServer). The SDK documentation is also available online - EPiServer CMS 6 SDK .
The EPiServer CMS integrated Visual Studio 2008 tools are also installed after running the EPiServerVsIntegration.msi file. These consist of the EPiServer project template and the following templates for EPiServer CMS 6 development - page template, GUI plugin, Web user control and custom property.
For information regarding installation of your own module see Fredrik Tjärnberg's article. This article introduces the Visual Studio project template for download (that builds upon Windows Installer Xml (WiX)) that will help you create your own module installation package for EPiServer CMS.
IIS 7 requires you to select exactly which modules you wish to run on your Web Server. If IIS7 has not been configured, the Deployment Center will give the option to install all the IIS features needed for running EPiServer CMS 6. Here is a list of recommended Role Services that should be installed to successfully deploy EPiServer CMS 6:
Installing EPiServer CMS is built on Windows Installer to support installation, uninstallation, component upgrade as well as component and installation integrity. Windows Installer has built in support for User Account Control and requests user elevation when necessary (Vista and WS 2008). We use windows installer technology for deploying files, updating registry and checking prerequisites. As a final step depending on user input during the installation wizard the windows installer can call into EPiServer Deployment Center (see below) for performing site creation and deletion (during uninstall).
We use windows installer technology for deploying files, updating registry and checking prerequisites.In order to get a running site a new tool called EPiServer Installation Manager (EPiServerInstall.exe) is used.
In order to get a running site a new tool called EPiServer Deployment Center (EPiServerInstall.exe) is used. This tool launches Windows PowerShell and executes one of several predefined scripts. The idea is that we want a script based configuration of the site since it is easier to maintain over time and also provides a way for partners and customers to customize the way an EPiServer CMS site is created / deleted or how an EPiServer CMS module is applied. Modules packages e.g. Public Templates which comes with a default EPiServer CMS installation can provide their own logic to be executed by the installer. EPiServerInstall can be run in interactively or from the command line. When launching it without parameters it will show a UI presenting all available scripts to execute for each individual version of EPiServer CMS.
This executable is responsible for checking and installing some prerequisites such as Windows PowerShell and IIS (if not present on the target machine) and for launching windows installer installations. It also migrates unregister older version of the EPiServer Services (Scheduler, Indexing and Log services) and migrating the configuration to the new services for R2.
If you wish to change, repair or remove the EPiServer CMS 6 installation then click on the Setup.exe file and then Next. The Dialog below will then appear. Click on the appropriate button.
Below is an example of a EPiServer file structure layout:
When the installation fails for some reason and you don't get a satisfying indication why it failed it might be a good idea to take a look at log files.
There are different log files involved when installing EPiServer CMS:
The installation manager logs all its activity in %ProgramFiles%\EPiServer\Shared\Install\Logs
Setup.exe will log everything by default. The result is three log files located in the same directory as the Setup.exe files.
Since the VS tools for EPiServer are installed using a windows installer file you need to launch the installation from the command line to turn on logging. The following command should help:
msiexec /i EPiServerVsIntegration.msi /lv VsInstallationLog.txt
The EPiServerVsIntegration cannot be installed side by side with an old version, and before installing the new version this has to be done:
• First uninstall the old version
• Then, go to "C:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\ProjectTemplatesCache\CSharp\EPiServer" and remove "EPiServerProject.zip".
• Install the new version
If you experience problems opening the Public Templates Project in Visual Studio 2008 you may wish to try the following:
If you have created an empty Web site and are experiencing problems entering Edit/Admin mode in the Web config file verify that pageStartId is set to a positive value.
Reboot the system if the installation does not appear to be operating correctly.
When upgrading databases to EPiServer CMS 6 containing large amounts of xform postings you may run into problems with SQL command timeouts. These problems occurs during the migration process of xform postings from object store to the dynamic data store.
To resolve these issues there are some steps you need to carry out the following:
CREATE NONCLUSTERED INDEX [IX_tblItem_SchemaId] ON [dbo].[tblItem]
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, SORT_IN_TEMPDB = OFF, IGNORE_DUP_KEY = OFF, DROP_EXISTING = OFF, ONLINE = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
<!-- Change command timeout to 5 minutes -->
<add key="commandTimeout" value="300"/>
See breaking changes in EPiServer CMS 6.
See the relevant documentation for the Demo Templates package for EPiServer CMS 6.
See the FAQ which contains information regarding the error operation on a socket.
The setup program will install PowerShell when it is missing on the target machine. The PowerShell installation is launched without a UI and if anything goes wrong the setup program only reports that PowerShell installation failed. When this happens it can be useful to launch the PowerShell installation manually to find out more about why it is failing.
The PowerShell redist folder inside the installation folder contains all installers for all supported platforms except Windows Server 2008. The following table shows which installer to use on for a given platform.
|Windows Vista 64 bit
|Windows Vista 32 bit
|Windows Server 2003 64 bit
|Windows Server 2003 64 bit Itanium
|Windows Server 2003 32 bit
|Windows XP 64 bit||WindowsServer2003.WindowsXP-KB926139-x64-ENU.exe|
|Windows XP 32 bit||WindowsXP-KB926139-x86-ENU.exe|
|Windows Server 2008 32 bit|
|Windows Server 2008 64 bit|
On Windows Server 2008, PowerShell is enabled by executing the following command:
You can also report bugs to the EPiServer Developer Support (this requires partner access).