Installing Xray

Subscription Information

This feature is supported on the Self-Hosted platform, with Pro X, Enterprise X, and Enterprise+ licenses.

Note

Use a dedicated server with no other software running to alleviate performance bottlenecks, avoid port conflicts, and avoid setting uncommon configurations.

Note

JFrog Xray now supports RabbitMQ Quorum Queues, an optional parameter configurable in system.yaml. This change is due to RabbitMQ deprecating Classic Queue mirroring in version 4.x. As a result, JFrog will also deprecate Classic Queue support and transition to Quorum Queues. It is highly recommended to enable Quorum Queues in Xray, as JFrog intends to fully transition to RabbitMQ 4.x and discontinue Classic Queue support in future versions.

Note

From Xray version 3.124.x, JFrog has added support for RabbitMQ Quorum Queues, as RabbitMQ has discontinued support for Classic Queue mirroring, which is deprecated in RabbitMQ 4.x. With this, JFrog will be deprecating Classic Queue support in upcoming releases.

A two-node cluster with RabbitMQ Quorum Queues will not be fault-tolerant, as Quorum Queues require a minimum of 3 nodes for HA. For more information, please refer to the RabbitMQ Quorum Queues documentation here.

With the Xray 3.124.x installer, optional support for RabbitMQ 4.x has been introduced, including a variable to switch to RabbitMQ 4.x during installation. The ${JF_PRODUCT_HOME}/app/bin/xray.default file has been updated with the JF_PRODUCT_RABBITMQ_HOME variable to support RabbitMQ 4.x and Quorum Queues.

Note

It is crucial to migrate to Quorum Queues while still using RabbitMQ 3.x before upgrading to RabbitMQ 4.x. RabbitMQ 4.x does not support Classic Queue mirroring, and switching directly to RabbitMQ 4.x without prior migration to Quorum Queues will result in data loss and require re-indexing repositories.

To use RabbitMQ 4.x if you are currently running RabbitMQ 3.x, you must update ${JF_PRODUCT_HOME}/app/bin/xray.default. Set the JF_PRODUCT_RABBITMQ_HOME variable key to ${JF_PRODUCT_HOME}/app/third-party/rabbitmq4 in this file before starting Xray.

For Xray installations with three or more nodes, the recommended approach is to separate the RabbitMQ and Xray clusters, installing them independently. More information on this can be found here.