Getting Started

If you're a new Lifecycle user, we have some great resources to help get you started.

First, take a quick tour of the user interface:

Then check out our help docs. If you need a roadmap to get started, that's what you'll find here. This topic is divided into two areas:


The UI Navigation is updated as of Release 112, pivoting from the top of the page to the left of the page. The navigation items/links remain the same and will continue to take you to the pages you currently use today.

Screen captures and videos throughout these help pages may show the top navigation while we work to update our documentation.

Getting Started with Deployment

There are a few easy steps you should consider when you're first getting IQ Server installed. 

First, understand your environment

Before installing, take a minute to think about architectural decisions that could affect the deployment of the server. For example — How big is the environment? How many scans do you anticipate? What is your infrastructure? Use the example IQ Server architectural diagram to start envisioning your setup.

Then check system requirements

The IQ Server is typically deployed on dedicated hardware. More specific hardware requirements are ultimately a function of your deployment architecture, primary usage patterns, and scale of deployment. See our System Requirements for info on what you need for installation.

You'll also need a product license to run IQ Server and its solutions (Lifecycle, Firewall, and Auditor). See Licensing and Features for more information.

Next, deploy the IQ Server 

If you haven't already, go ahead and Download the latest version of IQ Server.

After download, you can go ahead and deploy the IQ Server. There are a few deployment options:

Then configure your IQ Server setup

See our Configuring section to see how you can configure the IQ Server to suit your organization's needs.

Finally, set up your integrations

IQ Server also integrates with other tools in your CI/CD pipeline. Now is a good time to set up your  IQ Server Integrations.

Getting Started with Management

Now that you have the IQ Server installed and configured, next up you'll need to start managing your setup. These topics will help Administrators get up and running with IQ Server management tasks.

First, you'll want to add users

You can manually add users to the default IQ Server realm. Additionally, IQ Server can authenticate and authorize users in other realms (LDAP, SAML, and Atlassian Crowd.) It also suppors user-token and reverse proxy based authentication. Refer to user management section for more details.

Then define your organizational structure

Organizational hierarchy affects how policies, categories, and license threat groups inherit to your applications. Read our topic on Hierarchy and Inheritance to better understand these relationships and then check out Organization Management to get started.

Next, you should define policy

Policies define the conditions under which Lifecycle will take action.IQ Server comes with out-of-the-box reference policies that help you easily get up and running, but you can also check out the Policy Management section for more guidance.

Then start onboarding applications

Applications in IQ Server represent your development projects. See our Approaches to onboarding applications to IQ Server guide to learn more about onboarding options.

And run an evaluation

Now that you have your applications onboarded you'll want to run an evaluation scan. You can do this by manually evaluating an application.

Finally, you'll want to check out some reports

An evaluation report shows the results of a single Lifecycle evaluation. See our topics on the Application Composition Report for help accessing, reviewing, and remediating.

You'll also want to check out the Dashboard. This is where you can see real-time insight into your applications and components.

After you're set up and you've been evaluating for a while, it's a good idea to look at Success Metrics to get a high-level summary of your usage of Nexus Lifecycle.