Catalog Installation with Interactive Script

Installation types:

• Docker compose
• RPM or Debian
• Linux Archive

Prerequisites

Install the following prerequisites independently of the JFrog Catalog installation.

Valkey

Follow the instructions here for installing Valkey if a cache is required.

Subscription Type: Enterprise X

Supported from:

• Artifactory - 7.90.12 (for the catalog new service MFE)
• Xray version 3.107.0 and above (with MFE fixes)

Complete the following steps to install the product.

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

   cd jfrog-catalog<version>-compose

2. Install

   Docker Compose

   1. Run the installer script ./config.sh and follow the instructions. The script prompts you with a series of mandatory inputs, including the jfrogURL (custom base URL) and joinKey. This generates the system.yaml file.

   2. If Valkey is required, after config.sh completes, update the generated system.yaml (for example, /root/.jfrog/catalog/var/etc/system.yaml) with the Valkey cache section:

      YAML

      shared:
        cache:
          enabled: true
          connectionString: redis://<IP>:6379
          parameters: mode=single;password=<VALKEY_PASSWORD>
          defaultKeyExpirationSecs: 3600
          maxWarmupKeys: 1000
          warmupPoolSize: 10

   3. Start Catalog:

      Bash

      docker-compose -p catalog up -d

Native (RPM/DEB)

1. Extract the contents of the compressed Xray archive and go to the Catalog folder.cd jfrog-catalog <version>-deb/rpm

2. Run the installer script ./install.sh and follow the instructions. This must be run as the root user.

3. If Valkey is required, before starting up Catalog, add a cache section to the system.yaml of Catalog with Valkey password:

   YAML

   shared:
     cache:
       enabled: true
       connectionString: redis://localhost:6379
       parameters: mode=single;password=<VALKEY_PASSWORD>
       defaultKeyExpirationSecs: 3600
       maxWarmupKeys: 1000
       warmupPoolSize: 10
       warmupDBMaxOpenConns: 10
       warmupDBMaxIdleConns: 5
       invalidationPoolSize: 5
       invalidationIntervalSecs: 60

Linux Archive

1. Extract the contents of the compressed Xray archive. You will find the Catalog folder there, in the format jfrog-catalog-<version>-linux. Move it into the catalog directory. (/opt/jfrog/catalog)

2. Run the installer script (/opt/jfrog/catalog/app/bin/install.sh). The script prompts you with a series of mandatory inputs, including the jfrogURL (custom base URL) and joinKey and masterKey, PostgreSQL database details.

3. If Valkey is required or installed, before starting up Catalog, add cache section to the system.yaml of Catalog with Valkey password:

   YAML

   shared:
     cache:
       enabled: true
       connectionString: redis://localhost:6379
       parameters: mode=single;password=<VALKEY_PASSWORD>
       defaultKeyExpirationSecs: 3600
       maxWarmupKeys: 1000
       warmupPoolSize: 10
       warmupDBMaxOpenConns: 10
       warmupDBMaxIdleConns: 5
       invalidationPoolSize: 5
       invalidationIntervalSecs: 60

4. After the installation is complete, follow the onscreen instructions to start the Catalog service.

   For example:

   Bash

   for eg: 
   chown -R catalog:catalog /opt/jfrog/catalog
   su - catalog
   /opt/jfrog/catalog/app/bin/catalog.sh start   // options - start/ stop/ restart

5. Install as a service (optional)

   If you want JFrog Catalog to be installed as a service with the Linux Archive installer, run installService.sh under the app/bin folder and then start catalog as a service shown below.

   Bash

   systemctl start catalog.service

6. Start Catalog Service

   1. Docker Compose

      Bash

      docker-compose -p catalog up -d

   2. RPM or Debian

      Bash

      systemctl start catalog.service

   3. Linux Archive

      Bash

      Through script:
      /opt/jfrog/catalog/app/bin/catalog.sh start   // options - start/ stop/ restart
      
      Through service
      systemctl start catalog.service

7. Access Catalog from your browser at:

   http://<jfrogUrl>:port/ui/catalog/packages/overview

Verifying Installation with a Health Check

After installing the JFrog Catalog, you can verify that it is properly configured and operational by using the app health API. This provides a quick status check on key aspects of the service, ensuring that the necessary entitlements, database connections, and central connectivity are in place.

API Request

Send a GET request to the following endpoint

GET <catalog-service>/api/v1/system/app_health

• No authentication is required.

• Example request:

  YAML

  https://localhost:8046/catalog/api/v1/system/app_health

API Response

A JSON object will be returned, detailing the system’s health status. The status field will indicate whether the setup is functioning correctly ("ok") or if issues exist ("not ok").

Example Response

{
  "entitlements": {
    "entitled_for_catalog": true,
    "has_central_token": true,
    "token_expired": false,
    "token_expiration": "2025-08-26T17:13:48Z"
  },
  "central": {
    "central_connection_working": true,
    "pinged_central": "node-id"
  },
  "db_connection_working": true,
  "status": "ok"
}

If the response indicates any issues, review the installation steps and configuration to resolve them before proceeding.

Related Topics

• Catalog Installation
• Catalog Helm and OpenShift Installation
• PostgreSQL for JFrog Catalog
• Upgrading JFrog Catalog
• Product Dependencies Matrix