Installing Zoom Server (Windows Server)

Leave a Comment / By /

Zoom Server is certified to run on Windows Server 2012 and 2016. The following instructions describe how to perform a basic installation of Zoom Server on these systems. This guide assumes that Windows Server has already been installed and configured.

Dependencies

Setup Firewall and ports

The following ports should be opened in the firewall for Zoom access:

PortRequired for desktop accessRequired for web accessDescription
8880YesNoZoom Server
8443YesNoWeb Administration & API access
8873YesYesPreview Server
8983NoNoZoom Curator Service
8874NoNoZoom NonStop Server to Server Data Transfer (HADR)
18880NoNoZoom NonStop Server to Server Control Messages (HADR)
7770YesNoZoom Client Proxy to Adobe plugins
9880Yes*No*SSL Zoom Server
9443Yes*No*SSL Web Administration & API access
8973Yes*Yes**SSL Preview Server
443Yes*Yes**SSL Preview Server
8974NoNo*SSL Zoom NonStop Server to Server Data Transfer (HADR)
8282NoYesArchive Hub
9292NoNo*SSL Archive Hub
5551YesYesEZ Downloader

To test any TCP port’s connectivity, check this article.

*Usually if SSL ports are enabled, their non-SSL counterpart ports can be disabled or blocked by the firewalls.

Desktop access includes Asset Browser, Repository Browser, Zoom plugins, Client Proxy, and EZ client installer. 

Web access includes Web Asset Browser and Web Client.

  1. In the Start menu, navigate to Start > Administrative Tools > Windows Firewall with Advanced Security.
Windows Firewall from Start Menu
Start > Administrative Tools > Windows Firewall with Advanced Security
  1. Click on Inbound Rules.
Inbound Rules - Windows Firewall
Inbound Rules – Windows Firewall
  1. In the Actions sidebar, click New Rule…
  1. In the New Inbound Rule Wizard, select Port.
New Inbound Rule Wizard - Windows Firewall
New Inbound Rule Wizard – Windows Firewall
  1. Click Next.
  2. Under Specific local ports, type 8880,8873,8443.
  3. Click Next.
  4. Select Allow the connection.
  5. Click Next.
  6. Select Domain, Private, and Public.
  7. Click Next.
  8. In the Name field, name the rule Zoom.
  9. Click Next.
  10. Click on Outbound Rules.
  11. Follow steps 3 – 13.

Install Zoom Package

  1. Download the zoom-server-win64.zip from the Evolphin Support Portal website.
    The download link was provided to you in a Support Portal ticket. If you need the download link again, please contact Evolphin Support.
  2. Open the zoom-server-win64.zip file and navigate to the server folder.
  3. Open setup.exe
  4. Follow the instructions of the Zoom installer wizard.
  5. When prompted to restart the computer, select Yes to restart the computer.
  6. Once your computer has restarted and you are logged in, you should see the web browser window with the Zoom Web Management Console open. If the web browser is not open, navigate to http://localhost:8443.
Web Administration Console Login
Web Management Console Login
For information on how to start and stop services for a Linux  Server, see Starting and Stopping Zoom Services (Linux)

Zoom has various services for its MAM, Preview, Curator, and HADR Servers. You may use one or more of these on the servers for Zoom. If multiple services are running on a server then it is recommended to follow an order while starting, restarting, or stopping them.

The recommended order to start/restart services is:

  1. Zoom HADR Service – for Zoom NonStop Servers
  2. Zoom Services – for Zoom MAM Server and Zoom NonStop Servers
  3. Zoom Preview Service – for Preview Server, Transcoder, Ingest Server
  4. Zoom Curator Service – for Curator Server

Stop the services in the reverse order.

The following instructions describe how to safely stop and start Zoom Services on Windows Server 2008 and 2012.

Start (or Restart) services

Follow these steps to start  or restart services for any server running Zoom:

  1. Go to Start > Administrative Tools > Services
  2. In the list of Services, find the services for Zoom that you would like to start or restart.
  3. Right-click on each service as per the order mentioned above, and select Start (or Restart).
Start Zoom Service - Windows Services
Start Zoom Service using Windows Services

Stop services

Follow these steps to stop services for any server running Zoom:

  1. Go to Start > Administrative Tools > Services
  2. In the list of Services, find the services for Zoom that you would like to stop.
  3. Right-click on each service and select Stop.
