Install Artifactory Single Node with Docker Compose

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

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

Artifactory System Requirements
Operating Systems and Platform Support

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

Product

Debian

RHEL

Ubuntu

Amazon Linux

Windows Server

Artifactory

11.x, 12.x

8.x, 9.x

20.04, 22.04, 24.04

Amazon Linux 2023

2016 or 2019

Note

The yum install command is not supported on Ubuntu operating systems.

For more information about the supported operating systems for Insights and Pipelines, see Insights System Requirements and Pipelines System Requirements.

Note

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

Supported Platforms

The following table lists the supported platforms:

Product

x86-64

ARM64

Kubernetes

OpenShift

Artifactory

1.27+

4.14+

For more information about the supported platforms for Insights and Pipelines, see Insights System Requirements and Pipelines System Requirements.

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

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

Starting from version 7.41.4, Artifactory supports installation on ARM64 architecture specifically through Helm and Docker installations. When deploying Artifactory 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.

Additionally, ARM64 support is available for Xray and Distribution all through container-based Installations.

Artifactory Database Requirements

Artifactory supports the following databases:

  • PostgreSQL

    Tip

    JFrog highly recommends using PostgreSQL for all products in the JFrog Platform. For more information, see Choose the right database.

  • Oracle

  • MySQL

  • Microsoft SQL Server

  • MariaDB

Artifactory HA requires an external database, which is fundamental for the 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.

Artifactory Filestore

The filestore is where the binaries are physically stored.

Artifactory provides the following options to store binaries:

  • Local file system stores binaries with redundancy, using a binary provider that manages the synchronization of files between cluster nodes according to the defined redundancy settings.

  • Cloud storage is done using Amazon S3, Microsoft Azure, and Google Cloud Storage.

  • Network File System (NFS)

For more information, see Filestore Configuration.

Binary Storage

While Artifactory can use a Networked File System (NFS) for its binary storage, you should 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.

Working with Very Large Storage

In most cases, our recommendation for storage 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.

Artifactory Network Ports

Artifactory uses external network ports to communicate with services outside Artifactory and internal network ports 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

HTTP: 8081, 8091

Frontend

HTTP: 8070

Access

HTTP: 8040, 8015

gRPC: 8045, 8016

Topology

HTTP: 8020

gRPC: 8021

One Model

HTTP: 8071

gRPC: 8072

Apollo Router

HTTP: 8074

Metadata

HTTP: 8086

Router

HTTP: 8082, 8046, 8049

gRPC: 8047

Observability

HTTP: 8036

gRPC: 8037

Event

HTTP:8061

gRPC: 8062

Mission Control

HTTP: 8080

JFConnect

HTTP: 8030

gRPC: 8035

JFConfig

HTTP: 8010

Evidence

HTTP: 8051

Artifactory Federation Service (RTFS)

HTTP: 8025

gRPC: 8026

Additionally, review Docker specific requirements.

Docker Requirements

For Docker and Docker Compose installations, JFrog services require Docker 20.10.10 and above, and Docker Compose v1.24 and above to be installed on the machine where you want to run them.

For more information, see Docker and Docker Compose.

Installation Steps

Follow these steps to install the product:

Redhat UBI Micro base image

