Installing Distribution

JFrog Installation & Setup Documentation
Content Type
Installation & Setup
ft:sourceType
Paligo

Subscription Information

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

You can install and configure JFrog Distribution, single node and high availability. For additional 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

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

Before You Begin

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

Distribution System Requirements
Operating Systems and Platform Support

The following table lists the supported operating systems and the versions.

Product

Debian

RHEL

Ubuntu

Amazon Linux

Windows Server

Artifactory

10.x, 11.x

8.x, 9.x

20.04, 22.04

Amazon Linux 2023

2016 or 2019

Xray

10.x, 11.x

8.x, 9.x

20.04, 22.04

Distribution

10.x, 11.x

8.x, 9.x

20.04, 22.04

Amazon Linux 2023

Insight

10.x, 11.x

8.x, 9.x

20.04, 22.04

Amazon Linux 2023

Pipelines

8.x

20.04, 22.04

Amazon Linux 2023

Build nodes only

Supported Platforms

The following table lists the supported platforms.

Product

x86-64

ARM64

Kubernetes

OpenShift

Artifactory

1.19+

4.13+

Xray

1.19+

4.13+

Distribution

1.19+

4.13+

Insight

1.19+

Pipelines

1.19+

Installation on Kubernetes environments is through Helm Charts. Supported Helm version is Helm 3+.

Kubernetes Sizing Requirements

We have included YAML files with the different sizing configuration for Artifactory in our GitHub page. You can use these YAML when you set up your cluster.

We have included YAML files with the different sizing configuration for Xray in our GitHub page. You can use these YAML when you set up your cluster.

We have included YAML files with the different sizing configuration for Distribution in our GitHub page. You can use these YAML when you set up your cluster.

ARM64 Support

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.

Database and Third-Party Applications in Distribution

Distribution supports the following versions of PostgreSQL.

  • 15.x

  • 13.x

  • 12.x

Distribution HA requires an external database. Any change to configuration requires restarting of any Distribution node for changes to take effect for the whole Distribution cluster.

Distribution requires Redis and supports Redis 7.x. 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

8082, 8046, 8047, and 8049

Redis

6379

PostgreSQL (if you use the bundled Postgres database)

5432

Observability

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 DistributionConfigure Distribution.

To begin using Distribution, see Distributing Release Bundles.Distribute Release Bundles (v1)

Default Home Directory / $JFROG_HOME

The default home directory is defined according to the installation type. For additional details, 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. Make sure you have completed setting up your external database before proceeding to install the cluster nodes. The database connection details are used for each node installation. There are several ways to setup 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.