Installing Artifactory

JFrog Installation & Setup Documentation
ft:sourceType
Paligo

You can install and configure JFrog Artifactory in both single node and high availability modes. For additional information on high availability, see high availability.

Note

Use a dedicated server with no other software running to alleviate performance bottlenecks, avoid port conflicts, and avoid setting uncommon configurations.

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

Artifactory on Amazon ECS

You can install Artifactory on Amazon ECS as a single node installation. On Amazon ECS, you are limited to a 4 CPU instance and you cannot connect or use other JFrog products like Xray or Distribution.

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

Before You Begin

Before installing Artifactory, see System Requirements for information on supported platforms, supported browsers, and other requirements. You must set aside ports that are reserved for Artifactory and set up the required database for Artifactory.

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.

Installation Steps

The installation procedure involves the following main steps.

  1. Download the relevant package from the Download JFrog Platform page, according to the above table, to install (Linux Archive, Docker Image, Docker Compose, RPM, Debian, Helm, Windows).

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

  3. Customize the product configuration (optional) including database, Java Opts, and filestore.

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

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

  6. Implement post-installation steps including changing the default password.

Default Home Directory / $JFROG_HOME

The default Xray home directory is defined according to the installation type. For additional details see the Product Directory Structure page.

$JFROG_HOME represents the JFrog root directory containing the deployed product.

Did you know?

You can also deploy the JFrog products with different Cloud providers and multiple orchestration tools. For more information, see JFrog Partner Integrations.JFrog Partner Integrations

Installation Types

The install type is referenced as <type> in the different installation instructions.

Subscription Type

Install Type

Download the Package

Pro Pro X Enterprise X Enterprise+

pro

Download Link

Artifactory OSS

oss

Download Link

JFrog Container Registry

jcr

Download Link

Artifactory Single Node Installation

The following installation methods are supported.

Artifactory HA Installation

Artifactory supports installation in an HA cluster. For more information about HA, see JFrog High Availability.

Note

HA versions before Artifactory 7.17.4 support using primary and secondary nodes.

The following installation methods are supported.

HA is not supported for Mac (Darwin) installation

Prerequisites to run Artifactory HA

Ensure that your environment meets the following prerequisites.

Version

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

Database

Artifactory HA requires an external database, and currently supports the following databases: PostgreSQL, Oracle, MySQL, and MS SQL.

Make sure you have completed setting up your external databasebefore proceeding to install the cluster nodes. The database connection details are used for each node installation.

Licensing

Artifactory HA is supported with an Enterprise License. Each node in the cluster must be activated with a different license.

Before adding any additional node, please add each additional node's license using the node that is already running.

Load Balancer

Artifactory HA requires a dedicated Load Balancer. The load balancer should be installed once all of the cluster nodes are up and running. It is the responsibility of your organization to manage and configure it correctly.

Network

  • All the Artifactory HA components (Artifactory cluster nodes, database server, and load balancer) must be within the same fast LAN.

  • All the HA nodes must communicate with each other through dedicated TCP ports.

  • Network communications between the cluster nodes must be enabled for each of the nodes.

Note

Use a dedicated server with no other software running to alleviate performance bottlenecks, avoid port conflicts, and avoid setting uncommon configurations.

Artifactory System Requirements

Artifactory system requirements depend mainly upon the expected amount of active clients.

Number of Active Clients

Processor

Memory

Disk Space

0-20

4 core CPU

4 GB

Based on the expected artifact storage volume. Fast disk with free space that is at least 3 times the total size of stored artifacts.

0-100

4 core CPU

8GB

Based on the expected artifact storage volume. Fast disk with free space that is at least 3 times the total size of stored artifacts.

100-200

8 core CPU

12 GB

Based on the expected artifact storage volume. Fast disk with free space that is at least 3 times the total size of stored artifacts.

Backup SAN is recommended.

200+

Contact JFrog Support

Contact JFrog Support

Based on the expected artifact storage volume. Fast disk with free space that is at least 3 times the total size of stored artifacts.

Contact JFrog Support

Supported Platforms

Product

Debian

Centos*

RHEL

Ubuntu

Windows Server

Helm Charts

SLES

Artifactory

10.x, 11.x

7.x

7.x, 8.x

18.04, 20.04, 22.04

