Subscription Information
This feature is supported on the Self-Hosted platform, with Pro X, Enterprise X, and Enterprise+ licenses.
You can install and configure JFrog Xray, single node and high availability. For additional information on high availability, see high availability
Before installing Xray 3.x, you must first install JFrog Artifactory 7.x.
Note
Use a dedicated server with no other software running to alleviate performance bottlenecks, avoid port conflicts, and avoid setting uncommon configurations.
Warning
If you install Xray on the same server as Artifactory, you might have port conflicts and performance issues. Artifactory and Xray use port 8082 for communication with the external network. In addition, the ports 8082, 8046, 8047, and 8049 are used by both Xray and Artifactory for the Router microservice.
To learn about the JFrog Platform Deployment, see System Architecture.
Before you proceed, see System Requirements for information on supported platforms, supported browsers, and other requirements.
Admin Permissions for Installation
We recommend that you run the installation as a root user or provide sudo access to a non-root user.
You need to have admin permissions on the installation machine in the following cases.
Native installer - always requires admin permissions
Archive installer - requires admin permissions only during installation
Docker installer - does not require admin permissions
Installation Steps
The installation procedure involves the following main steps.
Download Xray as per your required installer type (Docker Compose, RPM, Debian).
Install Xray either as a single node installation, or high availability cluster.
Install third party dependencies (PostgreSQL database, included in the archive)
Install Xray
Configure Xray basic settings.
Connect to an Artifactory instance (requires a
joinKey
and ajfrogUrl
in the XRaysystem.yaml
file).Optional: Configure the PostgreSQL database connection details if you have set Postgres as an external database.
Start the Service using the start scripts or OS service management.
Check the Service Log to check the status of the service.
Default Home Directory / $JFROG_HOME
The default home directory is defined according to the installation type. For more information, see System Directories.
$JFROG_HOME
represents the JFrog root directory containing the deployed product.