Search

Working with an older version?

JFrog Artifactory 6.x
JFrog Xray 2.x
JFrog Mission Control 3.x
JFrog Distribution 1.x

Skip to end of metadata
Go to start of metadata

Overview

This page provides a guide for the different ways you can install and configure JFrog Artifactory, single node and high availability. For additional information, refer to high availability.

System Requirements

Before you install Artifactory please refer to System Requirements for information on supported platforms, supported browsers and other requirements. To learn about the JFrog Platform Deployment, refer to System Architecture.

Installation Types

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

Subscription TypeInstall Type
Pro
Pro X
Enterprise
Enterprise+
pro
Artifactory OSS
oss
Artifactory CE
cpp-ce
JFrog Container Registry
jcr

Installation Steps

The installation procedure involves the following main steps:

  1. Download the package 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. Post-Install Steps including changing the default password.

Default Home Directory / $JFROG_HOME

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

Note: This guide uses $JFROG_HOME to represent the JFrog root directory containing the deployed product, the home directory for all JFrog products.

Page Contents

Single Node Installation

The following installation methods are supported:

Linux Archive Installation

  1. Create a JFrog Home directory and move the downloaded installer archive into that directory, for example:

    mkdir jfrog
mv jfrog-artifactory-<pro|oss|cpp-ce>-<version>-linux.tar.gz jfrog
cd jfrog


  2. Set the JFrog Home environment variable

    export JFROG_HOME=<full path of the jfrog directory>

  3. Extract the contents of the compressed archive and move it into artifactory directory.

    tar -xvf jfrog-artifactory-<pro|oss|cpp-ce>-<version>-linux.tar.gz
mv artifactory-<pro|oss|cpp-ce>-<version>-linux artifactory
  4. Customize the product configuration (optional) including database, Java Opts, and filestore.

  5. Run Artifactory as a foreground, background process, or as a service.
    As a process
    Run Artifactory as a foreground or daemon process. Note: when running as a foreground process, the console will be locked and the process can be stopped at any time.

    Foreground Process
    $JFROG_HOME/artifactory/app/bin/artifactoryctl
    Daemon Process
    $JFROG_HOME/artifactory/app/bin/artifactoryctl start

    Manage the process.

    $JFROG_HOME/artifactory/app/bin/artifactoryctl check|stop

    As a service

    Artifactory is packaged as an archive file with a bundled Tomcat, and a complete install script that can be used to install it as a service running under a custom user. Currently supported on Linux and Solaris systems.

    OS User Permissions

    When running Artifactory as a service, the installation script creates a user called artifactory which must have run and execute permissions on the installation directory.

    It is recommended to extract the Artifactory download file into a directory that gives run and execute permissions to all users such as /opt.

    To install Artifactory as a service, browse to the $JFROG_HOME/artifactory/app/bin directory and execute the following command as root:

    # USER (optional) - the user you want application to run as (default = artifactory)
# GROUP (optional) - the group with which the application will run as. (default = artifactory)
$JFROG_HOME/artifactory/app/bin/installService.sh [USER [GROUP]]

    To manage the service, use systemd or init.d commands depending on your system.

    Using systemd
     systemctl <start|stop|status> artifactory.service
    Using init.d
    service artifactory <start|stop|check>

    If Artifactory is running, you should see its pid , if not, you will see a list of environment variables used by the service.

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

  7. Check Artifactory Log.

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

Docker Installation

  1. Create your Artifactory home directory and an empty system.yaml file.
    Note: the user creating the folder should be the user running docker run.

    mkdir $JFROG_HOME/artifactory/var/etc/
cd $JFROG_HOME/artifactory/var/etc/
touch ./system.yaml
chown -R 1030:1030 $JFROG_HOME/artifactory/var

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

    For the Docker Installation, ensure 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 the container's IP, meaning other nodes and services will not be able to reach this instance.


  3. Start the Artifactory container.

    $docker run -name artifactory -v $JFROG_HOME/artifactory/var/:/var/opt/jfrog/artifactory -d -p 8081:8081 -p 8082:8082 docker.bintray.io/jfrog/artifactory<pro|oss|cpp-ce>:latest

  4. Manage Artifactory using native Docker commands.

    Examples
    docker ps
docker stop artifactory
  5. Access Artifactory from your browser at: http://SERVER_HOSTNAME:8082/ui/. For example, on your local machine: http://localhost:8082/ui/.

  6. Check Artifactory Log.

    docker logs -f artifactory

Docker Compose Installation

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

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

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

    ./config.sh

  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. 

    For the Docker Installation, ensure 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 the container's IP, meaning other nodes and services will not be able to reach this instance.


  4. Manage Artifactory using native Docker Compose commands, docker-compose -p rt <action> command.
    Note: Run this command from the extracted folder.

    Examples
    docker-compose -p rt ps
