Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation-and-upgrade-guides/zephyr-on-premise-production-installation/set-up-zephyr-data-center-cluster/install-zephyr-enterprise-on-nodes/on-windows.html

When installing Zephyr on your nodes, keep in mind the following:

Install Zephyr on any drive other than drive C: to avoid permission issues, as administrator permissions may be required to work with this drive.
Use the same Zephyr version and build on all the nodes.
Zephyr installed on all the nodes must have the same license.

Prerequisites (apply to each node)

Make sure the computer meets the system requirements.
Ensure you have the license file (license.lic), as it will be required during the installation process. If you do not have it, please contact your Zephyr Account Manager or contact Zephyr Sales at sales@getzephyr.com.
Download the installation file of Zephyr Enterprise for Windows.
Download a JDBC driver and place it on each node where Zephyr will be installed.
Download and install JDK. You can use one of the following:
- OpenJDK 17.0.10 (recommended) - download and unzip the archive.
- Oracle JDK 17.0.10 - download and install according to the Oracle documentation.
After you install JDK, set the PATH and JAVA_HOME environment variables:
- PATH variable:
  1. Navigate to Start > Control Panel > System.
  2. Click Advanced > Environment Variables.
  3. Add the path to the bin folder to the PATH variable in the System variables section. A typical path looks as follows:
    - for OpenJDK: C:\some_folder\jdk-17\bin
    - for Oracle JDK: C:\Program Files\Java\JDK_17.0.<version>\bin
- JAVA_HOME variable:
  1. Navigate to Start > Control Panel > System.
  2. Click Advanced > Environment Variables.
  3. Find the JAVA_HOME variable in the System Variables section. If you cannot find it, add it to the System variables.
  4. Add the path to the JDK root folder to the JAVA_HOME variable. A typical path looks as follows:
    - for OpenJDK: C:\some_folder\jdk-17\bin
    - for Oracle JDK: C:\Program Files\Java\JDK_17.0.<version>\bin

Make sure you have specified the correct paths for PATH and JAVA_HOME.

Zephyr installation steps

1. Install Zephyr Enterprise on the first node (the installation steps on the first node differ from the steps you perform on the other nodes):

1. Double-click the installation file and select Install in the Welcome screen:

2. View and ensure all requirements appearing on the screen is available on the system, and then click Next.

3. Read the license agreement and accept its terms:

4. Specify the location where you want to install Zephyr. Make sure the disk has enough free space:

5. Choose Data Center deployment, as you are installing Zephyr on a cluster node:

6. Add the license file you received from Zephyr Sales:

7. Select the Standard installation type to use predefined ports, or Custom to use some other ports:

8. In the subsequent window, select the type of the external database you set up earlier, specify the username and password you use to connect to it, the database URL, and the database driver file:

9. Click Test Connection to check that Zephyr can connect to the database:

10. In the next window, specify the host name or the IP address and port used by Elasticsearch. If you have several Elasticsearch nodes, separate their addresses with commas:

11. In the subsequent window, configure shortcuts and click Next:

12. Wait for the installer to finish the product installation:

13. After you install Zephyr, make sure it is up and running, and then stop the node.

2. Install Zephyr Enterprise on another node:

Perform the steps described in Prerequisites.
Open the Command Prompt window as an admin and run the following command:
zephyr_6.6_xxx_setup_iRev_xxx.exe -VzSkipStartupData=true

3. Once the installation is complete, stop the node.

You can use any number of nodes. If you want to add more nodes, repeat steps 2-3, at that, keep in mind that:

The nodes can be in different regions, but all of them must be in the same time zone.
The node IPs must be on the same subnet.

4. After you install Zephyr Enterprise on all the nodes, you need to modify the following file on each node:
<Zephyr Directory>/tomcat/webapps/flex/WEB-INF/classes/hazelcast.properties

In this file, find the following lines and change the values as shown below:

zephyr.hz.cluster.enabled=false - set it to true.
zephyr.hz.cluster.name=zephyr-hazelcast-cluster - specify a unique name for each cluster, for example, zephyr-hazelcast-cluster_smartbear.
zephyr.hz.interfaces.enabled=false - set to true.
zephyr.hz.interface=127.0.0.1 - This is the IP of the IP interface. Replace it with an IP address that has asterisks instead of the last two components. For example: zephyr.hz.interface= 192.168.*.*
zephyr.hz.tcp-ip.enabled=false - set it to true.
zephyr.hz.members=127.0.0.1 - specify the IP addresses and port number of each node separated by a comma. For example: zephyr.hz.members=192.168.0.1:5701,192.168.0.2:5701

5. Start Zephyr on the first node. When Zephyr starts, you will see the following line in the log file zephyrlocation/tomcat/logs/thedinc.log:

*****************
Zephyr Started
*****************

6. Start the other nodes.

7. Stop all the nodes.

Now you can set up a shared folder. To learn how to do that, click Next Step below.

< Prev Step Next Step >

Zephyr Enterprise 8.1.0

On Windows

Prerequisites (apply to each node)

Zephyr installation steps