Introduction

Read this before starting the SonarQube server installation.

We recommend installing SonarQube Server from a Docker image or Helm chart (Kubernetes/OpenShift). These methods make it easier to update to newer versions and to operate your instance. Install from the ZIP file only if neither of those options is feasible for your environment.

The server installation section describes a single-node SonarQube instance from the ZIP file or from the Docker image. For a Kubernetes installation, see Deploying SonarQube. For details on clustered setup, see Install the server as a cluster.

Installation roadmap

Proceed as follows to install SonarQube on server side:

1. Install the Installing the database.

2. Install the SonarQube server and perform a basic setup. You can install the server either Installing SonarQube from the Docker image or Installing SonarQube from the ZIP file.

3. If necessary, perform Advanced installation features.

Instance components

A SonarQube instance comprises three components:

SQ instance components

SQ instance components

1. The SonarQube server running the following processes:

   • A web server that serves the SonarQube user interface.

   • A search server based on Elasticsearch.

   • The compute engine in charge of processing code analysis reports and saving them in the SonarQube database.

2. The database to store the following:

   • Metrics and issues for code quality and security generated during code scans.

   • The SonarQube instance configuration.

3. One or more scanners running on your build or continuous integration servers to analyze projects.

Hosts and locations

For optimal performance, the SonarQube server and database should be installed on separate hosts, and the server host should be dedicated. The server and database hosts should be located on the same network.

All hosts must be time-synchronized.