docker-compose -p rt up -d
docker-compose -p rt down
  5. Access Artifactory from your browser at: http://SERVER_HOSTNAME:8082/ui/. For example, on your local machine: http://localhost:8082/ui/. 

  6. Check Artifactory Log.

    docker-compose -p rt logs

RPM Installation

  1. Install Artifactory as a service on Red Hat compatible Linux distributions, as a root user.

    yum install -y jfrog-artifactory-<pro|oss|cpp-ce>-<version>.rpm
  2. Customize the product configuration (optional) including database, Java Opts, and filestore.

  3. Manage Artifactory using the following commands.

    service artifactory start|stop
  4. Access Artifactory from your browser at: http://SERVER_HOSTNAME:8082/ui/. For example, on your local machine: http://localhost:8082/ui/.

  5. Check Artifactory Log.

    tail -F $JFROG_HOME/artifactory/var/log/console.log

Debian Installation

  1. Install Artifactory as a service on compatible Linux distributions, as a root user.

    dpkg -i jfrog-artifactory-<pro|oss|cpp-ce>-<version>.deb
  2. Customize the product configuration (optional) including database, Java Opts, and filestore.

  3. Manage Artifactory using the following commands.

    service artifactory start|stop|status
  4. Access Artifactory from your browser at: http://SERVER_HOSTNAME:8082/ui/. For example, on your local machine: http://localhost:8082/ui/.

  5. Check Artifactory Log.

    tail -F $JFROG_HOME/artifactory/var/log/console.log

Helm Installation 

The JFrog official Artifactory Helm charts are available via Helm Hub.
The sources for these charts are available in JFrog's charts GitHub repository.

Detailed instructions on installing and upgrading an Artifactory or Artifactory HA installation are documented in the chart's README.md file which are available on JFrog's Charts GitHub repository:


Mac (Darwin) Installation

Note: the Mac installation can only be used for testing. It is not supported in development, staging or production environments.

  1. Create a JFrog Home directory and move the downloaded installer archive into that directory, for example:

    mkdir jfrog
mv jfrog-artifactory-<pro|oss|cpp-ce>-<version>-darwin.tar.gz jfrog
cd jfrog

  2. Set the JFrog Home environment variable

    export JFROG_HOME=<full path of the jfrog directory>

  3. Extract the contents of the compressed archive and move it into artifactory directory.

    tar -xvf jfrog-artifactory-<pro|oss|cpp-ce>-<version>-darwin.tar.gz
mv artifactory-<pro|oss|cpp-ce>-<version>-darwin artifactory
  4. Customize the product configuration (optional) including database, Java Opts, and filestore.

  5. Run Artifactory as a foreground or a background process.
    Note: when running as a foreground process, the console will be locked and the process can be stopped at any time.

    Foreground Process
    $JFROG_HOME/artifactory/app/bin/artifactoryctl
    Daemon Process
    $JFROG_HOME/artifactory/app/bin/artifactoryctl start

    Manage the process.

    $JFROG_HOME/artifactory/app/bin/artifactoryctl check|stop
  6. Access Artifactory from your browser at: http://SERVER_HOSTNAME:8082/ui/. For example, on your local machine: http://localhost:8082/ui/.

  7. Check Artifactory Log.

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

Windows Installation

  1. Create a JFrog Home directory and move the downloaded installer archive into that directory, for example:

    mkdir jfrog
move jfrog-artifactory-<pro|oss|cpp-ce>-<version>-windows.zip jfrog
cd jfrog

  2. Set the JFrog Home environment variable

    set JFROG_HOME=<full path of the jfrog directory>

  3. Extract the contents of the compressed archive and go to the extracted folder. Define the path to this folder as an environment variable called JFROG_HOME.

    # Extract jfrog-artifactory-<pro|oss|cpp-ce>-<version>-windows.zip into jfrog folder
move jfrog-artifactory-<pro|oss|cpp-ce>-<version>-windows\artifactory-<pro|oss|cpp-ce>-<version> artifactory


  4. Install Artifactory manually or as a service.
    Manual Installation
    Browse to %JFROG_HOME%\artifactory\app\bin and execute the file artifactory.bat.

    Security settings

    Depending on the security settings under Windows, you might need to run artifactory.bat using 'Run as administrator'

    Service Installation
    Browse to %JFROG_HOME%\artifactory\app\bin, and execute the file InstallService.bat.

    Security

    Windows 8 implements strict User Account Control (UAC). You must either disable UAC or right-click on cmd.exe and select "Run as administrator" in order to run this script.

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

  6. Manage Artifactory using the following commands, in a Command Prompt window.

    sc start|stop|query artifactory

  7. Check Artifactory Log in the %JFROG_HOME%\artifactory\var\log\artifactory-service.log file.

