Before You Begin

Review Distribution prerequisites: supported platforms, hardware requirements, Artifactory, PostgreSQL, and Redis.

System Requirements

Before beginning installation, verify that the following system requirements are in place.

  • A fully-configured Artifactory instance. For more information on installing Artifactory, see Installing Artifactory.

  • The Artifactory host machine must have enough space to handle the temp cache directory of Nexus Migrator if the Nexus Repository uses the S3 blob store. You can get the minimum required space for temp cache directory with the following formula:

    The Artifactory instance must have additional memory equivalent to this value over the memory in the Nexus Repository instance. For example, if the largest file in the repository is 300 MB and the number of threads in the Artifactory machine is 4, the minimum space requirement for temp cache directory is 1200 MB.

  • Script execution is enabled in Nexus Repository Manager. For more information, refer to Nexus Repository Manager Documentation. A warning appears in Nexus Repository Manager after you enable script execution. You must run the migration tool from the Nexus Repository Manager host machine.

  • Ensure that the following directories exist in the Nexus Repository Manager host machine:

    • $datadir/etc and $datadir/blob for Nexus 3.
    • $datadir/conf and $datadir/storage for Nexus 2.
  • The user who runs the migration must have root privileges.

  • This is optional. For Nexus 3, if you are running the tool from an external machine, execute the following command:

    export SKIP_MIGRATION_FILESYSTEM_CHECK=true

    To configure, set the URL to:

    http://<private ip>:<port>

    If a context path is configured for the Nexus server, use:

    http:<private ip>:<port>/<context-path>
📘

Note

Nexus 2 does not support this feature as the tool relies completely on filesystem data.

Prerequisites

  • Install Docker (version 20 or later) in the machine that hosts Nexus Repository Manager.
  • The user in the Artifactory machine and the Nexus Repository Manager machine must have administrator privileges.

Working with Artifactory on self-signed SSL certificates

If your Artifactory is set up with self-signed SSL certificates, create the following directory and copy the certificates into it.

mkdir -p <working directory>/migration/security/certs

Database and Third-Party Applications in Distribution

Distribution supports the following versions of PostgreSQL:

  • 17.x
  • 16.x
  • 15.x

Distribution HA requires an external database. Any configuration changes require a Distribution node restart to take effect across the entire cluster.

📘

Distribution 2.37.0 and later:

Redis has been removed from the Distribution installer and replaced by an internal in-memory system. For more details, see the Distribution 2.37.0 release notes.

Distribution requires Redis and supports Redis 7.x. A supported Redis version is bundled with the Distribution installer.

⚠️

Redis Password Restrictions

Redis password should contain only alphanumeric characters and should not contain any special characters.

Distribution Network Ports

Distribution uses the 8082 port by default for external communication.

Distribution uses the following internal ports by default for communication with JFrog Platform microservices.


MicroservicePort
Distribution Server8080
Router

HTTP: 8082, 8046, 8049

gRPC: 8047

Redis6379 (not required from Distribution 2.37.0 onwards)
PostgreSQL (if you use the bundled Postgres database)5432
Observability

HTTP: 8036

gRPC: 8037


Did this page help you?