Install self-hosted IQ Server

In this section, you'll find documentation on how to install self-hosted instances of Sonatype IQ Server.

Users of Lifecycle Cloud may refer to Feature parity with Sonatype Cloud for details of which documentation applies to their deployment.

IQ Server installation checklist

Review the System Requirements and the Sonatype Container Deployment - Lifecycle options.
For High-Availability architecture diagrams see IQ Server High Availability Installation.
Setting up the database - see External Database Configuration
Production servers need to be configured as a service. See Run IQ Server as a Service
The first time you log in you are required to install the Product License
Document your steps and configuration settings for upgrades and backups

Default credentials

The default server credentials are the user admin with the password admin123

The Change Administrator Password notice will remain in the UI until the default password has been modified.

Installation

The steps throughout the documentation refer to storing the server installation files in the server's /opt directory. You may use a different directory, however, we recommend documenting any changes in your internal notes.

To Install the server:

Download the latest version of the server from Download and Compatibility

Create a directory for the installation and move the archive into the folder

cd /opt
mkdir nexus-iq-server
mv ~/Downloads/nexus-iq-server.* nexus-iq-server/
cd nexus-iq-server

From the directory, extract the archive

unzip nexus-iq-server*.zip
tar xfvz nexus-iq-server*.tar.gz

See IQ Server Directory and Files for details on the installation folder contents

Initialization

Use the following command to start the IQ Server. This starts the server using the configuration from the Config YAML. The output is logged to the console and errors will be recorded in the stderr.log file.

cd /opt/nexus-iq-server
java -jar nexus-iq-server-*.jar server config.yml 2> stderr.log

Linux requires a User to start the server. See Run IQ Server as a Service for details and examples.

A successful start will result in a console message similar to the following:

... [main] org.eclipse.jetty.server.AbstractConnector - Started InstrumentedBlockingChannelConnector@0.0.0.0:8070
... [main] org.eclipse.jetty.server.AbstractConnector - Started SocketConnector@0.0.0.0:8071

The start command may be modified by adding Java configuration parameters.

JAVA_OPTIONS="-Djava.util.prefs.userRoot=./sonatype-work/javaprefs -Djava.io.tmpdir=/path/to/tmpdir"
java $JAVA_OPTIONS -jar nexus-iq-server-*.jar server ./iq-server/config.yml 2> stderr.log

Automatic Shutdown on Errors

In rare circumstances, errors may occur that are severe enough to be effectively unrecoverable under normal conditions. When this occurs, the system will shut down to preserve a valid system state and avoid errant behavior or data corruption that could occur as a result of continuing in a potentially abnormal or undefined state.

We recommend that you configure to Run IQ Server as a Service and ensure that it restarts automatically to avoid a prolonged outage in the event of an unrecoverable error.