Stop Zoom Service - Windows Services
Stop Zoom Service using Windows Services

Other Services in Windows

These services are accessed from Windows Services for Zoom or related products:

ServerService Name
Zoom ServerZoom Service
Preview ServerZoom Preview Service
Curator ServerZoom Curator Service
Zoom NonStopZoom HADR Service
HubEvolphin Job Hub
EZEvolphin Zoom Updater

Configure Network Settings

Zoom Database & Preview Service Network Settings

Updating additional services and features

Curator (enhanced searching) 

For the full details on this service please visit: https://evolphin.com/help/docs/curator-configuration/

Installing the service

  1. From the Windows Command Prompt, cd to the directory Zoom_Installation_Directory/bin/
  2. The Curator service can be installed as a Windows service using the following command:
    • curatorserver install
  3. After the service installation, Zoom Solr Service can be controlled (start, stop, restart, etc.), like other Zoom services, from the Windows Services Manager or Task Manager.
  4. Alternatively, the Curator service can be controlled using the following commands, from the Command Prompt:
    • curatorserver start (Start the Curator service)
    • curatorserver stop (Stop the Curator service)
    • curatorserver restart (Restart the Curator service)
  5. To uninstall Curator as a Windows services, use the following command in the Command Prompt:
    • curatorserver remove

Configuring the service

For Curator configuration on a Zoom HADR setup, refer to the article on Setup of Curator with HADR.

These additional initial configuration steps are only needed when the Curator service is being set up on a separate machine. If the Curator service is to be run on the same machine installation as the Zoom service, then skip to the next section.

  1. Manually edit the Zoom_Installation_Directory/conf/server.xml on the Zoom server in the following manner.
    • Open the server.xml in a text editor.
    • In the editor, move to the ftsSpec section.
    • Set the host tag value to the Curator service machine’s hostname or IP.
      e.g. <host>zm04.company.com<host>
    • Set the solrDataDir tag value to the Curator service database directory; see below for a detailed description.
      The data directory is recommended to be located on a file-system that provides fast disk access, like local SSD drives, fiber-channel connected drives, etc.
    • Save the file.
  2. Copy the server.xml file edited above, to the Curator server machine, overwriting Zoom_Installation_Directory/conf/server.xml. Alternatively, edit the server.xml file on the Curator server in the same manner as above.
  3. Start/Restart the Curator Service
  4. Start/Restart Zoom Service
  5. Open the Web-based Admin Console in a web browser.
    Sample URL for the Admin Console: http://localhost:8443
  6. Open the Server Control Panel from the left navigation panel.
  7. Open the Curator-based Search Management form in the central control panel.
  8. Change the config, as required, and then save the form. The descriptions of the various parameters are given below.
    Curator-based Search Management Form

The configurable parameters signify the following:

  • File Content Index: Specify whether Content Indexing has to be enabled or not.
  • File Content Search: Specify whether Content-based Searching has to be enabled or not.
  • Non-File Content Index: Specify whether Non-Content Indexing has to be enabled or not.
  • Non-File Content Search: Specify whether Non-Content based Searching has to be enabled or not.
  • Host: Curator service machine hostname or IP; as will be accessed from the Zoom service (Default: localhost)
  • Port: The port on which the Curator service runs (Default: 8983)
  • Log Level: The logging level to be used for Curator logs (Default: INFO)
  • Failed Documents Notification: Frequency for sending email notifications to the super-admins about documents that failed to get indexed. It can be set to daily, hourly, weeklyor, disable. (Default: daily).
  • Solr Data Dir: Path to the Solr database directory on the Curator service machine; where the indexing information of the Zoom repository files is stored. (Default: “Zoom_Installation_Directory/db/solr-db” )
    The Solr Data Dir cannot be changed if the directory is no longer empty. That is, it cannot be changed after the first file got indexed successfully.

The other parameters are either non-configurable or, do not usually require any change from the defaults. Additional details about them can be found in the advanced Curator config specification.

Whenever a new change is submitted in the Curator-based Search Management form of the Server Control Panel, the submitted details are first sent from Zoom to Curator for verification and are saved only when they are acceptable.

The communication between Zoom and Curator to establish the correctness of input parameters could be slow on certain set-ups.