2016 or 2019

3.x

12 SP5

Breaking Change Affecting RPM/Yum/Linux Archive Installations on Centos 7.x*

As part of our commitment to our customers to maintain the security and reliability of your JFrog Platform, from Artifactory version v7.43.x, JFrog Artifactory will officially run with JDK 17 and Tomcat 9.x on all installation types. Note that JDK 17 and Tomcat 9.x are not supported on all Centos 7.x versions.

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.

Filestore

The filestore is where binaries are physically stored.

Artifactory provides the following options to store binaries.

  • Local file system in which binaries are stored with redundancy using a binary provider, which manages synchronizing files between the cluster nodes according to the redundancy defined.

  • Cloud storageAmazon S3 and Google Cloud Storage

  • Network File System (NFS)

For detailed information, see Filestore Configuration.

Working with Very Large Storage

In most cases, our recommendation is for storage that is at least 3 times the total size of stored artifacts in order to accommodate system backups.Backups

However, when working with a very large volume of artifacts, the recommendation may vary greatly according to the specific setup of your system. Therefore, when working with over 10 TB of stored artifacts, contact JFrog support, who will work with you to provide a recommendation for storage that is customized to your specific setup.

Allocated storage space may vary

Xray downloads and then deletes fetched artifacts after indexing. However, in order to have more parallel indexing processes, and thereby more temporary files at the same time would require more space.

This is especially applicable for large BLOBs such as Docker images.

Binary Storage

While Artifactory can use a Networked File System (NFS) for its binary storage, you should do not install the application itself on an NFS. The Artifactory application needs very fast, reliable access to its configuration files. Any latency from an NFS will result in poor performance when the application fails to read these files. Therefore, install Artifactory on a local disk mounted directly to the host.

To use an NFS to store binaries, use the "file-system" binarystore.xml configuration with the additional "<baseDataDir>" setting.

Artifactory Database Requirements

You can configure your own database from the following list.

Artifactory supports the following databases.

  • MySQL

  • Oracle

  • MS SQL

  • PostgreSQL

  • MariaDB

Artifactory HA requires an external database, which is fundamental to management of binaries and is also used to store cluster wide configuration files.

Since Artifactory HA contains multiple Artifactory cluster nodes, your database must be powerful enough to service all the nodes in the system. Moreover, your database must be able to support the maximum number of connections possible from all the Artifactory cluster nodes in your system.

If you are replicating your database you must ensure that at any given point in time all nodes see a consistent view of the database, regardless of which specific database instance they access. Eventual consistency, and write-behind database synchronization is not supported.

PostgreSQL

Artifactory supports the following versions of PostgreSQL.

  • 9.5 (EOL)

  • 9.6 (EOL)

  • 10.x

  • 11.x

  • 12.x

  • 13.x

Oracle

Artifactory supports the following versions of Oracle.

  • 12.2

  • 18

  • 19

MySQL

Artifactory supports the following versions of MySQL.

  • Artifactory 7.0 to 7.6: MySQL 5.7

  • Artifactory 7.7 and above: MySQL 5.7. and 8.x.

MySQL 5.6 is no longer supported as it has reached its EOL; users are requested to upgrade to the above versions of MySQL.

Microsoft SQL Server

Microsoft SQL Server 2012 and later.

Artifactory does not support Kerberos SSO for MS SQL.

MariaDB

MariaDB 10.2.9 - 10.4 and MariaDB 10.5.9-10.5.19.

Artifactory Network Ports

Artifactory uses external network ports to communicate with services outside Artifactory and internal networks to communicate with Artifactory and other JFrog Platform microservices.

External Network Ports

Artifactory uses the following external network ports by default.

  • 8081

  • 8082

Internal Network Ports

Artifactory uses the following internal network ports.

Microservice

Port

Artifactory

8081

Access

8040 and 8045

Web

8070

Replicator

8048 and 9092

Metadata

8086

Router

8082, 8046, 8047, 8049, and 8091

Events

8061, and 8062

Integration

8071 and 8072

JFConnect

8030

Observability

8036

gRPC

8037

Default Home Directory / $JFROG_HOME

The default Xray home directory is defined according to the installation type. For additional details see the Product Directory Structure page.

$JFROG_HOME represents the JFrog root directory containing the deployed product.