Advanced Settings

JFrog Artifactory Documentation

ft:sourceType
Paligo
Overview

The advanced settings for a remote repository configure network access behavior, cache management, and several other parameters related to remote repository access.

To access the advanced settings, select the Advanced tab when editing an existing Remote Repository or creating a new one.

Remote Credentials

You can configure authentication for remote repositories by specifying remote credentials. You can use either one of the following methods to identify yourself:

  • Username and password

  • Personal Access Token (PAT)

The advantage of using PATs is that you can strengthen your Artifactory security practices by using them for authentication, instead of using your primary credentials. For example, you can create a PAT in GitHub and then configure your remote Docker repository to point to GitHub and authenticate it by using the PAT. You can use PATs for any package type.

To specify remote credentials:

  1. In the Administration module, go to Remote Repository | Advanced.

  2. Under Remote Authentication, enter your remote credentials in the following screen:

    Remote_authentication.png
  3. Use one of the following methods to identify yourself:

    1. Username and password:

      1. Under Remote Authentication, enter a username in the Username field.

      2. Enter a password in the Password/Access Token field.

    2. Personal Access Tokens (PAT) (From Artifactory 6.18 and later)

      1. Create the PAT in the service provider and copy the PAT to the clipboard.

      2. Under Remote Authentication, paste the PAT into the Password/Access Token field

      3. Enter a username in the Username field.

  4. Click Save & Finish.

Field

Description

Username

The username that should be used for HTTP authentication when accessing this remote proxy. When a PAT is used for authentication, an arbitrary username can be entered into this field, but the field must not be left empty.

Password/Access Token

The password or personal access token (PAT) that should be used for HTTP authentication when accessing this remote proxy.

SSL/TLS Certificate

The SSL/TLS certificate in this repository should be used for authentication to the remote resource for which it is a proxy.

Network Settings
no-proxy1.png

Field

Description

Proxy

If your organization requires you to go through a proxy to access a remote repository, this parameter lets you select the corresponding Proxy Key. For more details on setting up proxies in Artifactory please refer to Managing Proxies.Managing Proxies

No Proxy

To prevent auto-updates during the edit of system proxies, a flag was added in release 7.41.7 called No Proxy (in the UI) or disableProxy (in the REST API).

The flag is set to false by default - since it turns off the use of a proxy for this repository and prevents proxy updating during system proxy changes.

Disabling the Proxy

With the release of 7.41.7, the functionality to disable a remote proxy requires you to set this action in the UI (or API) to ensure that no proxy is used.

Local Address

When working on multi-homed systems, this parameter lets you specify which specific interface (IP address) should be used to access the remote repository.

This can be used to ensure that access to the remote repository is not blocked by firewalls or other organizational security systems.

Socket Timeout

The time (in ms) that Artifactory waits (for both a socket and a connection) before giving up on an attempt to retrieve an artifact from a remote repository.

Upon reaching the specified Socket Timeout Artifactory registers the repository as "assumed offline" for the period of time specified in Assumed Offline Period.

Query Params

A custom set of parameters that should automatically be included in all HTTP requests to this remote repository.

For example, param1=value1&param2=value2&param3=value3

Lenient Host Authentication

When set, allows using the repository credentials on any host to which the original request is redirected.

Cookie Management

When set, the repository will allow cookie management to work with servers that require them.

Using Oracle Maven Repository

To use Oracle Maven Repository:

  • Set your Oracle credentials in Username and Password of the Remote Credentials

  • Set Lenient Host Authentication

  • Set Enable Cookie Management.

Cache Settings

Artifactory stores artifacts retrieved from a remote repository in a local cache. The Cache Settings specify how to manage cached artifacts.

Caching Maven artifacts

Caching for Maven artifacts is only applicable to snapshots since it is assumed that releases never change.

cache-remote-settings.png

Field

Description

Unused Artifacts Cleanup Period

Many cached artifacts in Artifactory remote repository storage are actually unused by any current projects in the organization. This parameter specifies how long an unused artifact will be stored before it is removed. Once reaching this period Artifacts will be removed in the next invocation of cleanup. For more details please refer to Cleanup Unused Cached Artifacts in Regular Maintenance OperationsRegular Maintenance Operations

