Upgrading the Ektron Windows Service

  • Updated

Certain issues may be resolved by upgrading the Ektron Windows Service, to take advantage of recent enhancements. The need to upgrade is most frequently associated with eSync issues.

Follow these steps on all servers in the eSync configuration. Please note the service cumulative update instructions are below the service pack instructions. If upgrading the Ektron Windows Service to version 9.3 or higher and still leveraging the server for sites older than version 9.3 EnableNonSSLEndpoints within the \\Program Files (x86)\Ektron\EktronWindowsService40Ektron.ASM.EktronServices40.exe.config file will need to be set to true on all environments involved directly or indirectly in a sync relationship. this would look like the following.

<add key="EnableNonSSLEndpoints" value="true" />

Please see the following KB when upgrading to 9.3SP2 Service Cumulative Update 02 and higher versions(including 9.4+) for additional considerations such as a required discard and regeneration of security certificates. 

https://support.episerver.com/hc/en-us/articles/360007345352-Esync-and-version-9-3-Considerations-and-issues-for-new-and-older-versions

 

Installing a new service pack

  1. Get the latest base installer from the help center download page.
  2. Stop the Ektron Windows Service 4.0.
  3. Rename the C:\Program Files (x86)\Ektron\EktronWindowsService40 folder to something like EktronWindowsService40-8.6SP1.
  4. Make backup copies of these folders.
     C:\Program Files (x86)\Ektron\EktronDiagnosticsService
    C:\Program Files (x86)\Ektron\EktronNotificationService 
  5. Run the installer.
  6. Click No to check for Updates. You must install .NET 4.5 if it is not already present.
  7. Select the Upgrade setup type.
  8. After the base (core) section is complete ("Thank you for installing CMS400") and the installer begins the web site portion, cancel the installer.
  9. Copy the certificate files (*.cer,*.pfx, and *.pvk) from the backup folder that you renamed in Step 3 to the new C:\Program Files (x86)\Ektron\EktronWindowsService4 folder.
  10. Open the backup and new Ektron.ASM.EktronServices40.exe.config files. In the backup file, locate the section that begins with
    <ektron.serviceModel>
  11. Copy that entire section to the new config file, overwriting the section of the same name.
  12. Check the following keys and set according to your Ektron load balance configuration.

    <add key="LoadBalanced" value="0"/>
    <add key="AssetsLoadBalanced" value="0" /> (AssetsLoadBalanced is a new key. Set to 1 if you use load balancing.)
    <add key="LibraryLoadBalanced" value="0"/>
    <add key="LoadBalServerCount" value="2"/>
    (AssetsLoadBalanced is a new key. Set to 1 if you use load balancing.)
  13. Close the backup copy.
  14. In the new config file, locate these keys and set all values to false:
    <add key="UseFileHashForFolderSyncChangeDetection" value="false"/>
    <add key="UseFileHashForFilteredFolderSyncChangeDetection" value="false"/>
    <add key="EnableSiteFileHashIndexingAtStartup" value="false"/>
  15. Save the file.
  16. Stop and start the Ektron Windows Service 4.0.
  17. Check the EktronL4 event log to ensure there are no warnings or errors.

Installing a service cumulative update

  1. Get the service CU from the help center download page.
  2. Stop the Ektron Windows Service 4.0.
  3. Backup the following folders
    C:\Program Files (x86)\Ektron\EktronWindowsService40
    C:\Program Files (x86)\Ektron\EktronDiagnosticsService
    C:\Program Files (x86)\Ektron\EktronNotificationService
  4. Run the installer.
  5. Stop and start the Ektron Windows Service 4.0.
  6. Check the EktronL4 event log to ensure there are no warnings or errors.