Skip to main content

Installation Methods

Installing and Running with the Distribution Archive

The distribution archives combine the application and all required resources in an archive file. If you are testing Nexus Repository Manager on a local workstation the files may be extracted and run from anywhere, for production see the platform specific sections. Extracting the files will result in an application directory and a data directory, further details about the folder structure and their contents can be found in Directories.

Note

To uninstall the repository manager from an archive installation, remove the service configuration and delete the entire directory.

Unix

The downloaded GZip’d TAR archive can be extracted with the command tar xvzf. For production it is not recommend that nexus be run from a users home directory, a common practice is to use /opt.

Running Repository Manager in the Foreground

To start the repository manager from application directory in the bin folder on a Unix-like platform like Linux use:

./nexus run

Starting the repository manager with the run command will leave it running in the current shell and display the log output. The running application can be stopped using CTRL+C at the appropriate console.

The application can be accessed once the the log shows the message "Started Sonatype Nexus."

Running Repository Manager in the Background

The nexus script can be used to manage the repository manager as a background application on OSX and Unix with the start, stop, restart, force-reload and status commands.

To start repository manager and run it in the background:

./nexus start

While running in the background, all logging will go to then application log file.

To stop repository manager running in the background:

./nexus stop

Windows

The zip archive can be unpacked using the Windows compression utility or a third party utility such as 7zip. Nexus Repository Manager should not be installed in the Program Files directory to avoid problems with Windows file registry virtualization. If you plan to run the repository manager as a specific user you can install it into the AppData\Local directory of that users home directory. Otherwise simply use e.g., C:\nexus or something similar, ensuring that the user running the application has full access. The Nexus Repository Manager executable nexus.exe can be found inside the bin directory and can be run as an application using the following command:

nexus.exe /run

Starting the repository manager with the run command will leave it running in the current shell and display the log output. You can access the application once the the log shows the message "Started Sonatype Nexus". The running application can be stopped using CTRL+C at the appropriate console.

The nexus.exe executable can be used to manage the repository manager as a service with the /start, /stop, /restart, /force-reload and / status commands.

Installing with the Helm Chart

Note

A Helm Chart (GitHub, ArtifactHub) is available for our on-premises, AWS, and Azure resiliency and high availability deployment options. Be sure to read the deployment instructions in the associated README file before using the chart.

Sonatype provides a Helm Chart that can be used for our on-premises, AWS, and Azure resiliency and high availability deployment (HA) options only.

See Resiliency and High Availability for details about resilient and HA deployments

Installing with Docker

Docker automates the deployment of applications inside virtualized Linux containers. You can create a container that supports the installation of Nexus Repository Manager Pro and Nexus Repository Manager OSS. To install the repository manager with a Docker image, follow the steps at the Sonatype nexus3 Docker Hub image.

Installing using CloudFormation Templates on AWS

If you plan to deploy Nexus Repository Manager to AWS, we also make available CloudFormation templates.

Installing using the OpenShift Operator

An OpenShift operator is available for Sonatype Nexus Repository deployments using an external PostgreSQL database. The operator also supports deploying in high availability (active/active) mode. Full details are available in Installing Sonatype Nexus Repository Using the OpenShift Operator.