In an effort to provide a more secure Artifactory image, Artifactory now uses the Redhat UBI Micro base image. Some of the tools that were available in the Artifactory image are not available in this more secure image. For more information, see JFrog Products Container Base Image.

  1. Go to the download page, click the green arrow to download Docker Compose. Extract the contents of the compressed archive (.tar.gz file) and then go to the extracted folder.

    tar -xvf jfrog-artifactory-<pro|oss|jcr|cpp-ce>-<version>-compose.tar.gz

    • The placeholders <pro|oss|cpp-ce> signify the different editions of JFrog Artifactory that you can choose to install.

    • The placeholder <version> signify the version of JFrog Artifactory that you can choose to install.

    For example,

    tar -xvf jfrog-artifactory-pro-7.104.10-compose.tar.gz

    .env file included within the Docker Compose archive

    This .env file is used by Docker Compose and is updated during installations and upgrades.

    Notice that some operating systems do not display dot files by default. If you make any changes to the file, remember to backup before an upgrade.

  2. Run the interactive script to setup folders with required ownership.

    bash ./config.sh

    Note

    The config.sh script is used at the beginning of the installation process to create the necessary folder structure on each node and assign the appropriate ownership. This step is crucial for the correct functioning of Artifactory HA. If you opt to use Docker Compose instead, be aware that you will need to manually set up the folder structure and permissions as specified in the .env file.

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

    Depending on your choices, a selected docker-compose.yaml will be available in the extracted folder. However, there are a few docker-compose templates in the directory templates. You can choose any template and copy it to the extracted folder as docker-compose.yaml.

    Docker for Mac

    When you use Docker Compose in Mac, /etc/localtime might not work as expected since it might not be a shared location in the docker-for-mac settings.

    You can remove the following line from the selected docker-compose.yaml file to avoid installation issues.

  4. For Docker installations, verify that the host's ID shared.node.id and IP shared.node.ip are added to the system.yaml.

    If these are not manually added, they are automatically resolved as the container's IP, meaning other nodes and services will not be able to reach this instance.

    shared:
  node:
    ip: host-ip // Actual IP of the host machine
    id: host-id

  5. Manage Artifactory using native Docker Compose commands, docker-compose -p rt <action> command.

    Run these commands from the extracted folder.

    # Starting from 7.8.x, PostgreSQL needs to be started before starting the other services.
docker compose -p rt-postgres -f docker-compose-postgres.yaml up -d
docker compose -p rt-postgres -f docker-compose-postgres.yaml down
docker compose -p rt up -d
docker compose -p rt down

  6. Access Artifactory from your browser at http://SERVER_HOSTNAME:8082/ui/. For example, on your local machine at http://localhost:8082/ui/.

  7. Check Artifactory Log.

    docker-compose -p rt logs

    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

Artifactory Product Configuration

After installing and before running Artifactory, you may set the following configurations:

  • System YAML Configuration File

    Where to find system.yaml?

    You can configure all your system settings using the system.yaml file located in the $JFROG_HOME /artifactory/var/etc folder. For more information, see System 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 file.

  • Configuring Database

    If you're planning to use it in production, it is highly recommended to first Configure the Database, and then start Artifactory.

  • Customize Java Opts (optional)

    Remember to modify your JVM Parameters as needed by setting JAVA_OPTIONS in Shared Configurations. The property to pass extra Java opts is artifactory.extraJavaOpts. It is highly recommended to set your Java memory parameters as follows:

    Tip

    The larger your repository or number of concurrent users, the larger you need to make the -Xms and -Xmx values accordingly. If you can reserve at least 512MB for Artifactory, the recommended minimal values are:

    -server -Xms512m -Xmx2g -Xss256k -XX:+UseG1GC

    For more recommendations about your hardware configuration (especially the -Xmx parameter), see System Requirements

  • Additional Settings

    The additional settings are about customizing ports, joinKey (join.key) and masterKey (master.key).

  • Configuring the Filestore

    By default, Artifactory is configured to use the local file system as its filestore. Artifactory supports a variety of additional filestore configurations to meet a variety of needs for binary storage providers, storage size, and redundancy.

Enable TLS 1.0 and 1.1 for Connectivity with Older Databases

Artifactory version 7.25.2 onwards includes OpenJDK version 11.0.11 and later. TLS 1.0 and TLS 1.1 are disabled by default from OpenJDK 11.0.11 onwards. If your database version does not support TLS 1.2, the Artifactory startup fails.

If you are unable to upgrade your database to a version that supports TLS 1.2 or later, perform the following steps to run Artifactory.

  1. Download the java.security file that has TLS 1.0 and 1.1 enabled.

  2. Create the directory, ${JFROG_HOME}/artifactory/var/bootstrap/artifactory/java.

  3. Copy the java.security file into ${JFROG_HOME}/artifactory/var/bootstrap/artifactory/java.

  4. Provide the appropriate permissions to the directory.

    Note

    Artifactory startup takes a backup of the existing java.security file and bootstraps custom java.security into the ${JFROG_HOME}/artifactory/app/third-party/java/conf/security folder.