Leaving the field empty (default) means that the artifact is stored indefinitely.

Metadata Retrieval Cache Period

Defines how long before Artifactory checks for a newer version of a requested artifact in a remote repository.

A value of 0 means that Artifactory will always check for a newer version.

On which file types does this parameter work?

This setting refers to artifacts that expire after a period of time (e.g. metadata files such as maven-metadata.xml, npm package.json or Docker manifest.json etc.).

Note that most artifacts that are downloadeddo not change (e.g. release versions), therefore this setting has no effect on them.

Metadata Retrieval Cache Timeout

Allows you to control the Metadata timeout performance. If the timeout is reached, the previous metadata is returned to the client, as a lock was not applied due to new metadata, leaving the previous request hanging. The default value is 60 seconds.

Assumed Offline Period

In case of a connection error, this parameter specifies how long (in seconds) Artifactory should wait before attempting an online check in order to reset the offline status.

A value of 0 means that the repository is never assumed offline and Artifactory will always attempt to make the connection when demanded.

Missed Retrieval Cache Period

If a remote repository is missing a requested artifact, Artifactory will return a "404 Not found" error. This response is cached for the period of time specified by this parameter. During that time, Artifactory will not issue new requests for the same artifact.

A value of 0 means that the response is not cached and Artifactory will always issue a new request when demanded.

Zapping Caches

"Zapping" a cache means forcing the Retrieval Cache Period and Missed Retrieval Cache Period to time out. To "zap" a cache, you can use the Zap Cache REST API, or the WebUI. To use the WebUI, in the Artifacts module Tree browser,Zap Cache

Select the repository cache you wish to "zap" and click Zap caches in the right-click menu or Actions drop-down menu.

ZapCache.jpg
Select Property Sets

Defines the property sets that will be available for artifacts stored in this repository.

Other Settings
remote_advanced_tab.png

Field

Description

Priority Resolution

Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with this field. If a package is not found in those repositories, Artifactory will merge metadata from the repositories that have not been set with the Priority Resolution field.

Applies to all repository types excluding Chef, CocoaPods, Debian, Git LFS, Opkg, Rust, Vagrant, and VCS repositories.

For more information on packages support for this feature, see the Artifactory Release Notes.Artifactory Release Information

Blacked out

If set, Artifactory ignores this repository when trying to resolve artifacts. The repository is also not available for download or deployment of artifacts.

Allow content browsing

When set, allows Artifactory users to browse the internal contents of archives (for example, browsing specific Javadoc files from within a Javadoc archive).

Warning

When Allow Content Browsing is enabled, this functionality restricts access to authenticated users only and is not supported for trial users. This limitation applies to prevent malicious users from uploading content that may compromise security.

Store artifacts locally

When set, Artifactory artifacts from this repository will be cached locally. If not set, direct repository-to-client streaming is used.

When might you use direct repository-to-client streaming?

If your organization has multiple servers connected over a high-speed LAN, you may have one instance of Artifactory caching data on a central storage facility with additional instances of Artifactory running on other servers. In this case, it makes sense for the additional instances of Artifactory to act as satellite pass-through servers rather than have them duplicate the cached data within their own environments.

Synchronize properties

When set, synchronizes properties of artifacts retrieved from a remote instance of Artifactory.

Bypass HEAD Requests

When set, Artifactory will not send a HEAD request to the remote resource before downloading an artifact for caching

Block Mismatching Mime Types

When set, artifacts will fail to download if a mismatch is detected between the requested and received mime type, according to a list specified in the system.properties file under blockedMismatchingMimeTypes. You can override this setting by adding mime types to the override list below.

Override Default Blocked Mime Types

The set of mime types that should override the Block Mismatching Mime Types setting.

Propagate Query Params

When set, if query params are included in the request to Artifactory, they will be passed on to the remote repository.

Generic Repositories Only

This setting is only available for Generic type repositories.

Enable CDN Download

Enables CDN Download requests to this repository will redirect the client to download the files directly from AWS CloudFront. Supported for Enterprise+ and Enterprise Licenses. For more information, see JFrog Cloud with CDN Distribution.JFrog Cloud with CDN Distribution