Faceted Search 

For the full details on this service please visit: https://evolphin.com/help/docs/v5/client/vab/faceted-search/
Note: any client-side zoom.properties entry can be pushed from the server to all the clients. See here.

 

  • Client-side: Number of entries loaded under each category. The default value is 5
    • Open zoom.properties file from $Home/.zm

       

      /Users/joe/.zm/zoom.properties
    • Add new property FACETED_SEARCH_LIMIT
      FACETED_SEARCH_LIMIT=10
  • Client-side: Controlling the order in which categories will be visible inside the Asset Browser.
    • Add property FACETED_SEARCH_CATEGORY_ORDER in zoom.properties
      FACETED_SEARCH_CATEGORY_ORDER=file_type_filter,project_name,metadata_key,keyword,file_name
      • file_type_filter = File Type Filters
      • project_name = Projects
      • metadata_key = Metadata Properties
      • keyword = Keywords
      • file_name= File Name
  • Server-side: Skipping metadata groups or property fields from the indexing, so that these groups or properties will not be visible in under the list of facets in Asset Browser
    • Open metadataspec.xml from $ZOOM_INSTALL_DIR/conf
      /home/evolphin/zoom/conf/metadataspec.xml
    • Add a new tag skipMetadataFromIndexing under the config tag

      • skipMetadataFromIndexing may contain subtags group or prop, based on the requirements that need to be skipped

        • Syntax 
          For skipping metadata group -> <group>groupcode</group>
      where groupcode is the code of metadata group specified in metadataspec.xml
For skipping metadata property -> <prop>groupcode_propertylabel</prop>
      where properylabel is of field inside metadata group
        • Example 
          To skip indexing for
metadata groups -> FIPR (File Properties) and CAME
metadata properties -> Bitrate under metadata group VDEO (Video Properties) and Headline under group IPTC
          <config>
  <xmpSupportedFormats> ... </xmpSupportedFormats>
  <skipMetadataFromIndexing>
    <group>FIPR</group>
    <group>CAME</group>
    <prop>VDEO_Bitrate</prop>
    <prop>IPTC_Headline</prop>
 </skipMetadataFromIndexing>
</config>
 

Web Client 

The Zoom Web Client that launched with Zoom 7 will be accessible out of the box. However, certain aspects like visual appearance, company logo and repository destination for uploads can be configured. For more information on this feature please visit: https://evolphin.com/help/docs/web-client-configuration/
 

Project templates for the Adobe suite

For the full details on this feature please visit: https://evolphin.com/help/docs/v5/client/app-panel/premierepro/v7new-project-creation-in-adobe-plugin-2/

In 7.0. the templates are configured using the Web Management Console.

Navigate to Plugin->Adobe Plugin->Manage Templates, and add / delete / edit the templates as required.  

New Project creation after changing Premiere Pro version

When the Premiere Pro version is changed(e.g. from CC2016 to CC2017), Premiere Pro may prompt to convert the project file, if you have created the project template in some other version of Premiere Pro:

Convert_dialog

To avoid this, the project template should be created in the same Premiere Pro version for which the template will be used. 

A project template for Premiere Pro CC2017 is attached below for reference:

Project_Template_CC2017

Expanded SSL support for core Zoom operations

For the full details on this feature please visit: https://evolphin.com/help/docs/ssl-support-for-core-zoom-operations/
Stop Zoom services on the Zoom Server, Preview Server, Curator Server, and HADR Server before continuing. Restart Zoom services on HADR Server, Zoom Server, Preview Server, and Curator Server in that order after updating the files mentioned below.

To enable SSL in Zoom, do the following for each of the Zoom Server and Zoom Preview Server. Ignore the HADR peer section if HADR is not in use.

On the Zoom Server

On the Zoom Server, navigate to the conf folder in the Zoom Install directory (For Windows – [ZoomInstallDir]\confand for Linux – [ZoomInstallDir]/conf).

Open server.xml and update the following tags:

  1. Under <networkspec>, set <securePortEnabled> tag as true
  2. Under <networkspec>, set <securePort> tag as 9880
    Sample Server.xml
  3. Under <webserverspec>, set <useSslForDesktopClient> tag as true
  4. Under <webserverspec>, check <sslPort> tag is 9443
  5. Under <webserverspec>, set <ssl> tag as true
    Sample Server.xml
  6. If the LDAP server is not in use then skip this step. If LDAP server is in use, then under <ldapspec>, set <useSsl> tag as true
