EPiServer CMS 5 R2
Document last saved:
Installation and upgrade of EPiServer CMS 5 R2 is carried out with the new EPiServer CMS 5 Installation Manager which is encapsulated within a standard MSI-package in the download package. This document describes how to install, upgrade and delete EPiServer CMS 5 R2 and its components.
The EPiServer CMS 5 R2 installation comprises of EPiServer CMS 5 R2 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.
The Installation Manager is also the fundamental for future product installations. It 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 5 R2 can be found in the download section - here on EPiServer World. Included in the downloaded EPiServer CMS R2 zip 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 Installation Manager and optionally a database and an example Web site.
After setup of EPiServer CMS 5 R2 is complete installation of the integrated Visual Studio 2008 tools and EPiServer CMS 5 R2 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 R2 installation components:
One of the major new features in EPiServer CMS 5 R2 release is the installer. 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 5 R2 installation file structure is described in the section EPiServer Structure On Disk.
Currently an express installation is only available when you you install EPiServer CMS 5 R2 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:
Choosing "Application Files" will only deploy EPiServer components on the target machine. Selecting this will not give you any more options in the wizard.
When opening the EPiServer Installation Manager the different versions of EPiServer CMS currently installed on your machine will be listed. The EPiServer 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.
Choosing this option imports the EPiServer Public Templates.
Choose this option if you wish to delete a Web site and optionally its database, users and VPP.
Choosing this option installs a database only. The steps for installing a database only are the same as Steps 2 AND 7 - documented in the Custom Installation section.
Choosing this option installs a Web site without 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 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.
Choose this option if you wish to upgrade from a EPiServer CMS R1 SP2 Web site to a EPiServer CMS R2 Web site.
Note! After upgrading, in the web.config make sure that the StaticFileHandler is not placed above other handlers. Requests for other handlers will be overriden and prevent them from working. Too prevent this, you can place StaticFileHandler at the bottom of the list manually.
Note! The EPiServer Migration Tool RC1 is available - migrating an EPiServer CMS version 4.62 site to a EPiServer CMS 5 R1 SP2. See the tech note for the EPiServer Migration Tool.
It is possible to configure EPiServer CMS 5 R2 with an Oracle database. See the document Configuring EPiServer CMS R2 with an Oracle Database for further information.
The EPiServer CMS 5 R2 SDK (.chm) help-file is installed on your machine after running the EPiServerVsIntegration.msi file. It should be listed with the EPiServer Installation Manager (..\Program Files\EPiServer). The SDK documentation is also available online - EPiServer CMS 5 SDK .
The EPiServer 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 5 R2 development - page template, GUI plugin, Web user control and custom property.
For information regarding installation of your own module see Fredrik Tjärnberg's blog post. This blog post also includes a 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 5 R2.
IIS 7 requires you to select exactly which modules you wish to run on your Web Server. Here is a list of recommended Role Services that should be installed to successfully deploy EPiServer CMS:
Installing EPiServer 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 Installation Manager (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 Installation Manager (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 site is created / deleted or how an EPiServer 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 5 R2 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
If you experience problems opening the Public Templates Project in Visual Studio 2008 you may wish to try the following:
See breaking changes in EPiServer CMS 5 R2.
The Demo Templates package for R2 is now released, see the Demo Package Installation Instructions for further information. The EPiServer Demo Templates package for R1 is not completely compatible with EPiServer CMS 5 R2. For more information see the IPageStore removed forum thread regarding this.
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|
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).
» EPiServer CMS 5 R2 - Release Notes
» Breaking Changes in EPiServer CMS 5 R2
» Changes Between IIS6 and IIS7
» EPiServer CMS Dynamic Content
» Page Providers
» Configuring the Image Service
» Configuring EPiServer Enterprise
New file structure
The new installation procedure for EPiServer CMS 5 R2 will change the file structure of the Web site.
Consequences for Web sites based on the Demo Package R1
Note that changes has been made to the platform that may affect Web sites that are based on Demo Package R1.