---
updatedAt: 2026-05-21T09:14:56.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/installation/llms.txt
---

# 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 <a href="https://releases.jfrog.io/ui/repos/tree/General/run/jfrog-diagnostics-util/0.1.1" target="_blank">here</a>.

After downloading, rename the binary with:

```bash
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.

```bash
./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:

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

#### System Check Options

The following table provides information about the system check options:

| Options              | Description                                                                                    | Default          |
| :------------------- | :--------------------------------------------------------------------------------------------- | :--------------- |
| `--installDirectory` | Specifies the directory where the product is installed.                                        | `/var/opt/jfrog` |
| `--product`          | Specifies 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:

```bash
./diagnosticUtil inspect connectivity --product=xray
```

#### Connectivity Check Options

The following table provides information about the network connectivity options:

| Options         | Description                                                                                    | Default             |
| :-------------- | :--------------------------------------------------------------------------------------------- | :------------------ |
| `--product`     | Specifies the product (`artifactory`\|`xray`\|`distribution`) whose prerequisites are checked. | `artifactory`       |
| `--downloadDns` | Specifies 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:

```bash
./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:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Options
      </th>

      <th>
        Description
      </th>

      <th>
        Default
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `--databaseUsername`
      </td>

      <td>
        Specifies the database username.
      </td>

      <td>
        Required
      </td>
    </tr>

    <tr>
      <td>
        `--databasePassword`
      </td>

      <td>
        Specifies the database password.
      </td>

      <td>
        Required
      </td>
    </tr>

    <tr>
      <td>
        `--databaseUrl`
      </td>

      <td>
        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`.
      </td>

      <td>
        Required
      </td>
    </tr>

    <tr>
      <td>
        `--databaseType`
      </td>

      <td>
        Specifies the database type.

        * postgresql
        * oracle
        * mysql
        * mssql
        * mariadb
      </td>

      <td>
        `postgresql`
      </td>
    </tr>
  </tbody>
</Table>

### 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:

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

## Related Topics

* [General System Requirements](general-system-requirements)
* [System Requirements](system-requirements)
* [Network Requirements for JFrog Products](network-requirements-for-jfrog-products)
* [Database Support Matrix](database-support-matrix)
* [Hardware Sizing Matrix](hardware-sizing-matrix)

## Frequently Asked Questions

This section provides answers to frequently asked questions.

<Accordion title="FAQs" icon="plus">

##### 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](https://releases.jfrog.io/ui/repos/tree/General/run/jfrog-diagnostics-util/0.1.1). After downloading, rename the platform-specific binary to `diagnosticUtil` before running it.

</Accordion>