IQ Server Installation
Create the Installation Directory
Before installation, please check the IQ Server requirements.
After a successful download of the IQ Server bundle archive, create an installation directory in the desired location and move the archive into the directory. For example:
Moving into the directory and extracting the archive with either one of these commands:
results in a directory with the following files:
Start the IQ Server
Once the IQ Server is installed, start it with:
This command starts the server with the IQ Server application using the configuration from the config.yml file and logging any output straight to the console. After a complete starts your console displays a message similar to:
IQ Server now requires Java 8 starting with the 1.42 release. If you are running on an older version of Java (such as Java 7) you may encounter a message similar to the following on startup:
If you encounter this message, you should upgrade to Java 8 to resolve the issue.
The command to start the server can be modified by adding java configurations parameters such as
-Xmx1024m to improve performance and adapt to the server hardware.
At this stage you can access the web application at port 8070 of your server via any web browser. Initial startup will display a screen for the License Installation.
We recommend always using SSL to ensure confidentiality of report and credential data during transit. This can be done by setting up a proxy server. You can find more details in the HTTPS Configuration section of Configuring.
Login to IQ Server
At a minimum, IQ Server requires you to log in before anything else can happen. This can be done by creating a user within the IQ Server realm, or by configuring LDAP, and logging in via one of those connected users.
To log into the IQ Server simply go to the address of your IQ Server (e.g. localhost:8070) and enter your username and password.
If this is your very first time logging in, you will need to use the default Admin account. This user is a preconfigured Admin account that has been assigned to all Administrator roles. Once you log in with this account for the first time, be sure to change the admin password.
To logout, click on the Log Out link located in the upper right corner.
IQ server will timeout after 30 minutes of inactivity.
Once logged in, you can check for product notifications, which provide the most up-to-date information about IQ Server. Click the notifications icon on the IQ Server toolbar to view the Notifications panel. If you have unread notifications, they are indicated by a count, in blue, displayed over the notification icon.
Install the License
IQ Server requires a license to be installed. The required license file will be supplied to you by the Sonatype support team in the form of a
To install the product license:
- Open a web browser and navigate to the IQ Server web application. By default this will be at http://localhost:8070
- Signin to the IQ Server using the default administator login credentials (user ID "admin", password "admin123"). Once autheticated successfully, you will be prompted to install a product license.
- On the Product License Configuration screen, press the Install License button and select the
.licfile in the file selector. Accept the end user license agreement to complete license installation. You will be taken to the Getting Started page that outlines initial steps towards getting value out of the IQ Server.
IQ Server Directories
When the IQ Server first starts, it creates a directory for the storage of all its data and configuration. This directory is configured in
config.yml and defaults to
./sonatype-work/clm-server. This path is relative to the location of the invoking java command.
Using the default startup command from the installation directory, causes
/sonatype-work/clm-server to be created within it.
If you would like to separate the installation and data directories set
sonatypeWork to a different location.
Additionally, a log directory is created within the installation directory. Use the
currentLogFilename parameter in
config.yml to change the location.