Change Base URL in Federated Repositories

Administrators can change the base URL or Federated 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.

Who can perform this task: Platform Administrators

Prerequisites:

• All Federation members are running Artifactory 7.55.1 or later

This topic covers the following tasks:

• Change the Base URL
• Change the Federated Base URL
• Generate New Tokens for Federation Members
• After Changing the Base URL

Decide Which URL to Change

The steps required depend on whether the Federation uses the standard 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 the Base URL

Change the standard base URL used by your JFrog Platform instance.

To change the base URL:

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

2. Enter a new custom base URL.

3. Click Save.

   

4. The next steps depend on the Federation service in use:

5. Verify the functionality of the Federation (see After changing the base URL).

Change the Federated Base URL

If the Federation uses a Federated base URL, make changes directly using the Config Descriptor.

To change the Federated base URL:

1. In the Administration module, click Artifactory Settings > Config Descriptor.

2. Search the configuration file for a Federation base URL entry.

   

3. Make the required changes to the Federation base URL and save your changes.

Generate New Tokens for Federation Members

After changing the base URL or Federated base URL, generate a new pairing token and pair the source and target JPDs.

To generate new tokens:

1. Generate a new token from the source JPD using the Create Pairing Token Platform REST API.
2. Pair the target JPD to the source JPD using the new token with the Initiate Pairing Platform REST API.
3. Replace the base URL (or Federated base URL) by executing the following POST request against the target JPD: api/federation/replaceUrl with the following body:

{
    "oldBaseUrl": "http:/<OLD_BASE_URL>/artifactory",
    "newBaseUrl": "http://<NEW_BASE_URL>/artifactory"
}

Where:

• <OLD_BASE_URL>: The current base URL of the target JPD
• <NEW_BASE_URL>: The new base URL to apply to the target JPD

For example:

{
    "oldBaseUrl": "http://old-jpd.example.com/artifactory",
    "newBaseUrl": "http://new-jpd.example.com/artifactory"
}

After Changing the Base URL

Test the functionality of the Federation after changing the base URL or Federated base URL.

To verify the Federation after changing the base URL:

1. In the Administration module, click Platform Monitoring > Federation Status. If you see that the Federation is no longer in sync, there is a problem with the new configuration. This view is also available as the Federation Dashboard.
2. (Optional) After verifying that all Federation members have synchronized successfully with the updated base URL, revoke the obsolete key for each remote JPD using the Revoke Token by ID REST API.

Frequently Asked Questions

This section provides answers to frequently asked questions.

Related Topics

• Prerequisites
• Geo-Synchronized Topology
• Create a Federated Repository
• Federation Dashboard
• Troubleshooting Guide