Sonatype Nexus Repository System Requirements
This topic covers system requirements for the Sonatype Nexus Repository.
Supported Nexus Repository Versions
Sonatype's product development lifecycle is explained in Sonatype Sunsetting Information.
The supported versions are listed on the version status page.
Supported Operating Systems
Sonatype Nexus Repository supports the
Linux
,Windows
, andMacOS
operating systems. Sonatype has not tested nor supported other operating systems.Use a Dedicated User Account
We recommend using a dedicated operating system user account to run each unique process on a given host. The Nexus Repository process user must be able to create a valid shell.
Do not run Nexus Repository as the
root
user.Required File Handle Limits
Nexus Repository consumes more file handles than the default value allowed by Linux or MacOS operating systems. Some container platforms (e.g., Amazon ECS) override the default limits set on the container. Running out of file descriptors leads to data loss. Increase the limit on the number of open file descriptors for the user running Nexus Repository.
See the topic, Adjusting the File Handle Limits for instructions on how to do this in your environment.
Supported Web Browsers
Our policy is to support the most recent modern browser version of your supported OS at the time of the Nexus Repository version release date.
Supported Java Versions
Sonatype Nexus Repository is tested on and supports OpenJDK.
As of release 3.71.0, Nexus Repository requires Java 17.
Nexus Repository is compatible with both Intel and AMD CPU architectures.
For historic Java support information, see our Java Compatibility Matrix.
For information on obtaining a suitable JRE, see Obtaining and Verifying Suitable JRE.
CPU
Performance is primarily bounded by IO (disk and network) rather than CPU. Available CPUs will impact longer-running operations and thread count. See the thread allocation algorithms of the web container.
See the Memory Recommendations by Profile Size section for CPU recommendation by deployment.
Memory Requirements
At a high level, expect to allocate up to two-thirds of available RAM to Nexus Repository; leaving one-third of RAM available for system processes and buffers.
Memory requirements vary by profile size. There is not a single defined requirement due to the complexity of all possible use cases. The section below outlines the memory and CPU recommendations for each node in small, medium, large, and very large profiles.
Highly available deployments must meet these requirements for all nodes in the cluster.
See our Nexus Repository Memory Overview topic for details about the different types of memory that Nexus Repository uses and examples of memory-related Java requirements.
Nexus Repository Recommendation by Profile Size
Profile Size | Profile Description | CPUs | RAM | Local Blob Storage |
---|---|---|---|---|
20,000 requests/hour 200,000 requests/day embedded H2 database | 2 | 8GB | 20GB | |
100,000 requests/hour 1,000,000 requests/day external PostgreSQL database | 2 | 8GB | 200GB | |
1,000,000 requests/hour 10,000,000 requests/day external PostgreSQL database High Availability deployment | 4 per node | 16GB per node | 200GB or more | |
2,000,000 requests/hour 20,000,000 requests/day external PostgreSQL database High Availability deployment | 8 per node | 32GB per node | 10TB or more |
Database Requirements
Sonatype Nexus Repository supports two database options: an embedded H2 database or an external PostgreSQL database.
Important
Sonatype Nexus Repository's legacy embedded OrientDB database entered extended maintenance in August 2024.
Nexus Repository customers must migrate from OrientDB to a supported database.
You will need to remain on the 3.70.x version if you are unable to migrate from OrientDB. Versions 3.71.0 and above do not support OrientDB.
PostgreSQL Recommendation by Profile Size
Profile Size | Profile Description | CPUs | RAM | Disk Size |
---|---|---|---|---|
20,000 requests/hour 200,000 requests/day External PostgreSQL database | 2 | 8GB | 200GB+ | |
100,000 requests/hour 1,000,000 requests/day 2-node PostgreSQL cluster | 4 per node | 32GB | 500GB+ | |
1,000,000 requests/hour 10,000,000 requests/day 2-node PostgreSQL cluster | 16 per node | 128GB | 1TB+ | |
2,000,000 requests/hour 20,000,000 requests/day 2-node PostgreSQL cluster | 32 per node | 256GB | 1.5TB+ |
H2 Requirements
New installations use an H2 database by default.
Nexus Repository supports 20,000 requests per day / 100,000 components in H2 deployments. Workloads beyond these limitations are not supported. Container-based deployments are not supported in H2 deployments.
PostgreSQL Requirements (Recommended)
We recommend all deployments use an external PostgreSQL database. For best performance, Nexus Repository should have a low-latency connection to the database. When using a cloud database, the Nexus Repository node must be in the same region.
Version 14+ of PostgreSQL is recommended.
Nexus Repository requires PostgreSQL version 11.9 or later, while high-availability deployments require PostgreSQL version 13 or later.
Details are in Database Options.
Compatible PostgreSQL Providers
Nexus Repository is compatible with the following PostgreSQL providers:
Amazon RDS instance
Amazon Aurora PostgreSQL
Azure PostgreSQL Flexible Server
Google Cloud SQL for PostgreSQL
An instance of PostgreSQL that you provide
PostgreSQL Database Duplicate Key Value Error
After upgrading the PostgreSQL host operating system you may see exceptions with a specific message reporting duplicate key value violations.
Refer to the support article "PostgreSQL Index Corruption - duplicate key violation errors" for details on remediating the issue.
Required PostgreSQL Database User Permissions
The Nexus Repository database user requires CREATE and USAGE permission on the specified schema.
The specified schema must also be on the search_path
for that user.
Nexus Repository will then create and manage its tables, making it the owner of those objects; so, you do not need to specify any extra permissions.
Required Trigram Module for PostgreSQL Database
Nexus Repository 3 instances using PostgreSQL databases must have the pg_trgm (trigram) module. This module may not be installed with PostgreSQL by default on all Linux distributions, which will result in an exception when attempting to upgrade.
See Installing the Trigram Module for installation instructions.
Advanced Database Memory Tuning
See Advanced Database Memory Tuning for examples of advanced database memory tuning based on different profile sizes.
Disk Space Requirements
Required disk space for Nexus Repository varies by deployment size and complexity. You must have at least 4GB available disk space at all times; if available disk space drops below 4GB, the database will switch to read-only mode.
Sonatype Nexus Repository requires disk space for two primary directories:
Application Directory - Size varies slightly per release; as of August 2024, it is around 390MB. It is normal to have multiple application directories installed on the same host over time as you upgrade.
Data Directory - Size varies based on complexity and formats. Plan for substantial disk space. Note that formats like Docker and Maven can use very large amounts of storage (500GB easily).
File Systems
Nexus Repository has two primary storage requirements:
Embedded data: requires very responsive, fast storage, ideally local disk
Blob storage: requires moderately responsive, high-capacity storage
File System | Embedded data | Blob Stores |
---|---|---|
Local storageA good choice for both embedded data and binary storage. | Supported | Supported |
NFS v4A common protocol for network-attached storage among Nexus Repository deployments. Use NFSv4.1 or higher for the work directory in small deployments. It's not sufficient for anything larger. | Not Recommended | Supported |
Amazon EBSEBS is a viable choice for both embedded data and binary storage. | Supported | Supported |
Amazon EFSEFS isn't sufficiently responsive for embedded data but is appropriate for binary storage. EFS binary storage may not provide the necessary throughput for heavy workloads in all configurations. | Unsupported | Supported |
Amazon S3S3 semantics aren't suitable for embedded data, but S3 is popular for binary storage. | Unsupported | Supported |
SMB, CIFSProblems are common with SMB or CIFS-mounted devices for embedded data. | Unsupported | Supported |
Azure Blob StorageAvailable for blob storage from Nexus 3.30.0 Pro. We support the premium performance block blob option. | Unsupported | Supported |
Azure FilesIssues with file handles have been observed when accessing embedded data over SMB. | Unsupported | Supported |
S3-CompatibleFully compatible S3 implementation that supports the AWS SDK version 1.12.658 can be used as a blob store. Note that performance characteristics may differ from AWS S3; we recommend working with your vendor to ensure sufficient performance for your desired workload. | Unsupported | Supported |
Google Cloud StorageAvailable for blob storage from Nexus 3.74.0 Pro. | Unsupported | Supported |
Google Cloud FilestoreAvailable for embedded data from Pro Version 3.74.0 | Supported | Unsupported |
NFS v3Numerous customers have experienced inadequate performance with NFS v3. | Unsupported | |
GlusterFSSplit-brain problems and slow performance are common. | Unsupported | |
FUSEFUSE-based user-space filesystems are known to be unreliable for Nexus Repository. | Unsupported |
File System Optimization
We have optimization suggestions to use at your discretion.
Consider the noatime
option for your work directory mounts and limit the symbolic links as they increase the overhead when paths need to be resolved to an absolute file path.