Distribution Single Node Interactive Script Installation (recommended)

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

The installer script provides you an interactive way to install Distribution and its dependencies. All install types are supported.

All install types are supported, including Docker Compose, RPM, and Debian.

Before you proceed with the installation, review the system requirements.

Distribution System Requirements
Operating Systems and Platform Support

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

Product

Debian

RHEL

Ubuntu

Windows Server

Amazon Linux

Distribution

10.x, 11.x

8.x, 9.x

20.04, 22.04

Amazon Linux 2023

Operating Systems - End of Support

As part of JFrog commitment to maintain the security and reliability of the JFrog Platform, Artifactory will officially run with Node.js 20.x on all installation types from Artifactory 7.77.3.

Node.js 20.x provided with Linux Archive/Debian/RPM installations (non-containerized distributions) is not supported on the following operating systems.

Hence, these operating systems will no longer supported from Artifactory version 7.77.3.

Supported Platforms

The following table lists the supported platforms.

Product

x86-64

ARM64

Kubernetes

OpenShift

Distribution

1.19+

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

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, Pipelines (in Helm installation), and Insight. ARM64 support is not available for Distribution.

Database and Third-Party Applications in Distribution

Distribution supports the following versions of PostgreSQL.

  • 15.x

  • 13.x

  • 12.x

  • 11.x

  • 10.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

Complete the following steps to install the product.

  1. Download Distribution.

  2. Extract the contents of the compressed archive and go to the extracted folder.

    Docker Compose/RPM/DEB

    tar -xvf jfrog-distribution-<version>-<compose|rpm|deb>.tar.gz
cd jfrog-distribution-<version>-<compose|rpm|deb>

    OS user permissions for Linux archive

    When running Distribution, the installation script creates a user called distribution by default, which must have run and execute permissions on the installation directory.

    We recommend that you extract the Distribution download file into a directory that gives run and execute permissions to all users such as /opt.

    mv jfrog-distribution-<version>-linux.tar.gz /opt/
cd /opt
tar -xf jfrog-distribution-<version>-linux.tar.gz
mv jfrog-distribution-<version>-linux distribution
cd distribution

    Linux Archive

    mv jfrog-distribution-<version>-linux.tar.gz /opt/
cd /opt
tar -xf jfrog-distribution-<version>-linux.tar.gz
mv jfrog-distribution -<version>-linux distribution 
cd distribution

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

  3. Run the installer script.

    The script prompts you with a series of mandatory inputs, including the jfrogURL (custom base URL) and joinKey.

    Docker Compose

    ./config.sh

    RPM/Debian

    ./install.sh

    Linux archive

    distribution/app/bin/install.sh --user <user name> --group <group name>
 
-h | --help                                       : [optional] display usage
-u | --user                                       : [optional] (default: distribution) user which will be used to run the product, it will be created if its unavailable
-g | --group                                      : [optional] (default: distribution) group which will be used to run the product, it will be created if its unavailable

    Check prerequisites for Distribution in Linux Archive before running the install script.

  4. Validate and customize the product configuration (optional), including the third party dependencies connection details and ports.

  5. Start and manage the Distribution service.

    systemd OS

    systemctl start|stop distribution.service

    systemv

    service distribution start|stop

    Docker Compose

    cd jfrog-distribution-<version>-compose
 
# Starting from Distribution 2.5.x Redis has been moved to a compose file of its own, this needs to be started before starting other services
docker-compose -p distribution-redis -f docker-compose-redis.yaml  up -d
 
# Starting from 2.5.x, PostgreSQL needs to be started before starting the other services.
docker-compose -p distribution-postgres -f docker-compose-postgres.yaml up -d
 
docker-compose -p distribution up -d
docker-compose -p distribution ps
docker-compose -p distribution down

    Linux Archive

    distribution/app/bin/distribution.sh start|stop

    You can install and manage Distribution as a service in Linux archive installation. For more information, see Start Distribution section under Linux Archive Manual Installation .

  6. Access Distribution from your browser at: http://<jfrogUrl>/ui/.

    Go to the Distribution tab in the Application module in the UI.

  7. Check the Distribution log.

    tail -f $JFROG_HOME/distribution/var/log/console.log

    Configure log rotation of the console log

    The console.log file can grow quickly since all services write to it. For more information, see configure the log rotation.Configuring Log Rotation for Tomcat

Distribution Product Configuration

After installing and before running Distribution, 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 $JFROG_HOME/distribution/var/etc folder. For more information, see Distribution YAML Configuration.

If you don't have a System YAML file in your folder, copy the template available in the folder and name it system.yaml.

For the Helm charts, the system.yaml file is managed in the chart’s values.yaml.

Artifactory Connection Details for Distribution

Distribution requires a working Artifactory server and a suitable license.

The Distribution connection to Artifactory requires the following parameters.

  • jfrogUrl - 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://jfrog.acme.com instead of http://10.20.30.40:8082.

    Set it in the Shared Configurations section of the $JFROG_HOME/distribution/var/etc/system.yaml file.

  • join.key - This is the secret key required by Artifactory for registering and authenticating the Distribution server.

    You can fetch the Artifactory joinKey (join Key) from the JPD UI in the Administration module | User Management | Settings | Join Key.

    Set the join.key used by your Artifactory server in the Shared Configurations section of the $JFROG_HOME/distribution/var/etc/system.yaml file.

Add Signing Keys to JFrog Distribution

The JFrog Platform supports signing keys to establish trust with your clients for downloading your packages from Artifactory. Signing keys consist of a public and a private key pair, which are used for signing and verifying release bundles. When installing a new Edge, you will need to propagate the public keys to the new Edge. To learn about how to add and propagate keys, see GPG Signing.GPG Signing

Change PostgreSQL Database Credentials

Distribution comes bundled with a PostgreSQL Database out-of-the-box, which comes pre-configured with default credentials

To change the default credentials:

# Access PostgreSQL as the Distribution user adding the optional -W flag to invoke the password prompt
$ psql -d distribution -U distribution -W
  
# Securely change the password for user "distribution". Enter and then retype the password at the prompt.
\password distribution
  
# Verify the update was successful by logging in with the new credentials
$ psql -d distribution -U distribution -W

Set your PostgreSQL connection details in the Shared Configurations section of the $JFROG_HOME/distribution/var/etc/system.yaml file.

Change Redis Database Credentials

Redis Password Restrictions

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

  1. Set the new password in the $JFROG_HOME/distribution/app/third-party/redis/redis.conf file.

    requirepass <new password>

    • Docker Compose

      The file is available at $JFROG_HOME/distribution/app/third-party/redis/redis.conf.

    • RPM/DEB

      The file is available at $JFROG_HOME/distribution/app/third-party/redis/redis.conf.

    • Linux Archive

      The file is available at $JFROG_HOME/distribution/app/third-party/redis/redis.conf.

  2. Set your Redis password in the Shared Configurations section of the $JFROG_HOME/distribution/var/etc/system.yaml file.

  3. For Helm installations, you can set the password in the values.yaml file.

    distribution:
 jfrogUrl: http://xx.xx.xxx.xx
 joinKey: 6a8d2eaa5eab7d6945c020245c98344b9b42b9665073a36c74645d52e565dce4
 persistence:
  enabled: true
redis:
 password: <password>

  4. Restart all the services.

    Docker Compose

cd jfrog-distribution-<version>-compose
docker-compose -p distribution restart
    RPM/DEB

service distribution restart / systemctl restart distribution.service
    Linux Archive

distribution/app/bin/distribution.sh restart