Basic Settings for Remote Repositories

JFrog Artifactory Documentation

ft:sourceType
Paligo
Remote-repo_Basic-tab.png

The following basic settings are common for all package types.

Setting

Description

Package Type

The package type must be specified when the repository is created, and once set, cannot be changed.

Repository Key

The repository key is a mandatory, unique identifier for the repository. It cannot begin with a number or contain spaces or special characters.

Environments

Defines the environment in which this repository will reside. Environments aggregate project resources (repositories, Pipeline sources, etc.) to simplify their management. For more information, see Environments.Environments

URL

The URL for the remote repository. Currently, only HTTP and HTTPS URLs are supported.

User Name

The user name for accessing the URL of the remote repository. Leave this field blank to access the repository anonymously.

Password/Access Token

The password or access token used to access the repository.

SSL/TLS Certificate

The certificate used for authentication. Click Test to verify the certificate is valid.

Repository Layout

Defines the layout used by the remote repository cache for storing and identifying modules. For more information, see Remote Repository Configuration.

Remote Layout Mapping

Defines the layout used by the remote repository for storing and identifying modules. This layout can differ than the layout defined under Repository Layout for the remote repository cache. For more information, see Remote Repository Configuration.

Public Description

A free text field that describes the content and purpose of the repository. This description can be viewed by all users with access to the repository.

Internal Description

A free text field to add additional notes about the repository. These notes are visible only to the administrator.

Include and Exclude Patterns

The Include Patterns and Exclude Patterns fields provide a way to filter out specific repositories when resolving the location of different artifacts.

In each field, you can specify a list of Ant-like patterns to filter in and filter out artifact queries. Filtering works by subtracting the excluded patterns (default is none) from the included patterns (default is all).

Example:

Consider that the Include Patterns and Exclude Patterns for a repository are as follows:

Include Patterns: org/apache/**,com/acme/**

Exclude Patterns:

com/acme/exp-project/**

In this example, the repository is searched for org/apache/maven/parent/1/1.pom and com/acme/project-x/core/1.0/nit-1.0.jar but not for com/acme/exp-project/core/1.1/san-1.1.jar because com/acme/exp-project/** is specified as an Exclude pattern.

Offline

If set, this repository will be considered offline and no attempts will be made to fetch artifacts from it.

Enable Indexing in Xray

Enables indexing on the repository for security and compliance analysis. Available with JFrog Xray.JFrog Xray

Repositories may have additional basic settings depending on the package type, as described in the section that follows.

Basic Settings for Maven, Gradle, Ivy, and SBT Repositories

Remote-repos_Maven-settings.png

Field

Description

Checksum Policy

Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum.

There are four options:

  • Generate if absent (default): The system attempts to retrieve the remote checksum, If it is not found, the system will automatically generate one and fetch the artifact.

    If the remote checksum does not match the locally calculated checksum, the artifact will not be cached and the download will fail.

  • Fail: If the remote checksum does not match the locally calculated checksum, or is not found, the artifact will not be cached and the download will fail.

  • Ignore and generate: The system ignores the remote checksum and only uses the locally generated one. As a result, remote artifact retrieval never fails, however integrity of the retrieved artifact may be compromised.

  • Ignore and Pass-thru: The system stores and passes through all remote checksums (even if they do not match the locally generated one). If a remote checksum is not found, Artifactory generates one locally. As a result, remote resource retrieval never fails, however integrity of the retrieved artifact may be compromised, and client side checksum validation (as performed by Maven, for example) will fail.

Max Unique Snapshots

Specifies the maximum number of unique snapshots of the same artifact that should be stored. Once this number is reached and a new snapshot is uploaded, the oldest stored snapshot is removed automatically.

A value of 0 (default) indicates that there is no limit on the number of unique snapshots.

Eagerly Fetch Jars

When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.

Suppress POM Consistency Checks

By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error.

You can disable this behavior by setting the Suppress POM Consistency checkbox.

Eagerly Fetch Sources

When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate the initial access time to the source jar when it is subsequently requested.

Handle Releases

If set, Artifactory enables you to deploy or cache release artifacts into this repository.

Handle Snapshots

If set, Artifactory enables you to deploy or cache snapshot artifacts into this repository.