Before you proceed, see System Requirements for information on supported platforms, supported browsers, and other requirements.
Xray Node Recommendations
Use a dedicated node for Xray with no other software running to alleviate performance bottlenecks, avoid port conflicts, and avoid setting uncommon configurations.
Xray Storage Recommendations
In most cases, our recommendation is to use an SSD drive for Xray to have better performance and it is not recommended to use an NFS drive, as it is a disk I/O-intensive service, a slow NFS server can suffer from I/O bottlenecks and NFS is mostly used for storage replication.
Xray stores node specific files, such as configuration and temporary files, to the disk. These files are exclusively used by Xray and not shared with other services. Since the local storage used for Xray services are temporary, it does not require replication between the different nodes in a multi-node/HA deployment.
Xray File Handle Allocation Limit
Use the following command to determine the current file handle allocation limit.
Then, set the following parameters in your
.conf file to the lower of 100,000 or the file handle allocation limit determined above.
The example shows how the relevant parameters in the
.conf file are set to 100000. The actual setting for your installation may be different depending file handle allocation limit in your system.
root hard nofile 100000 root soft nofile 100000 xray hard nofile 100000 xray soft nofile 100000 postgres hard nofile 100000 postgres soft nofile 100000
Operating Systems and Platform Support
The following table lists the supported operating systems and the versions.
7.x, 8.x, 9.x
18.04, 20.04, 22.04
CentOS 8.x Support
CentOS 8.x reached its end-of-life in December 2021. CentOS 8.x support for JFrog products has been deprecated by the end of June 2022.
The following table lists the supported platforms.
Installation on Kubernetes environments is through Helm Charts. Supported Helm version is Helm 3+.
From version 7.41.4, Artifactory supports installation on ARM64 architecture through Helm and Docker installations. You must set up an external database as the Artifactory database since Artifactory does not support the bundled database with the ARM64 installation. Artifactory installation pulls the ARM64 image automatically when you run the Helm or Docker installation on the ARM64 platform.
ARM64 support is also available for Xray, Distribution, and Insight. ARM64 support is not available for Pipelines.
Database and Third-Party Applications in Xray
Every artifact and build indexed by Xray is broken down into multiple components. These components and the relationships between each other are represented in a checksum based components graph. Xray uses PostgreSQL to store and query this components graph.
Xray supports the following versions of PostgreSQL.
15.x (from version 3.78.9)
13.x (from version 3.18)
Xray supports PostgreSQL 14.x and 15.x, but currently the Xray installer only bundles the binaries for PostgreSQL 13.x.
RabbitMQ is installed as part of the Xray installation for every node. In case of HA architecture, Xray uses queue mirroring between the different RabbitMQ nodes. External RabbitMQ instances are not officially supported; the recommended method of installation is to use the bundled RabbitMQ.
Xray has multiple flows, such as scanning, impact analysis, and database sync. These flows require processing completed by the different Xray microservices. Flows contain multiple steps that are completed by the Xray services. Xray uses RabbitMQ to manage these different flows and track synchronous and asynchronous communication between the microservices.
Xray also uses Erlang and DB-Util third-party applications. These packages are bundled with the Xray installation.
Xray Network Ports
Xray uses the 8082 port by default for external communication.
Xray uses the following internal ports by default for communication with JFrog Platform microservices.
8082, 8046, 8047, and 8049
4369, 5671, 5672, 15672, and 25672
PostgreSQL (if you use the bundled PostgreSQL database)
In addition, review the Docker requirements.
For Docker and Docker Compose installations, JFrog services require Docker 20.10.10 and above, and Docker Compose v1.24 and above to be installed on the machine on which you want to run on.
Complete the following steps to install the product.
Extract the contents of the compressed archive and go to the extracted folder.
tar -xvf jfrog-xray-<version>-compose.tar.gz
.env file included within the Docker-Compose archive
The .env file is used by docker-compose and is updated during installations and upgrades.
Some operating systems do not display dot files by default. If you make any changes to the file, remember to backup before an upgrade.
Create the following folder structure under
|-- [ ] app |-- [ ] third-party |-- [999 999] rabbitmq |-- [1035 1035] var |-- [1035 1035] data |-- [1035 1035] etc
Copy the appropriate docker-compose templates from the templates folder to the extracted folder. Rename it as
Docker for Mac
When you use Docker Compose in Mac,
/etc/localtimemight not work as expected since it might not be a shared location in the docker-for-mac settings.
You can remove the following line from the selected
docker-compose.yamlfile to avoid installation issues.
## The installation directory for Xray. Default [$HOME/.jfrog/xray] ROOT_DATA_DIR= # Host ID. Other nodes in the cluster will use this ID to identify this node HOST_ID= # ID of the active node. Please leave the value as "None" for active nodes. (shared.rabbitMq.active.node.name). JF_SHARED_RABBITMQ_ACTIVE_NODE_NAME=None # IP of the active node. (shared.rabbitMq.active.node.ip) JF_SHARED_RABBITMQ_ACTIVE_NODE_IP=127.0.0.1 # Bind IP for Internal ports of Third party applications JF_THIRD_PARTY_BIND_IP=127.0.0.1ROOT_DATA_DIR=
Set the Artifactory connection details.
Customize the PostgreSQL Database connection details. (optional)
Set any additional configurations (for example: ports, node id) using the Xray
Ensure the host's ID and IP are added to the
system.yaml. This is important to ensure that other products and Platform deployments can reach this instance.
Enter the RabbitMQ information in system.yaml. If you want to setup a RabbitMQ HA cluster, enter the information in all the slave nodes.
shared: rabbitMq: active: node: ip: <IP> name: <xray-master-node-id> # Enter the value of HOST_ID from the .env file as xray-master-node-id and the value of JF_THIRD_PARTY_BIND_IP value from the .env file as the IP.
Customize any additional product configuration (optional) including, Java Opts and filestore.
setRabbitCluster.shfiles to the folder
Ensure both are owned by 999:999 (rabbitmq uid/gid)
rabbitmq.confand enter the following information. If you want to setup a RabbitMQ HA cluster, enter the information in all the slave nodes.
cluster_formation.peer_discovery_backend = rabbit_peer_discovery_classic_config cluster_formation.classic_config.nodes.1 = rabbit@<xray-master-node-id># Enter the value of HOST_ID from the .env file as xray-master-node-id.
Start Xray and PostgreSQL using docker-compose commands.
## Start RabbitMQ before starting other services docker-compose -p xray-rabbitmq -f docker-compose-rabbitmq.yaml up -d ## From Xray 3.8.x, Start PostgreSQL before starting the other services. docker-compose -p xray-postgres -f docker-compose-postgres.yaml up -d docker-compose -p xray up -d ## Check whether service is up docker-compose -p xray psdocker-compose -p distribution logs docker-compose -p distribution ps docker-compose -p distribution up -d docker-compose -p distribution down
Access Artifactory from your browser at:
For example, on your local machine:
Check the Xray log.
docker-compose -p xray logs
Configure log rotation of the console log
console.logfile can grow quickly since all services write to it. For more information, see configure the log rotation.
After installing and before running Xray, you may set the following configurations.
Where to find the system configurations?
You can configure all your system settings using the
system.yaml file located in the
/var/etc folder. For more information, see Xray System YAML.
If you don't have a System YAML file in your folder, copy the template available in the folder and name it
For the Helm charts, the
system.yaml file is managed in the chart’s
Artifactory Connection Details for Xray
Xray requires a working Artifactory server and a suitable license. The Xray connection to Artifactory requires the following parameters.
URL to the machine where JFrog Artifactory is deployed, or the load balancer pointing to it. It is recommended to use DNS names rather than direct IPs. For example:
http://10.20.30.40:8082. Note that
/artifactorycontext is not longer required.
Set it in the Shared Configurations section of the
This is the "secret" key required by Artifactory for registering and authenticating the Xray server.
You can fetch the Artifactory
joinKey(join Key) from the JPD UI in the User Management | Settings | Join Key.
Set the join.key used by your Artifactory server in the Shared Configurations section of the
Change PostgreSQL database credentials
Xray comes bundled with a PostgreSQL database out-of-the-box, which come pre-configured with the default credentials.
To change the default credentials:
# Access PostgreSQL as the Xray user adding the optional -W flag to invoke the password prompt $ psql -d xraydb -U xray -W # Securely change the password for user "xray". Enter and then retype the password at the prompt. \password xray # Verify the update was successful by logging in with the new credentials $ psql -d xraydb -U xray -W
Set your PostgreSQL connection details in the Shared Configurations section of the
Change RabbitMQ database credentials
Xray comes pre-installed with RabbitMQ, by setting the Erlang cookie value as the RabbitMQ password for guest users.
Set the new password in the
default_pass = <new password>
Set your RabbitMQ password in the Shared Configurations section of the
Restart all services.
cd jfrog-xray-<version>-compose docker-compose -p xray restart
Configure RabbitMQ to use FQDN for clustering
By default, RabbitMQ uses the short hostnames of other nodes in the cluster for communication. However, it be can be configured to use a fully qualified domain name (FQND) host name (a long hostname).
To configure RabbitMQ to use FQDN, follow these steps.
Install Xray , but do not start the services.
Modify the following files according to the installer type.
In docker-compose-rabbitmq.yaml: environment: - RABBITMQ_USE_LONGNAME=true In .env: HOST_ID=<long hostname> ## For secondary nodes only #JF_SHARED_RABBITMQ_ACTIVE_NODE_NAME=<long hostname of active node>
Common Change in All Installers
In system.yaml: shared: node: id: <long hostname> name: <long hostname> ## For secondary nodes only # shared: # rabbitMq: # active: # node: # name: <long hostname of active node>
Start RabbitMQ and the Xray services.
Third Party Log Collector
Xray enables using an external log collector such as Sumologic or Splunk.
To adjust the permissions to allow the log collection service perform read operations on the generated log files.
Add the log collection service user to the relevant group if needed (the user and group that installed and started Xray).
Apply the user and group permissions as needed on the
$ chmod -R 640 $JFROG_HOME/xray/var/log
Adjust the group read inheritance permissions
$ chmod -R 2755 $JFROG_HOME/xray/var/log
This command enables the generated log files to inherit the folder's group permissions.