Change the Base URL in Federated Repositories

JFrog Artifactory Documentation

Products
JFrog Artifactory
Content Type
User Guide
ft:sourceType
Paligo

Administrators can change the base URL shared by the members of an active Federated repository. Changing the base URL might be necessary, for example, if the network topology has changed.

Important

This feature is available only when all Federation members are using Artifactory 7.55.1 or later.

The steps required to complete the change are dependent on whether the Federation uses the base URL or a special Federated base URL.

If a Federated base URL has been defined, the JPD publishes this address to all Federation members, who then use this address to access the Federated repository on the JPD instead of the standard base URL.

change-base-URL_diagrams_with-FedBaseURL.png
change-base-URL_diagrams_without-FedBaseURL.png

Warning

It is important to follow the instructions described in this topic, in particular, the procedure to generate new tokens when required. The Federation will not function properly without valid tokens.

Tip

Use the Config Descriptor to determine whether a Federated base URL has been defined. For more information, see Locate the Federated Base URL.Locate the Federated Base URL

Possible Use Cases

When changing the base URL for Federated repositories, there are several possible use cases:

change-base-url_workflow_draft.png

In all cases, it is highly recommended to test the functionality of the Federation after changing either the base URL or the Federated base URL, as described in After Changing the Base URL.

Change the Base URL

Administrators can change the base URL directly from the JFrog platform UI, as described below.

To change the base URL:

  1. In the Administration module, select General > Settings.

  2. Enter a new custom base URL.

  3. Click Save.

    custom-base-URL.png
  4. Do one of the following:

Note

It is also possible to change the custom base URL using the Update Custom URL Base REST API.Update Custom URL Base

Important

As a fallback, it is possible to change the base URL more aggressively by canceling the Federation, changing the base URL, and then recreating the Federation. Please note this has a huge impact on the system since it requires recreating each Federated repository from scratch.