Change the Base URL in Federated Repositories

JFrog Artifactory Documentation

Products
JFrog Artifactory
Content Type
User Guide

Administrators can change the base URL in an active Federated repository with remote members. 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 version 7.55.1 or above.

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

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.

Possible Use Cases

When changing the base URL in Federated repositories, there are two possible use 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.

Note

The custom Base URL is blocked for SaaS and enabled for Self Hosted

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

  2. Enter a new custom base URL.

  3. Click Save.

    image__1_.png
  4. The next steps to be performed are dependent on the type of Federation service installed on the members:

    Federation service in use on source & target

    Steps to perform

    Legacy to Legacy

    1. Generate a new pairing token and pair the target JPD to the source JPD.

    2. Pair the target JPD to the source JPD.

    3. Replace the Base URL/Federated Base URL on the target.

    For more information about these steps, see Generate New Tokens for Federation Members.

    Legacy to RTFS

    1. Generate a new pairing token and pair the target JPD to the source JPD.

    2. Pair the target JPD to the source JPD.

    3. Replace the Base URL/Federated Base URL on the target.

    For more information about these steps, see Generate New Tokens for Federation Members.

    RTFS to Legacy

    1. Generate a new pairing token and pair the target JPD to the source JPD.

    2. Pair the target JPD to the source JPD.

    For more information about these steps, see Generate New Tokens for Federation Members.

    RTFS to RTFS

    A new pairing token is not required. Continue below.

  5. Verify the functionality of the Federation, as described in After Changing the Base URL.

Tip

You can also change the custom base URL using the Update Custom URL Base REST API.Update Custom URL Base