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 2008 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 3.5.1 Feature
    • WCF Activation
      • HTTP Activation
      • Non-HTTP Activation
    • Web Server (IIS) Role
      • Common HTTP Features
        • Static Content
        • Default Document
        • HTTP Errors
      • Application Development
        • ASP.NET (3.5)
        • .NET Extensibility (3.5)
        • 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 SharePoint Shell.
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.


Upgrade

Extract EasyBox_v.1.7.x.zip to a location on the disk and then follow the instructions for each component below.
Then in the powershell window run Import-Module <path to Edc.EasyBox.Installer.dll>


Service

To upgrade the EasyBox Service, you must have already imported the EDC.EasyBox.Installer.dll assembly. You then must perform a Uninstall-EasyBoxService command followed by Install-EasyBoxService. The parameters required for Install-EasyBoxService can be found here.


Uninstall EasyBox Service Parameters:

  • ApplicationPoolName
    • Required: No
    • Description: The application pool associated with the EasyBox Service site.
    • Default Value: EasyBox Service Application Pool
  • SiteName
    • Required: No
    • Description: This is the EasyBox Service site name located in IIS..
    • Default Value: EasyBox Service
  • SitePath
    • Required: No
    • Description: This is the VirtualPath directory that is associated with the EasyBox Service.
    • Default Value: C:\inetpub\easyboxservice

Note: Do NOT use the Upgrade-EasyBoxService command due to that being used for development only. You should also take a backup of the existing service web.config or take note of the location of the EasyBox Database and the HTTP/TCP bindings associated with your existing service.


 

Web Front End

To Upgrade the EasyBox Web Front End component, you must first uninstall the existing version by invoking the Uninstall-EasyBoxWFE command and then install the new version with the Install-EasyBoxWFE command. The parameters required for Install-EasyBoxWFE can be found here.



Note: It is always best practice to take a backup of the existing web application web.config for rollback purposes BEFORE beginning the process of uninstall/upgrade.



Uninstall EasyBox Web Front End Parameters:

  • WebApplication
  • FlushArtifacts
    • Required: No
    • Description: Used to clean up expired assembly files.
  • ScanUtility
    • Required: No
    • Description: Used to locate expired assembly files. Does not remove the found artifacts.



Note: To guarantee that there are no remaining expired artifacts after uninstall, it is recommended to purge the artifacts using the Uninstall-EasyBoxWFE -FlushArtifacts command.



Example(s):


     Uninstall-EasyBoxWFE -WebApplication http://playgroundwebapp

     Uninstall-EasyBoxWFE -FlushArtifacts



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.