If any of the tags specified above are not found, please add the tag under that relevant section.
  1. Save changes to the server.xml file.

On the Preview Server

On the Zoom Preview Server, navigate to the conf folder in the Zoom Install directory (For Windows – [ZoomInstallDir]\conf and for Linux – [ZoomInstallDir]/conf).

Open server.xml and update the following tags:

  1. Under <ServerConnection>, set <sslPort> tag as 8973
  2. Under <ServerConnection>, set <enableSsl> tag as true
  3. Under <reviewserverspec>, set <proxySslPort> tag as 8874
  4. Under <reviewserverspec>, set <useSslForDesktopClient> tag as true
  1. Save changes to the server.xml file.
  2. Now, navigate to the conf folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf and for Linux – [ZoomInstallDir]/conf).
  3. Open preview-server.xml and update the tag <ZoomServerHostPort> to use https(eg. <ZoomServerHostPort>https://[ZoomServerIP]:9880>).
  4. Save changes.

Certificate setup with a commercial certificate

Before setting up the SSL certificates on servers, stop Zoom services on the Zoom Server, Preview Server, Curator Server, and HADR Server. Restart services after the server-side setup are complete.
Similarly, stop the Zoom Client Proxy service on a Client machine before setting up the SSL certificates (only for self-signed certificate).

Copy the certificate file to the conf folder in the Zoom Install directory (For Windows – [ZoomInstallDir]\conf and for Linux – [ZoomInstallDir]/conf) for each server machine.

Now, save the password provided with the SSL certificate in each of the Zoom modules as follows:

Zoom Server
  1. From the conf folder, open filewrapper.conf
  2. Set these two properties:

    wrapper.java.additional.11=-Dzoom.ssl.keystore.path=

    wrapper.java.additional.12=-Dzoom.ssl.keystore.pass=

Preview Server
  1. From the conf folder, open file preview-server.conf
  2. Set these two properties

    wrapper.java.additional.11=-Dzoom.ssl.keystore.path=

    wrapper.java.additional.12=-Dzoom.ssl.keystore.pass=

Curator Server
  1. From the conf folder, open file curator-server.conf
  2. Set these two properties

    wrapper.java.additional.11=-Dzoom.ssl.keystore.path=

    wrapper.java.additional.12=-Dzoom.ssl.keystore.pass=

Client Systems

No setup needed.

Certificate setup with a self-signed certificate

Copy the certificate file to the conf folder in the Zoom install directory (For Windows – [ZoomInstallDir]\conf and for Linux – [ZoomInstallDir]/conf).

The certificate information also needs to be set up in the zoom properties file for the server machine for Zoom.

  1. From the user folder (../users/$user/.zm/) open zoom.properties
  2. Set these two properties

    ZOOM_SSL_TRUSTSTORE_PATH=

    ZOOM_SSL_TRUSTSTORE_PASSWORD=

Now, save the password provided with the SSL certificate in each of the Zoom modules as follows:

Zoom Server
  1. From the conf folder, open file wrapper.conf
  2. Set these two properties

    wrapper.java.additional.11=-Dzoom.ssl.keystore.path=

    wrapper.java.additional.12=-Dzoom.ssl.keystore.pass=

Preview Server
  1. From the conf folder, open file preview-server.conf
  2. Set these two properties

    wrapper.java.additional.11=-Dzoom.ssl.keystore.path=

    wrapper.java.additional.12=-Dzoom.ssl.keystore.pass=

Curator Server
  1. From the conf folder, open file curator-server.conf
  2. Set these two properties

    wrapper.java.additional.11=-Dzoom.ssl.keystore.path=

    wrapper.java.additional.12=-Dzoom.ssl.keystore.pass=

Client Systems

The certificate information also needs to be set up in the zoom properties file for each client machine with Zoom.

  1. From the user folder (../users/$user/.zm/), open zoom.properties
  2. Set these two properties

    ZOOM_SSL_TRUSTSTORE_PATH=

    ZOOM_SSL_TRUSTSTORE_PASSWORD=

Leave a Comment