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 installing the repository manager on a local workstation to give it a test run, you can install it in your home directory or wherever you like. Nexus Repository Manager doesn’t have any hard-coded directories and will run from any directory.

You can extract the archive ZIP for Windows with any archiving tool like 7zip or on the command line.

On Windows you should install the repository manager outside Program Files 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.

On OSX or Linux the downloaded GZip’d TAR archive can be extracted with the command tar xvzf.

You install the repository manager in a directory other than your users home directory. On a Unix machine common practice is to use /opt. The extraction process creates two sibling directories: an application directory and a data directory, sometimes called the "Sonatype Work" directory. Further details about these folders and their contents can be found in Directories.

The bin folder contains the generic startup scripts for Unix-like platforms called nexus. The Windows platform equivalent is called nexus.exe.

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

./nexus run

The equivalent invocation on Windows requires a / in front of the run and any other commands.

nexus.exe /run

Starting the repository manager with the run command will leave it running in the current shell and display the log output.

Startup is complete when the log shows the message "Started Sonatype Nexus".

In order to shut down the repository manager running via the run command, you have to press CTRL-C.The nexus script can be used to manage the repository manager as a background application on OSX and Unix with the startstoprestartforce-reload and status commands. The Windows nexus.exe command supports similar commands with a prefix of / e.g., /start. Once the repository manager is started you can access the user interface as detailed in Accessing the User Interface.

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

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.