Try JFrog
Guides
Contact SupportTry JFrog
  1. Prerequisites
  2. System Requirements
  3. General System Requirements

Preflight Check

Run diagnosticUtil inspect (system|connectivity|database|all) to validate your environment before installation.

The diagnosticUtil utility checks whether your VM or bare metal server meets the minimum requirements before installing JFrog products. Its inspect command performs pre-installation and environment checks, confirming your system meets the requirements for running JFrog products.

You can download the diagnosticUtil Utility from here.

After downloading, rename the binary with:

mv diagnostics-<os>-<arch> diagnosticUtil

inspect Command

The inspect command lets you individually verify System, Connectivity, or Database configurations, or run All checks in a single execution. This utility helps identify potential issues before they affect your Artifactory deployment.

./diagnosticUtil inspect <subcommand> <options>

The following are the subcommands:

  • system: Performs system-level environment checks.
  • connectivity: Verifies the required network connectivity and port availability.
  • database: Validates the database connectivity.
  • all: Runs all the above checks in a single command.

System

The system sub-command checks the following:

  • CPU, memory, and storage requirements of the selected product.
  • Operating system's and Linux distribution's compatibility.
  • Access to the custom install directory.
  • Fetch disk IOPS information.

For example, to run a system check, run the following command:

./diagnosticUtil inspect system --installType=vm --product=artifactory

System Check Options

The following table provides information about the system check options:

OptionsDescriptionDefault
--installDirectorySpecifies the directory where the product is installed./var/opt/jfrog
--productSpecifies the product (artifactory|xray|distribution) whose prerequisites are checked.artifactory

Connectivity

The connectivity sub-command checks the following:

  • Availability of required ports for the selected product.
  • Network connectivity to external URLs needed by JFrog products.

For example, to run a network connectivity check, run the following command:

./diagnosticUtil inspect connectivity --product=xray

Connectivity Check Options

The following table provides information about the network connectivity options:

OptionsDescriptionDefault
--productSpecifies the product (artifactory|xray|distribution) whose prerequisites are checked.artifactory
--downloadDnsSpecifies the DNS endpoint used for downloading product binaries.releases.jfrog.io

Database

The database sub-command checks the connectivity to the database using the provided credentials.

For example, to run a database connectivity check, run the following command:

./diagnosticUtil inspect database --databaseUsername=dbuser --databasePassword=dbpass --databaseUrl=”jdbc:postgresql://localhost:5432/mydb”

Database Check Options

The following table provides information about the database connectivity options:

Options

Description

Default

--databaseUsername

Specifies the database username.

Required

--databasePassword

Specifies the database password.

Required

--databaseUrl

Specifies the JDBC-style database URL used for database connectivity checks.

Note: Only basic JDBC URL formats are supported. URLs containing additional parameters, options, or complex structures are not supported.

For example, jdbc:postgresql://myhost:5432/artifactory.

Required

--databaseType

Specifies the database type.

  • postgresql
  • oracle
  • mysql
  • mssql
  • mariadb

postgresql

All

The all sub-command executes all of the above checks (system, connectivity, and database) in a single command.

For example, to run all checks in a single command:

./diagnosticUtil inspect all --installDirectory=”/tmp/opt/jfrog” --product=artifactory --databaseUsername=admin --databasePassword=pass --databaseUrl=”jdbc:postgresql://localhost:5432/artdb”

Related Topics

Frequently Asked Questions

This section provides answers to frequently asked questions.

FAQs
Q: What does the diagnosticUtil utility check?

A: The diagnosticUtil inspect command validates that your VM or bare metal server meets minimum requirements before installation. It checks CPU, memory, storage, OS compatibility, port availability, network connectivity to external URLs, and database connectivity, depending on the subcommand used.

Q: Which products can be checked with the --product option?

A: The --product option accepts artifactory, xray, or distribution. The default value is artifactory if the option is not specified.

Q: What is the default install directory used by the system check?

A: The default value for --installDirectory is /var/opt/jfrog. You can override this with a custom path if your product is installed in a different location.

Q: Does the database check support complex JDBC URLs with additional parameters?

A: No. The --databaseUrl option only supports basic JDBC URL formats. URLs containing additional parameters, options, or complex structures are not supported.

Q: Where can I download the diagnosticUtil binary?

A: The diagnosticUtil utility is available for download from releases.jfrog.io. After downloading, rename the platform-specific binary to diagnosticUtil before running it.