Distribution Installation

📘

Subscription Information

This feature is supported on the Self-Hosted platform, with an Enterprise+ license.

You can install and configure JFrog Distribution for single node and for high availability. For more information on high availability, see high availability.

Before installing Distribution 2.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.

To learn about the JFrog Platform Deployment, see System Architecture.

Admin Permissions for Installation

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

Before You Begin

Before proceeding, see System Requirements for information on supported platforms, supported browsers, and other requirements.

Distribution System Requirements

The following table lists the minimum requirements and assumes you are running Distribution with an external database. Actual values might change based on the amount of data in your application.

Processor	Memory	Disk Space
4 cores	8 GB	200 GB SSD

Operating Systems and Platform Support

The following table lists the supported operating systems and their versions:

Product	Debian	RHEL	Ubuntu	Amazon Linux	Windows Server
Distribution	11.x, 12.x	8.x, 9.x	20.04, 22.04, 24.04

📘

Note

Debian 12.x and Ubuntu 24.04 are supported from Artifactory 7.104 and Distribution 2.28.

Windows 2022 is supported from Artifactory 7.125.

Supported Platforms

The following table lists the supported platforms:

Product	x86-64	ARM64	Kubernetes	OpenShift
Distribution			KUBERNETES	OPENSHIFT

Installation on Kubernetes environments is through Helm Charts. Supported Helm version is Helm HELM.

✅

Kubernetes Sizing Requirements

We have included YAML files with different sizing configurations for Artifactory , Xray, and Distribution in our GitHub pages. You can use these YAML files when you set up your cluster.

📘

ARM64 Support for Container-Based Installations

Artifactory, Xray and Distribution supports installation on ARM64 architecture specifically through Helm and Docker installations. When deploying a product on an ARM64 platform, an external database must be set up as Artifactory does not support the bundled database for ARM64 installations. The appropriate ARM64 Container Image is automatically pulled during the Helm or Docker installation process.

Database and Third-Party Applications in Distribution

Distribution supports the following versions of PostgreSQL:

• 16.x
• 15.x
• 14.x
• 13.x

Distribution HA requires an external database. Any changes to the configuration require the restart of a Distribution node for the changes to take effect across the entire Distribution cluster.

📘

Distribution 2.37.0 and later:

Redis has been removed from the Distribution installer and replaced by an internal in-memory system. The content below applies to Distribution versions prior to 2.37.0 only.

Distribution requires Redis and supports Redis REDISMIN. A supported Redis version is bundled with the Distribution installer.

⚠️

Redis Password Restrictions

Redis password should contain only alphanumeric characters and should not contain any special characters.

Distribution Network Ports

Distribution uses the 8082 port by default for external communication.

Distribution uses the following internal ports by default for communication with JFrog Platform microservices.

Microservice	Port
Distribution Server	8080
Router	HTTP: 8082, 8046, 8049 gRPC: 8047
Redis	6379
PostgreSQL (if you use the bundled Postgres database)	5432
Observability	HTTP: 8036 gRPC: 8037

Installation Steps

The installation procedure involves the following main steps:

1. Download Distribution as per your required installer type (Docker Compose, RPM, Debian).

2. Install Distribution either as a single node installation, or high availability cluster.

   1. Install third party dependencies (PostgreSQL and Redis database, included in the archive)
   2. Install Distribution

3. Configure the service.

   1. Connection to Artifactory (joinKey and jfrogUrl)
   2. Additional optional configuration including changing default credentials for databases

4. Start the Service using the start scripts or OS service management.

5. Check the Service Log to check the status of the service.

Once you have finished the setting up Distribution, continue to Configuring Distribution.

To begin using Distribution, see Distributing Release Bundles.

📘

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.

Distribution Single Node Installation

The following installation methods are supported:

Distribution HA Installation

Distribution supports installation in an HA cluster with two or more nodes. For more information, see the System Architecture.

The following installation methods are supported:

Prerequisites to run Distribution HA

Version

All nodes within the same Distribution HA installation must be running the same Distribution version.

Database

Distribution HA requires an external PostgreSQL database. Complete setting up your external database before installing the cluster nodes. The database connection details are used for each node installation. There are several ways to set up PostgreSQL for redundancy, including HA, load balancing, and replication. For more information, see the PostgreSQL documentation.

Network

• All the Distribution HA components (Distribution cluster nodes and database server) must be within the same fast LAN.
• All the HA nodes must communicate with each other through dedicated TCP ports.