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: On Linux | Zephyr Enterprise Documentation

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

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) and any plugin license files that were provided.
Download the installation file of Zephyr Enterprise for Linux.
Download and install JDK. Use one of the following:
- OpenJDK 17.0.10 (recommended) - see the installation instructions
- Oracle JDK 17.0.10 - download and install according to the Oracle documentation.
Download MySQL Connector.
Upload Zephyr License: The Zephyr installer requires access to the license file provided. It will need to be first uploaded to the file system of the server.
Upload the MySQL Connector: The Zephyr installer requires access to the MySQL connector jar file downloaded. It will need to be first uploaded to the file system of the server.
Set ulimit in Linux: increase ulimit on the server to 65535.

Base node creation

If you have a new node that is not yet configured, do the following:

1. Create a Linux EC2 instance, Name-BASE-01, and configure basic parameters:

Assign an elastic IP.
Log in to the instance using your .pem key.
Create the user zephyr and the zephyr password:

sudo adduser zephyr
sudo passwd zephyr

Add the user to the root group and log in as the zephyr user:

sudo usermod -a -G wheel zephyr
su - zephyr

Add your ssh keys to user zephyr:

sudo yum install openssh-server
ssh-keygen
vi /.ssh/authorized_keys #add necessary public keys to the server

2. Install the following packages:

sudo yum install wget - WGET
sudo yum install -y perl-Digest-SHA - SHASUM
sudo yum -y install epel-release - EPEL repo install
sudo yum repolist - update the repo list
sudo yum install dpkg-devel dpkg-dev - DPKG

3. Create an Amazon Machine Image from this instance: Name-BaseCluster-AMI.

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):

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

Use the same Zephyr version and build on all the nodes.
Zephyr installed on all the nodes must have the same license.

1. Ensure the installation file has proper permissions to be executed:

chmod +x zephyr_(Build Number)_linux_setup.sh

2. Launch the installation file with the -c command line option as shown below, and ensure you launch it as sudo or root:

sudo ./zephyr_(Build Number)_linux_setup.sh

3. You will be prompted to continue with the installation. Choose OK to continue:

Starting Installer...
This will install Zephyr X.X on your computer
OK [o, Enter], Cancel [c]

4. You may be prompted to choose between a new installation and upgrading. Choose Install.

Choose type:
Install [1, Enter], Upgrade [2]

5. You will be prompted to confirm your system meets the Zephyr Server requirements. Please make sure your system meets the requirements before proceeding:

Requirements
Server
OS:               RedHat Enterprise
                     CentOS
                     Ubuntu/Debian
                     SUSE/openSUSE
CPU:            Quad-core CPU Intel Pentium or AMD Opteron (2Ghz or higher)
RAM:            Minimum 16GB; Preferred 16GB
Disk Space:   At least 5GB Free
Networking:   Wired Ethernet
                     Static IP address
                     If Firewall exists, please allow ports
                     80, 1024, 443,8443, 8005, 8009 , 3306
Account:       Installer and services will be installed as the current user

6. Agree to the Zephyr EULA:

License Agreement
Software End User License Agreement
IMPORTANT - PLEASE READ CAREFULLY:
This End User License Agreement ("Agreement") constitutes a valid and
binding agreement between D Software, INC. (”d software,” ”WE” or ”US”) and
you, as either an individual or a single business entity ("you," "your" or
"user") for the use of the Zephyr x.x software, ANY files that are delivered
to you by d software to modify the Zephyr x.x software product, any online
or enclosed documentation, and any updates, fixes and upgrades provided to
you (collectively, the ”Software”). You must FIRST READ AND ACCEPT THE TERMS
OF THIS LICENSE AGREEMENT by clicking on the ”i agree” checkbox below in
order to install and use the Software.

7. Press the Enter key until you see the following, then press 1 to agree to the terms:

I accept the terms of this license agreement [1], I do not accept the terms of this license agreement [2, Enter]

8. Specify the destination location to place the Zephyr home directory:

Select Destination Location
Setup will install Zephyr into the following folder.
To continue click Next. If you would like to select a different folder, click Browse
[/usr/local/zephyr]

9. Choose the installation type Data Center deployment:

Choose deployment type:
Server deployment [1, Enter], Data Center deployment [2]

10. Locate your license file:

License File
License Key File:
[/home/zephyr/license.lic]

11. Choose a port to run Zephyr on. By default, Zephyr runs on port 80 (for root user) and port 1024(for non-root user):

Customization
Server Port :
[80]

12. Choose a Tomcat Server Shutdown Port. We recommend that you leave the default port for it:

Tomcat Server Shutdown Port:
[8005]

13. You will be prompted to choose a database system. Choose MySQL:

Note: If you had just uninstalled. Please wait few miniutes for the port to get free and try again.
Configure Database
Database Type:
MySQL [1, Enter]

14. Specify the username you use to connect to the database:

Database Character Set: utf8
Username:
[]

15. Specify the password you use to connect to the database:

Password:
[]

16. Specify the database connection string:

Database URL Configuration:
Sample URL: jdbc:mysql://localhost:3306/
Database URL:
[]

17. Specify the connection string for Elasticsearch you configured earlier. By default, Elasticsearch will bind to the IP configured in the elasticsearch.yml file edited earlier in the installation instructions. For example: 192.168.56.101:9300:

Configure Elasticsearch
Enter the hostname or IP address and port used by Elasticsearch. For example: localhost:9300.
Multiple Elasticsearch nodes should be separated by comma. For example: localhost:9300,localhost:9301
ES Host URL
[]

18. Zephyr will now install the required files:

Extracting files ..

# ************************************************************

After the installation is complete, you will see the following:

ZephyrService.sh may or may not start automatically. Please check and start manually if not started.

Done!

Zephyr x.x has now been installed on your computer.

Zephyr Desktop will now be launched automatically.

You can access additional help from the Zephyr installation.

Click Finish to exit setup.

Launch Zephyr Desktop?

Yes [y, Enter], No [n]

Choose No for now.

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

3. Install Zephyr Enterprise on another node:

Perform the steps described in Prerequisites and in Base node creation, if needed.
Open the terminal and run the following command:

sh zephyr_x.x_xxx_setup_iRev_xxx.sh -VzSkipStartupData=true

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

You can use any number of nodes. If you want to add more nodes, repeat steps 3-4, 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.

5. 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

6. Start Zephyr on the first node by using the following commands:

cd /usr/local/zephyr/tomcat/bin
sudo ./startup.sh

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

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

7. Start the other nodes.

8. 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 >