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-system-requirements/zephyr-server-requirements.html

Zephyr Enterprise must run in an isolated instance where no Jira is running or any other Tomcat.

Zephyr Enterprise should only be installed on its server. If you are running a Jira instance, it should be installed on a different server.
We recommend you have Zephyr Enterprise installed on a separate instance from where you have your Jira/Tomcat installed.
RabbitMQ and ZE Services should be installed in a separate server as we require Java 17.

Zephyr Enterprise Server (for Windows On-Premises installations only)

OS	Windows Server 2016 and 2019
CPU	Quad-core CPU Intel Pentium or AMD Opteron (2 GHz or higher)
RAM	Minimum 8 GB; Preferred 12 GB RAM recommendations can be found here
Disk Space	At least 5 GB free (250 GB-1 TB recommended for large enterprise installations)
Networking	Wired Ethernet Static IP address REQUIRED† Ports: 80, 443 (if HTTPS) Firewall (if present): Allow ports 80, and 443 (if HTTPS). Must support WebSocket protocol Proxy (if present): Must support WebSocket protocol
Account	Administrator access to the machine Installer and services need to "Run As Administrator"
Software	Java: OpenJDK 17.0.10 (recommended) or Oracle JDK 17.0.10. Oracle JDK must be JDK 17.0.10. See also Note on Oracle JDK License Update Note: No other Tomcat or MySQL can be installed on the machine.††
Database	MySQL 8.0.35
ElasticSearch	v. 8.6.2: Download - here / Installation instructions - here
RabbitMQ (optional)	Currently, installing RabbitMQ is optional RabbitMQ 3.12.10 (Java 17 is required) / Download - here / Installation instructions - here
ZE-Services (optional)	Currently, installing ZE-Services is optional ZE-Services (Java 17.0.10 or later required): ZE-Webhook: Download - here / Installation instructions - here ZE-Consumer Deployment: Download - here / Installation instructions - here ZE-AuditService Deployment: Download - here / Installation instructions - here ZE-AuditProcessor Deployment: Download - here / Installation instructions - here

Zephyr Enterprise Server (for Linux On-Premises installations only)

OS	Red Hat Enterprise 64-bit (the latest supported version is RHEL 8) CentOS 64-bit Ubuntu/Debian 64-bit SUSE/openSUSE 64-bit
CPU	Quad-core CPU Intel Pentium or AMD Opteron (2 GHz or higher)
RAM	Minimum 8 GB; Preferred 12 GB
Disk Space	At least 5 GB free (250 GB-1 TB recommended for large enterprise installations)
Networking	Wired Ethernet Static IP address REQUIRED† Ports: 80, 443 (for root user) and 1024, 8443 (for non-root user) Firewall (if present): Allow ports 80, 443 (for root user) and 1024, 8443 (for non-root user). Must support WebSocket protocol Proxy (if present): Must support WebSocket protocol
Account	Installer and services will be installed as the current user
Software	Java: OpenJDK 17.0.10 (recommended) or Oracle JDK 17.0.10. Oracle JDK must be JDK 17.0.10.
Database	MySQL 8.0.35
ElasticSearch	v. 8.6.2: Download - here / Installation instructions - here
RabbitMQ (optional)	Currently, installing RabbitMQ is optional RabbitMQ 3.12.10 (Java 17 required) / Download - here / Installation instructions - here
ZE-Services (optional)	Currently, installing ZE-Services is optional ZE-Services (Java 17.0.10 or later required): ZE-Webhook: Download - here / Installation instructions - here ZE-Consumer Deployment: Download - here / Installation instructions - here ZE-AuditService Deployment: Download - here / Installation instructions - here ZE-AuditProcessor Deployment: Download - here / Installation instructions - here

Zephyr Client

OS	Any Desktop OS
Browser	Any one of these versions that support WebSockets: Chrome Firefox Edge
Networking	The client machine must have access to port 80 for HTTP connection (or 443 for HTTPS) to the Zephyr Server
Other	Screen resolution of 1280x1024 (1280x900 for widescreen) or higher

ZBots

OS	Windows Server 2016 or 2019 Windows 8 Enterprise, or Windows 10 Enterprise Linux (Red Hat, Fedora, Ubuntu, CentOS, SUSE) macOS
CPU	Dual-core CPU Intel Pentium or AMD Opteron (2 GHz or higher)
RAM	Minimum 1 GB
Disk Space	At least 100 MB
Networking	Wired Ethernet
Account	Administrator access to the machine Installer and services need to "Run As Administrator"
Software	OpenJDK 17.0.10 or Oracle JDK 17.0.10

Database Requirements

Evaluation Environment	Production Environment
The Zephyr Enterprise installer provides an option for using Embedded MySQL for the database. This should only be used for evaluation purposes and not for production instances.	We recommend you always use an external database for improved performance and easy maintenance when setting up your production instance/server. This provides you with proper system performance for your Zephyr instance.

Additional Notes

All port numbers mentioned are by default and can be configured to fit your specific environment setup. If any firewalls or proxies are present, it is required that they support the WebSocket protocol.

Ports explained:

80, 443 (for root user) and 1024, 8443 (for non-root user) 8005, and 8009 are used by Tomcat and can be configured in the server.xml file under zephyr\tomcat\conf\
3306 is used by MySQL in Linux and configured in the my.cnf
9200 is used by Elasticsearch
5701, 5702, 37000, 37001 are used by Hazelcast
5672, 15672 are used by RabbitMQ
8081 is used by ZE-Webhook Service
8082 is used by ZE-Consumer Service
8083 is used by ZE-AuditService
8084 is used by ZE-AuditProcessor

Software versions explained:

Elasticsearch is required to install the Zephyr Enterprise Server. The supported Elasticsearch version is 8.6.2.
The MySQL software has to be the major/minor (8.0.x) version.
- No other MySQL should be present on the server instance.
Oracle JDK must be JDK 17.0.10.
Zephyr Enterprise Server for Windows includes MySQL in the installation package on top of allowing remote MySQL.
Zephyr Enterprise Server for Linux requires a separate installation of MySQL not included in the installation package on top of allowing remote MySQL.
RabbitMQ 3.12.10 is a robust messaging and streaming broker that's easily deployable across cloud environments and on-premises setups. Currently, installing RabbitMQ is optional for the users. Java 17.0.10 or later is required to use RabbitMQ.
ZE-Services. Currently, installing ZE-Services is optional for the users. Java 17.0.10 or later is required to use ZE-Services.
- ZE-Webhook Service is the component responsible for accepting the incoming events from Jira and enqueues them to the message broker for further processing.
- ZE-Consumer Service is the component that picks the enqueued events from the message broker and updates ZE with the incoming data.
- ZE-AuditService is the component that acts as the incoming endpoint for the Audit Logs generated during the incoming webhook event processing and enqueues them to the message broker.
- ZE-AuditProcessor is the component responsible for reading the enqueued audit logs from the message broker and inserting them into ZE.

Browser not supported