Installation instructions – EPiServer 7.5 Mail

Table of contents

Introduction

This document describes a first time installation of the EPiServer 7.5 platform and EPiServer Mail. Installation of EPiServer Mail to the EPiServer Deployment Center is done through the EPiServer Relate installation package. From Deployment Center, you can then install an EPiServer CMS site with the Mail component.

Prerequisites

  • Check the system requirements for EPiServer 7.5 Mail before you start the installation, to ensure that the system requirements are met for the target environment.
  • EPiServer Mail requires a running EPiServer CMS site prior to installation.

Installing Episerver 7.5

This section describes the installation of the Episerver 7.5 platform to Episerver Deployment Center, from where you will manage further product installations and upgradings.

The zipped file package contains the following:

  • Setup.exe - executable file which checks and installs required components.
  • Setup.exe.config - configuration file for setup.
  • EPiServerShared.msi - components shared by all EPiServer products.
  • EPiServerSearch.msi - the EPiServer search feature included by default.
  • EPiServer.Framework.msi - components for the EPiServer platform foundation.
  • EPiServerCMS.msi - components for EPiServer CMS.
  • EPiServerCommerce.msi - components for EPiServer Commerce.
  • EPiServerCommerceSample.msi - sample site for EPiServer Commerce.
  • EPiServerRelate.msi - components for EPiServer Relate.
  • EPiServerCommunity.msi - community part of EPiServer Relate.
  • EPiServerMail.msi - components for EPiServer Mail.
  • EPiServerCMO.msi - components for EPiServer CMO.
  • Live Monitor.msi - components for Live Monitor.
  • Powershell Redist - Microsoft Powershell installation files. 

Install EPiServer 7.5 as follows:

  1. Download the installation package and extract the files included.
  2. Run the Setup.exe file.
         
       
        
  3. Select the desired components to install and click OK:
    Install CMS - installs Episerver CMS (default since this is required for all).
    Install Relate - installs Episerver Relate (Community), including EPiServer Mail.
    Install CMO - installs Episerver CMO.
    - Install Commerce - installs Episerver Commerce.
    - Install Commerce Sample - installs Commerce sample site.
    Create Alloy Demo Site - express installation creating a website based on the Alloy sample templates.

  4. Accept the End User License Agreement terms and continue.
         
  5. The installation will start by checking if the required software components and versions are installed on your machine. If any of the components are missing, a dialog will appear informing you of the software that is required to be installed or updated. When the required software has been verified the installation will continue.
       
  6. When the platform installation has finalized, continue the installation of desired components as described below.

Other

If you chose to install the Alloy demo site for CMS, the website will open in a browser. See below for information on how to log in. Refer to Modules and Alloy Templates Configuration for more information, if you plan to do development on the Alloy templates, or if you want to install modules on a site with the Alloy templates installed.

Refer to Setting up IIS for EPiServer for information on how to configure IIS for Episerver.

License management

Licenses for all Episerver products are stored in a shared file called License.config. Visit the Episerver License Center to download a license. During installation of Episerver products, the license file will be added to the site root where it will be picked up by all products.

Installing EPiServer 7 Mail

When installing EPiServer 7.5 in the previous step, you select the Install Relate option when running the Setup.exe file. This will install the EPiServer Mail components in Deployment Center. As certain components are shared between Mail and the Relate community module, a new separate database with required tables and stored procedures will automatically be installed for Mail, if the community module is not already installed.

Install Mail as follows:

1. Open EPiServer Deployment Center and select the website to which you want to install Mail.

2. Select EPiServer Mail and expand the appropriate version to see the options.

3. Select Install Mail on existing site and click Run to start the installation.

4. Select the desired site on which to install EPiServer Mail, and click Next to continue.

5. Select the authentication mechanism the installer should use. The Windows Authentication option (default) will use the credentials of the user running EPiServer Deployment Center. The SQL Server Authentication option is used when SQL Server is located on a different machine. Selecting this option you can specify a login and password to be used. Click Next to continue.

6. Create a user and the password that will have the role of Administrator for the EPiServer Mail database. If you do not use the WindowsRoleProvider to authenticate logging in to EPiServer CMS, then the user created here will need to be used. Enter Administration account username/password. Click Next to continue. Note that the credentials created here are only valid using the EPiServer Common membership provider.

7. In the next step you will configure the SMTP server settings, and here it is important that the SMTP server you configure allows relaying from this server. Click OK to confirm the message displayed. Enter values as follows:

  • Outgoing Order Mail settings
    SMTP server: Enter the name of the SMTP Server instance to use and the Port number. This is the mail server from where the e-mail messages will be sent - if it is the same server as where the EPiServer CMS website resides, entering localhost should be sufficient.
    Authentication: None, AuthLogin, CramMD5. Determines the connection authentication.
    Username/Password: If required add username and password.
    From address: e-mail address from where the e-mail messages are sent.
  • EPiServer Mail Editor environment settings
    Website URL: web address of the site you will be running EPiServer Mail from.
  • Default values when creating a mailing
    From address: e-mail address that is visible in the sent e-mail messages (can be used to mask the e-mail address from where the e-mail messages are sent ).
    From name: name of the sender of the e-mail messages.
       
      
    Replace the default values with the values for your mailing settings and click Next to continue.

8. A summary page for the installation will be displayed where it is possible to return to previous steps to change the setup. Click Install to start the installation and let it finalize.

9. When the installation has finalized, open the website in a browser and verify the installation of EPiServer Mail.

Managing authentication

You need to create the groups MailAdmins and MailEditors in the EPiServer CMS administration interface to be able to set access rights for EPiServer Mail users. Refer to the user documentation for EPiServer CMS for more information on access right management.

Preventing SPAM filtering

This section describes how to prevent mailings distributed by EPiServer Mail to be caught in SPAM filters. If you have an SPF record in DNS for the domain of your sender e-mail address (From address), add include:_cluster1.episervermail.episerver.com to that record. For example, if no-reply @example.com is used as your sender e-mail address the DNS for example.com is subject for this addition.

If you do not yet have an SPF record it is still advisable to add one, allowing your regular SMTP servers as well as the include directive for the EPiServer Mail cluster. See http://www.openspf.net/ for further information.

Other installation options

Installing EPiServer Mail without a database (when mirroring)

Choose this option if you want to install EPiServer 7 Mail without a database. Except for step 5 and 6, the installation procedure is identical to the one for installing EPiServer Mail on an existing website, described above.
Target platform is EPiServer with load balanced environments, with a single database with tables and stored procedures which support the needs of EPiServer Mail. This installs all components required for an EPiServer Mail instance to work, but installs no databases and makes no database changes.

Installing an SQL Server database

Choose this option if you want to install a database for EPiServer Mail. For the SQL Server part, refer to the installation instructions for CMS. This option is suitable when using multiple instances of EPiServer Mail in a load balanced environment (without a suitably configured database). The procedure installs the database, along with database tables and stored procedures supporting the needs of one or more EPiServer Mail instances.

Activating an account

To run EPiServer Mail you need an EPiServer Mail account. Accounts can be activated for either a development environment, or a production environment. Refer to Activating EPiServer Mail for more information. You also need a license for EPiServer CMS.

Upgrading

For instructions on breaking changes and how to upgrade between versions, refer to the Upgrading section of the SDK for EPiServer Mail.

Last updated: November 30, 2012