HA Installation

The following describes how to set up an Artifactory HA cluster with more than one node. For more information about HA, see JFrog High Availability.


Prerequisites

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: Oracle, MySQL, MS SQL and PostgreSQL.

Make sure you have completed setting up your external database before proceeding to install the first node. 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 secondary node, please add each node license using already running primary node.

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.

The following installation methods are supported:

Note: HA is not supported for Mac (Darwin) installation

Linux Archive/Docker/RPM/Debian/Windows Installation

Primary Node

  1. Install the first node according to the single node installation. Important: make sure not to start Artifactory.

  2. Configure the system.yaml file with the database and first node configuration details. For example: 

    First node system.yaml
    shared: 
  database: 
    driver: org.postgresql.Driver
    password: password
    type: postgresql
    url: "jdbc:postgresql://localhost:5432/artifactory"
    username: artifactory
  node: 
    haEnabled: "true"
    primary: "true"

  3. Configure the binarystore.xml in $JFROG_HOME/artifactory/var/etc/artifactory. For example,

    <config version="2">
    <chain template="cluster-file-system"/>
</config>

  4. Start the first node.

    service artifactory start
    Windows
    sc start artifactory
    Docker
    $ docker run --name artifactory -v $JFROG_HOME/artifactory/var/:/var -d -p 8081:8081 -p 8082:8082 docker.bintray.io/jfrog/artifactory-<pro|oss|cpp-ce>:latest

Node ID and IP

Note: For the Docker Installations, ensure to set a host's ID and IP in the system.yaml.
If these are not manually added, they are automatically resolved as the container's hostname and IP, meaning other nodes and services will not be able to reach this instance.

shared:
  node:
    id: "MyNodeID"
    ip: "10.1.2.3"

Secondary Nodes

In order for a node to join a cluster, the node must have the same database configuration and the Master Key. Install all additional nodes using the same steps described above, with the additional steps below:

  1. Configure the system.yaml file for the secondary node with master key and database configurations.

    Additional node system.yaml
    shared: 
  database: 
    driver: org.postgresql.Driver
    password: password
    type: postgresql
    url: "jdbc:postgresql://localhost:5432/artifactory"
    username: artifactory
  node: 
    haEnabled: "true"
    primary: "false"
  2. Copy the master.key from the first node to the additional node located at $JFROG_HOME/artifactory/var/etc/security/master.key.

  3. Start the additional node.

Docker Compose Installation

Primary Node

Use the Docker Compose script with the following commands to easily setup your HA instance. Make sure to install the database and each Artifactory cluster node on different nodes.

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

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

  2. Run the config.sh script to setup folders with required ownership. This is an interactive script.

    ./config.sh
  3. Customize any additional product configuration (optional) including, Java Opts and filestore.

  4. Start Artifactory using docker-compose commands. Note: Run this command only from the extracted folder.

    docker-compose  -p rt logs
docker-compose  -p rt ps
docker-compose  -p rt up -d
docker-compose  -p rt down

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

  6. Check Artifactory Log.

    docker-compose  -p rt logs

Node ID and IP

Note: For the Docker Installations, ensure to set a host's ID and IP in the system.yaml.
If these are not manually added, they are automatically resolved as the container's hostname and IP, meaning other nodes and services will not be able to reach this instance.

shared:
  node:
    id: "MyNodeID"
    ip: "10.1.2.3"

Secondary Nodes

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

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

  2. Run the config.sh script to setup folders with required ownership

    ./config.sh
  3. Copy the master.key from primary node to the  secondary node at $JFROG_HOME/artifactory/var/etc/security 
  4. Customize any additional product configuration (optional) including, Java Opts and filestore.

  5. Start Artifactory using docker-compose commands.

    docker-compose -p rt logs
docker-compose -p rt ps
docker-compose -p rt up -d
docker-compose -p rt down

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

  7. Check Artifactory Log.

    docker-compose -p rt logs

Helm Installation 

The JFrog official Artifactory Helm charts are available via Helm Hub.
The sources for these charts are available in JFrog's charts GitHub repository.

Detailed instructions on installing and upgrading an Artifactory or Artifactory HA installation are documented in the chart's README.md file which are available on JFrog's Charts GitHub repository:


Adding Licenses

Add licenses according to your license type:
License Key

  • Option 1: Copy the artifactory.cluster.license file to the primary node's configuration directory.

    cp artifactory.cluster.license $JFROG_HOME/artifactory/var/etc/artifactory/

  • This can also be done once you start Artifactory using:

Specifying multiple licenses

Whether in the Artifactory UI, using the REST API or in the artifactory.cluster.license file, make sure that the licenses are separated by a newline.

License Bucket

Applying a license bucket requires installing JFrog Mission Control. To apply the license bucket:

  1. Complete configuring and starting the first node (steps 4 and 5)
  2. Install JFrog Mission Control

  3. Apply your license Bucket Management in the UI

Post-Install Steps

Once the installation is complete, 

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.

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

    • Database
      Artifactory comes with an embedded Derby Database out-of-the-box. If you're planning to use it in production, it is highly recommended to first configure any alternate supported databases, and then start Artifactory.

    • Customize Java Opts (optional)
      Remember to modify your JVM Parameters as needed by setting JAVA_OPTIONS in $JFROG_HOME/artifactory/var/etc/system.yaml. The property to pass extra Java opts is artifactory.extraJavaOpts. It is highly recommended to set your Java memory parameters as follows:

      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), please refer to System Requirements

    • Additional Settings
      These include: customizing ports, joinKey (join.key), 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.

For Advanced Users

Linux Archive

Install Script Commands

The following are the sequence of commands performed by the Linux Archive install script.

User creation
  • Creates a default user named artifactory ($JF_ARTIFACTORY_USER).

To change the default user, edit the artifactory.user (and artifactory.group) parameter in the $JFROG_HOME/artifactory/var/etc/system.yaml.

When running the service with a different user, make sure to update the artifactory.user and the artifactory.group parameters in the $JFROG_HOME/artifactory/var/etc/system.yaml file.

artifactory default
  • Modifies the $JFROG_HOME/artifactory/app/bin/artifactory.default file containing the main environment variables needed for Artifactory to run.
    Such as: JF_PRODUCT_HOME, TOMCAT_HOME, JAVA_OPTIONS.

To modify your JVM parameters, modify the artifactory.extraJavaOpts parameter in the $JFROG_HOME/artifactory/var/etc/system.yaml. 

systemd or init
  • Installs the Artifactory service on systemd if supported, or init.d.
    • systemd is supported: the install script copies the artifactory to /etc/systemd/system/artifactory.service script file
    • systemd is not supported: the install script copies the artifactory script file to /etc/init.d/artifactory 
Tomcat Preparation
  • Creates the logs directory $JFROG_HOME/artifactory/var/log folder, with write permissions to the JF_ARTIFACTORY_USER (created at the start of the script).
  • Creates a soft link $JFROG_HOME/artifactory/var/log/artifactory/catalina.
    The $JFROG_HOME/artifactory/app/artifactory/tomcat/logs folder is linked to $JFROG_HOME/artifactory/var/log/artifactory/catalina.
  • Creates a work directory for tomcat $JFROG_HOME/artifactory/var/work/artifactory/tomcat.
chkconfig calls
  • Activates the Artifactory Service and adds it to the chkconfig list.
Set ownership
  • Defines the permissions for the $JFROG_HOME/artifactory/var and $JFROG_HOME/artifactory/app files, for the $JF_ARTIFACTORY_USER. 

Manual Docker Compose Installation

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

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

  2. Create the following folder structure under $JFROG_HOME/artifactory_HOME

    -- [1030     1030    ]  var
    |-- [1030     1030    ]  data
    |   |-- [104   107 ]  nginx 						- Necessary if you want to add nginx
    |   `-- [999     999  ]  postgres					- Necessary if you want to add postgres
    |-- [1030     1030    ]  etc

  3. Copy the appropriate docker-compose templates from the templates folder to the extracted folder. Rename it as docker-compose.yaml

    RequirementTemplate
    Artifactory + Derby (inbuilt database)docker-compose.yaml
    Artifactory + Postgresdocker-compose-postgres.yaml
    Artifactory + Nginxdocker-compose-nginx.yaml

  4. Update the .env file with the Installation directory

    ROOT_DATA_DIR=/root/.jfrog/artifactory
  5. Customize the product configuration.
    1. Customize the PostgreSQL Database connection details. (optional)

    2. Set any additional configurations (for example: ports, node id) using the Artifactory system.yaml configuration file.

      Ensure the host's ID "shared.node.id" and IP "shared.node.ip" are added to the system.yaml. If these are not added, the container's IP will be used and other Platform Deployments, products will be unable to reach this instance

  6. Customize any additional product configuration (optional) including, Java Opts and filestore.

  7. Start Artifactory using docker-compose commands.

    docker-compose -p rt logs
docker-compose -p rt ps
docker-compose -p rt up -d
docker-compose -p rt down

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

  9. Check Artifactory Log.

    docker-compose -p rt logs



Copyright © 2019 JFrog Ltd.