Zephyr Production Installation for Windows
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/zephyr-production-installation-for-windows.html
For multiple nodes clustered installation of Zephyr or to use an external Database other than MySQL, refer to the Zephyr Data Center Requirements and the Connecting to an External Database.
When installing Zephyr, users can choose to select Data Center Deployment for multiple nodes when going through the installation process and choosing the Deployment Type.
After installing the Zephyr Server product, you can upgrade the product if need be. Please use the link provided below if you need to upgrade Zephyr Server:
Prerequisites
Review all system requirements thoroughly.
Ensure you have the license file (license.lic) as this will be required during the installation process. If you do not have this license file, please contact your Zephyr Account Manager or contact Zephyr Sales at sales@getzephyr.com.
Download the required software:
Java - one of the following:
MySQL MySQL 8.0.35: Download - here / Upgrade / Installation instructions - here
Elasticsearch: v 8.6.2 Download - here /Installation instructions - here
Zephyr Server for Windows: Download - here
RabbitMQ (optional): RabbitMQ 3.12.10 (Java 17 is required) . Download here.
ZE-Services (optional): Java 17.0.10 is required:
Update the PATH and JAVA_HOME environment variables
Zephyr needs a couple of environment variables set once you have the JDK installed. You can set the variables this way to allow it to persist through reboot.
Setting up PATH in Windows (steps might vary with Windows version):
Click Start > Control Panel > System
Click Advanced > Environment Variables
Scroll through the fields until you find the PATH
Add the location of the bin folder of the install for PATH in System variables (do not delete the existing value; just add it to the beginning of it).
A typical path is:
for OpenJDK: C:\SomeFolder\jdk-17\bin
for Oracle JDK: C:\Program Files\Java\JDK_17.0.<version>\bin
Setting up JAVA_HOME in Windows (steps might vary with Windows version):
Click Start > Control Panel > System
Click Advanced > Environment Variables
Scroll through the fields until you find JAVA_HOME, if it's not present Add it to the System variables.
Add the location of the JDK root folder to the value of JAVA_HOME in System variables.
A typical path is:
for OpenJDK: C:\SomeFolder\jdk-17\bin
for Oracle JDK: C:\Program Files\Java\JJDK_17.0.<version>\bin
Important: Make sure you have specified the correct path.
Install Zephyr Server
1. Double-click the setup file. The following Welcome screen appears.
2. A quick reminder of the requirements to install and run Zephyr will pop up. Make sure all requirements appearing on the screen is available on the system, and then click Next.
3. Review the mandatory acceptance of our Licensing Agreement before continuing.
The installation will not proceed further if the terms of the license agreement are not accepted
4. Select the destination location of where the Zephyr server needs to be installed.
Make sure the specified disk drive has enough free space.
5. Select the deployment type.
To install Zephyr Server, select Server deployment and continue to Step 6.
To install Zephyr Data Center, select Data Center deployment and see the Set Up Zephyr Data Center section.
6. Add the license file.
You would have received the license file from Zephyr Sales.
7a. Select one of the 2 types of Setups - Standard or Custom.