EPiServer CMS 5 SP2/SP3 Installation Instructions

Product version:

EPiServer CMS 5 SP2/SP3

Document version:

1.0

Document last saved:

08-05-2008

Introduction

Installation and upgrade of EPiServer CMS 5 is carried out with EPiServer CMS Manager. This document describes how to install, upgrade and delete an EPiServer CMS 5 installation and is based on installation with the most recently released version of EPiServer CMS Manager, in this case 2.0.19.8.

Table of Contents

Online Installation and Upgrade

New EPiServer CMS 5 SP2 Installation

EPiServer CMS 5 SP2 is installed using EPiServer CMS Manager. Follow the instructions below to install a new EPiServer CMS 5 installation when your computer has access to Internet.

NOTE: See the "Installing/Upgrading Oracle Versions of EPiServer" chapter for information on how to install Oracle versions of EPiServer CMS 5. 

NOTE: SQL Server must be installed in "Mixed mode" in order for the installation to run according to the instructions below.

  1. In EPiServer CMS Manager, any existing EPiServer sites are displayed in the folder list. Right-click the folder root and select Install... or click in the toolbar. This opens the wizard that will guide you through your installation.
  2. Browse to your license file and click Next. Alternatively, follow the link if you want to create a time-limited demo license or if you have the license information, but not the file. Only offline installations can be done without defining a license file.
  3. Click Online and select the version that you want to install from the Install version list. The latest version appears at the top of the list. Click Next.
  4. Enter a name for the site to be installed in the Site name box and add a virtual directory name if you wish. Click Next.
  5. In the Database area, select a server that the database you intend using is installed on. If the database is local, i.e. on the same machine you intend installing EPiServer, select (local)(default) in the Port field defines the database server's default port. If you wish to install to another database server port, change the value to the desired port number. Select the name of the database you intend using from the Existing Database list or enter the name of a new database.
    Note that the user running EPiServer CMS Manager must have owner access rights to access the database.
  6. In the User area, select an existing user or create a new user that has owner rights to the database specified above. In the Password box, type the password associated with the specified user. Click Next.
  7. Select the Do not install database check box if you do not wish to install a database for the EPiServer site.
  8. Select a folder where the default Virtual Path Providers will store files. Each VPP will create a child folder under the folder selected in the wizard. Note that VPP folders need to be stored outside of the installation folder thus requiring you to specify a parent folder for them. Note You can specify a default folder for VPPs via the Options dialog in the Tools menu.
  9. Check the settings that you have entered and click Finish to install EPiServer. Click Previous to return to any dialogs to change the information you have entered.

When the installation procedure is complete, a folder has been created under "Program Files\EPiServer\Manager" named Download. This folder contains files that have been downloaded to allow the tool to be installed. It also contains a text file, upgrade.log, which describes the installation procedure. This file can be sent to Support if an error that you require help with has occurred during the installation or upgrade procedure.

Important! If there were no problems during the installation procedure, delete the file "Program Files\EPiServer\Manager\Download\Upgrade.log" from the computer for security reasons. This file contains sensitive information, such as information for connecting to the database.

Upgrade EPiServer CMS 5 Installation Online

Follow the instructions below to upgrade an EPiServer CMS 5 installation when your computer has access to Internet.

  1. In EPiServer Manager, any existing EPiServer sites are displayed in the folder list. Right-click the site to be upgraded and select Upgrade... or click in the toolbar. This opens the wizard that will guide you through your upgrade.
  2. Click Online and select the version that you want to install from the Install version list. The latest version appears at the top of the list. Click Next.
  3. Check the settings that you have entered and click Finish to install EPiServer. Click Previous to return to any dialogs to change the information you have entered.

Offline Installation and Upgrade

EPiServer CMS Manager enables offline installation, which means that EPiServer can be installed on machines that are located behind a firewall and do not, therefore, have access to Internet. Offline installation also allows installation on laptop computers that are not connected to Internet.

In order to install and upgrade EPiServer offline, you must first use EPiServer Manager to create a .pkg file containing the appropriate files. This step is described below.

Create Offline Installation

Follow the instructions below to create the .pkg file that contains the files used to install and upgrade EPiServer CMS 5 offline.

  1. From EPiServer CMS Manager, click Create offline installation... from the Tools menu. This opens the wizard that guides you through the creation of your offline files.
  2. Browse to your license file and click Next. Alternatively follow the link if you want to create a time-limited demo license.
  3. Click New installation or Upgrade.
    If you want to do a new installlation offline, select the EPiServer version you want to install from the drop-down list.
    If you want to upgrade an EPiServer site, select the version to be upgraded in the From Version drop-down list and the version that you want to upgrade to in the To Version drop-down list.
  4. Enter a destination where the .pkg file will be saved. Click Create.

Note Do not rename the .pkg file. The file's name is used to determine the version and type of installation contained in the package.

Installing EPiServer Offline

