Jump To:


Prerequisites

Each component of EasyBox has a different set of prerequisites. However, at a minimum, all servers should be installed with Windows Server 2012 R2.

It is recommended that you update your servers as frequently as possible to address any inherent issues with the systems that EasyBox is installed on.


Database

To deploy the EasyBox Database you must have the following software and features installed on the server:


Service

To deploy the EasyBox Service you must have the following roles and features installed on the server:

  • .NET Framework 4.6.1
    • WCF Activation
      • HTTP Activation
  • Web Server (IIS) Role
    • Common HTTP Features
      • Static Content
      • Default Document
      • HTTP Errors
    • Application Development
      • ASP.NET (4.6)
      • .NET Extensibility (4.6)
      • ISAPI Extensions
      • ISAPI Filters
    • Management Tools
      • IIS Management Console


The roles and features listed above can be installed using the Server Manager wizard.


Web Front End

To deploy the EasyBox Web Front End, you must have the following installed on the server:


PowerShell

To use the installer cmdlets, you must will be using the EDC.EasyBox.Installer module in PowerShell.
You must be using PowerShell Version 2. To check if you have the required version, you can use the $psversiontable command. If Version 2 is not currently running in the shell, you can invoke powershell.exe -Version 2.

To use the following cmdlets, you must invoke the cmdlets on the local machine that you would like to install, uninstall, or upgrade. This will not work across network.


Installation

Extract EasyBox_v.1.7.x.zip to a location on the disk and the follow the instructions for each component below. If the file was downloaded with Internet Explorer, ensure the file is not blocked.
Then in the powershell window run Import-Module <location of EDC.EasyBox.Installer.dll>


Database

To Install the EasyBox Database, you must have already imported the EDC.EasyBox.Installer.dll assembly. You then specify the cmdlet name Install-EasyBoxDatabase followed by the necessary and optional flags. The table presented below describes the many flags that can be used to install the EasyBox Database. The parameters mandatory to be able to invoke this cmdlet are labeled as True in the Required column. All others are optional. Following the table is an example that you can use to get started with the installation of the EasyBox Database.


Parameters:

  • SQLServerName 
    • Required: Yes
    • Description: The fully qualified name of the SQL Server
    • Default Value: EasyBox_Application_DB
  • DatabaseName 
    • Required: No
    • Description: The EasyBox database name This must match the database name in the service web.config
  • EasyBoxDatabaseDefinition
    • Required: Yes
    • Description: The path to the .sql script file containing the database definition.
  • DomainAccount
    • Required: Yes 
    • Description: Service account used by the EasyBox Service to access the database. This is typically the application pool account of the EasyBox Service
  • Password 
    • Required: Yes
    • Description: The password associated with the service account that was specified


    Note: The script does not create the service account, it only uses it. Please make sure the account used has already been provisioned before running this script


    Example: Install-EasyBoxDatabase -SQLServerName sqlserver.dev.local -DatabaseName EasyBox_Application_DB -DomainAccount DEV\easybox.svc -Password P@ssw0rd! -EasyBoxDatabaseDefinition "C: \EasyBox v1.7.0\Database\EasyBox_Application_DB.sql"


Service

To Install the EasyBox Service, you must have already imported the EDC.EasyBox.Installer.dll assembly. You then specify the cmdlet name Install-EasyBoxService followed by the necessary and optional flags.

The parameters mandatory to be able to invoke this cmdlet are labeled as True in the Required column. All others are optional. Following the table is an example that you can use to get started with the installation of the EasyBox Service.


Parameters:

  • EasyBoxServiceSourceFolderPath
    • Required: Yes
    • Description: The path of the EasyBox Service files. This is usually /Service folder under the extracted path
  • ApplicationPoolName
    • Required: No
    • Description: The canonical name of the IIS Application Pool used by the EasyBox service
    • Default Value: EasyBox Service Application Pool
  • HTTPDiagnosticPort
    • Required: No
    • Description: The port number used to access the EasyBox Diagnostics Interface page
    • Default Value: 60438
  • NETTCPServicePort
    • Required: No
    • Description: The port number used to access the EasyBox Service
    • Default Value: 60439
  • DomainAccount
    • Required: No
    • Description: The IIS Application Pool account under which the service runs
  • Password
    • Required: No
    • Description: The password associated with the service account that was specified
  • DatabaseName
    • Required: Yes
    • Description: The name of the EasyBox database, this is typically EasyBox_Application_DB
  • SQLServerDataSourceFQDN
    • Required: Yes
    • Description: The fully qualified domain name of the SQL Server where the EasyBox database is hosted
  • Default
    • Required: No
    • Description: Quick way to install the EasyBox service with the default values. (This is used for development purposes and not recommended)


    Note: The script does not create the service account, it only uses it. Please make sure the account used has already been provisioned before running this script.
               If you do not use a domain account and password, the cmdlet will use the OOB IIS Application Pool Account that is associated with the system Network Service account (usually NT AUTHORITY\Network Service)


    Example: Install-EasyBoxService -EasyBoxServiceSourceFolderPath "C:\EasyBox v1.7.0\Service" -DatabaseName EasyBox_Application_DB -SQLServerDataSourceFQDN sqlserver.dev.local -ApplicationPoolName "EasyBox Service                        Application Pool" -HTTPDiagnosticPort 60438 -NETTCPServicePort 60439 -DomainAccount DEV\easybox.svc -Password P@ssw0rd!


Web Front End

To Install the EasyBox WFE, you must have already imported the EDC.EasyBox.Installer.dll assembly. You then specify the cmdlet name Install-EasyBoxWFE followed by the necessary and optional flags.

The parameters mandatory to be able to invoke this cmdlet are labeled as True in the Required column. All others are optional. Following the table is an example that you can use to get started with the installation of the EasyBox Service.


Parameters:

  • WebApplication
  • LiteralPath
    • Required: Yes
    • Description: The file path to EasyBox.wsp


    Example: Install-EasyBoxWFE -WebApplication http://companyintranet -LiteralPath "C:\EasyBox v1.7.0\EasyBox.wsp"


Infrastructure Configuration

The infrastructure needs to be configured based on the topology of the deployment. Each deployed component needs to be made aware of a dependent component. For example, the EasyBox Service relies on the EasyBox Database to query for information. Therefore, each service component needs to be made aware of the database. Similarly, the database server will need to authenticate the service component.


Web Front End – Service Configuration

  1. In Central Admin navigate to  General Application Settings > EasyBox Environment Configuration
     
  2. Select the Web Application you would like to deploy the EasyBox Web Front End component to
     
  3. Under deployment location, specify the full URL of a folder where the application pages will be deployed. For example, http://companyintranet/sites/easybox/pages
     
  4. In the service address specify the full service address of the EasyBox Service component. You may use a net.tcp or http address.

  5.  For the Tenant ID, specify an ID that was provided to you during the initial installation of EasyBox. If you do not have access to this information anymore, feel free to create a ticket for this.