Versions Compared

Version Old Version 35 New Version 36
Changes made by

Dominik Trygar

Dominik Trygar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

Starting Release October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation has moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise Documentation documentation page. Please see:  https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation---upgrade-guides/zephyr-system-requirements/zephyr-server-requirements.html


Warning

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.

...

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

Note: No other Tomcat or MySQL can be installed on the machine.††

Database

MySQL 8.0.35 

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

...

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

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

...

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