Copy Artifactory configuration with jf rt transfer-config

Copy full Artifactory configuration from a source Artifactory server to a target Artifactory server.

Synopsis

jf rt transfer-config <source-server-id> <target-server-id> [options]

Aliases: —

Arguments

The following table lists the arguments for jf rt transfer-config.

Options

The following table lists the flags supported by jf rt transfer-config.

When to Use

Use transfer-config when migrating an entire Artifactory instance to a new server — for example, moving from self-hosted to JFrog SaaS, or upgrading to new infrastructure. This copies all repositories, users, groups, permissions, and other configuration.

The following table helps you choose transfer-config versus related commands.

Prerequisites

Before you run transfer-config:

1. Install the data-transfer plugin on the source server:

   Bash

   jf rt transfer-plugin-install <source-server>

   Note: If your JFrog home directory is not at the default /opt/jfrog, specify the path with --home-dir <path>. Use --version to pin a specific plugin version instead of latest.

2. Configure both source and target servers with jf config add.

3. Use admin access tokens (or equivalent credentials) for both servers.

4. Ensure the target server is empty unless you intend to use --force.

Examples

Verify Command Help

To view command help:

• Run:

jf rt transfer-config --help

Transfer Full Configuration

To transfer full configuration between servers:

• Run:

jf rt transfer-config <source-server-id> <target-server-id> --force

Where:

• <source-server-id> and <target-server-id> — CLI server IDs (see Arguments).

Full example:

jf rt transfer-config source-server target-server --force

On success, the CLI prints progress through five phases:

[Info] ========== Phase 1/5 - Preparations ==========
[Info] ========== Phase 2/5 - Export configuration from source ==========
[Info] ========== Phase 3/5 - Import configuration to target ==========
[Info] ========== Phase 4/5 - Copy files ==========
[Info] ========== Phase 5/5 - Cleanup ==========

Transfer Specific Repositories

To transfer configuration for specific repositories:

• Run:

jf rt transfer-config <source-server-id> <target-server-id> --include-repos "<repo-list>"

Full example:

jf rt transfer-config source-server target-server --include-repos "libs-release;libs-snapshot"

Run Pre-Transfer Checks

To run pre-transfer checks with verbose output:

• Run:

jf rt transfer-config <source-server-id> <target-server-id> --prechecks --verbose

Full example:

jf rt transfer-config source-server target-server --prechecks --verbose

Pre-check mode validates the source configuration without transferring any data and skips the interactive confirmation prompt. It may take significant time for large configurations (thousands of repositories).

Run Non-Interactively in CI/CD Pipelines

To run non-interactively (for example, in CI/CD pipelines):

• Pass --force (required when the target is non-empty) and pipe y into the command to answer the confirmation prompt. --force does not skip the prompt:

echo "y" | jf rt transfer-config <source-server-id> <target-server-id> --force

Full example:

echo "y" | jf rt transfer-config source-server target-server --force

Known Limitations

• The target server content is always wiped during transfer. --force is required when the target is non-empty. It does not prevent existing content from being overwritten, and it does not skip the interactive confirmation prompt (pipe y into the command for non-interactive use).
• Very large configurations (thousands of repositories) may take significant time for pre-checks
• Some configuration elements (for example, custom plugins, LDAP settings) may require manual migration
• The source server must be accessible from the machine running the CLI

Frequently Asked Questions

This section provides answers to frequently asked questions.

Related Topics

• Merge Artifactory Configuration with jf rt transfer-config-merge
• Transfer Artifact Files with jf rt transfer-files
• Transfer Files Between Artifactory Servers
• jf rt Output Format