Follow the instructions below to install a new EPiServer CMS 5 installation when your computer does not have access to Internet.

  1. Create an offline installation .pkg file containing the installation files as described in the "Create Offline Installation" chapter.
  2. Any existing EPiServer CMS 5 sites are displayed in the folder list. Right-click the folder root and select Install…, or click  in the toolbar. This opens the wizard that will guide you through your installation.
  3. Browse to your license file and click Next. Alternatively follow the link if you want to create a time-limited demo license.
  4. Click Offline and browse to the folder that contains the .zip file that you have previously created containing the offline files.
  5. Enter a name for the site to be installed in the Site name box and add a virtual directory name if you wish. Click Next.
  6. In the Database area, select a server that the database you intend using is installed on. If the database is local, i.e. on the same machine you intend installing EPiServer, select (local). (default) in the Port field defines the database server's default port. If you wish to install to another database server port, change the value to the desired port number. Select the name of the database you intend using from the Existing Database list or enter the name of a new database.
    Note that the user running EPiServer CMS Manager must have owner access rights to access the database.
  7. In the User area, select an existing user or create a new user that has owner rights to the database specified above. In the Password box, type the password associated with the specified user. Click Next.
  8. Select the Do not install database check box if you do not wish to install a database for the EPiServer site.
  9. Select a folder where the default Virtual Path Providers will store files. Each VPP will create a child folder under the folder selected in the wizard. Note that VPP folders need to be stored outside of the installation folder thus requiring you to specify a parent folder for them. Note You can specify a default folder for VPPs via the Options dialog in the Tools menu.
  10. Check the settings that you have entered and click Finish to install EPiServer. Click Previous to return to any dialogs to change the information you have entered.

When the installation procedure is complete, a folder has been created under "Program Files\EPiServer\Manager" named Download. This folder contains files that have been downloaded to allow the tool to be installed. It also contains a text file, upgrade.log, which describes the installation procedure. This file can be sent to Support if an error that you require help with has occurred during the installation or upgrade procedure.

Important! If there were no problems during the installation procedure, delete the file "Program Files\EPiServer\Manager\Download\Upgrade.log" from the computer for security reasons. This file contains sensitive information, such as information for connecting to the database.

Upgrading EPiServer Offline

Follow the instructions below to upgrade an EPiServer CMS 5 installation when your computer does not have access to Internet.

Create an offline upgrade .pkg file containing the installation files as described in the "Create Offline Installation" chapter.

  1. In EPiServer Manager, any existing EPiServer sites are displayed in the folder list. Right-click the site to be upgraded and select Upgrade... or click in the toolbar. This opens the wizard that will guide you through your upgrade.
  2. Click Offline and browse to the folder that comtains the .pkg file that you have previously created containing the offline files. The latest version appears at the top of the list. Click Next.
  3. Check the settings that you have entered and click Finish to install EPiServer. Click Previous to return to any dialogs to change the information you have entered.

Deleting an EPiServer CMS 5 Installation

Follow the instructions below to delete an EPiServer installation.

  1. When you open EPiServer CMS Manager, any existing EPiServer sites are displayed in the folder list. Right-click the site that you want to delete and select Delete or click in the toolbar. Note that although EPiServer4 sites are shown in the tree as well they cannot be deleted via this version of the Manager
  2. In the Remove Site Components window, select the parts of the installed site that you want to delete. The default setting is to delete all parts of the site. Clear the relevant check boxes if you do not want to delete the IIS data, database or file structure.
    NOTE:  If you select to delete a database, the database user will not be deleted. Only the login for that user for member of other databases on the server.
  3. Click Delete when you have selected the parts of the site that you want to delete.

Issues When Upgrading to EPiServer CMS 5

We do not currently support the upgrade of entire sites from EPiServer 4.x to EPiServer CMS 5. Data import into EPiServer CMS 5 is supported for EPiServer 4.x export files. This requires your exporting site to run on at least EPiServer 4.61 hotfix 4.


The EPiServer Migration Tool RC1 is available - the Migration Tool migrates an EPiServer CMS version 4.62 site to a EPiServer CMS 5 (SP2) site.  Some work is required to be carried out on the site after using the Migration Tool. Please see the tech note for the EPiServer Migration Tool. 

Install EPiServer with the Development Web Server

Follow the instructions below to install EPiServer CMS 5 with the Development Web Server shipped with Visual Studio 2005.

  1. In EPiServer CMS Manager install a site accordin go the instructions in the next chapter and enter a name for the site to be installed in the Site name box. Point it to a physical directory and append a port number of your choice in the Site URL field, e.g. http://localhost:1020.
  2. Complete the installation as usual.
  3. Install the 2.0 templates as described in the previous chapter.
  4. Open the project file in Visual Studio 2005 and go to the property pages for the project file.
  5. Open the Web tab and type the port number that you entered earlier in the installation process in the Servers area.
  6. Start a debugging session. The development Web server will start and load the setup page.
  7. Install the content and you're ready to work.

Related Documentation

» Configuring EPiServer Enterprise