Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 185 Next »

Table of Contents

SonarQube Platform Overview

The SonarQube platform is made of 3 components:

  1. One Database to store:
    • the configuration of the SonarQube instance (security, plugins settings, etc.)
    • the quality snapshots of projects, views, etc.
  2. One Web Server for users to browse quality snapshots and configure the SonarQube instance
  3. One or more Clients to analyze projects
  • The SonarQube platform cannot have more than one single web server and one single database.
  • For optimal performance, each component (Database, Web Server, Clients) should be installed on a dedicated machine. However, the Server and the Database can be installed on the same machine.
  • Clients will scale by adding machines.
  • The Database and the Clients must be located in the same network.
  • The Database and the Clients must not be installed on the same machine.
  • All the machines must be time synchronized.

Installing the Database

Several database engines are supported.

To give it a quick try, you can use the H2 database that is shipped with SonarQube. It doesn't require any installation. Note that H2 must NOT be used to set up a production instance.

To use the database engine of your choice, just create an empty schema and a sonarqube user. Grant this sonarqube user permissions to create, update and delete objects for this schema. The charset of the database has to be set to "UTF-8" and the language to "English". Here is a sample script for MySQL.

Tuning MySQL Database


There are two well-known engines that can be used in MySQL: MyISAM and InnoDB. MyISAM is the oldest of the two engines and is being progressively replaced by InnoDB. InnoDB is clearly faster and scales better with SonarQube when the number of projects under quality control increases. If you have been an early adopter of SonarQube, you probably have a series of table that are still using MyISAM. To improve performances, you should change the engine for all tables to InnoDB.

Once all SonarQube tables are using the InnoDB engine, the first thing to do is allocate a maximum amount of RAM to your MySQL instance with the innodb_buffer_pool_size parameter and give at least 15Mb to the query_cache_size parameter. Read this article about InnoDB Performance Optimization Basics to get more information.

Installing the Web Server

First, check the requirements.

Then download and unzip the distribution. Note that native packages are also available for Linux distributions.

<install_directory> (below) refers to the path to the directory where the SonarQube distribution has been unzipped.

Setting the access to the Database

If you're not using the embedded H2 database, you need to edit <install_directory>/conf/ to configure the database settings. Templates are available for every supported database. Just uncomment and configure the template you need and comment out the lines dedicated to H2:

Example for PostgreSQL

Adding the JDBC Driver

Drivers for the supported databases (except Oracle) are already provided. Do not replace the provided drivers; they are the only ones supported.

For Oracle, copy the JDBC driver into <install_directory>/extensions/jdbc-driver/oracle.

Starting the Web Server

By default, SonarQube starts an embedded Jetty web server (Note that SonarQube can also be deployed on Tomcat but using the embedded Jetty mode is highly recommended as it is faster and more stable).

The default port is "9000" and the context path is "/". Parameters can be changed in <install_directory>/conf/

Execute the following script to start the server:

You can now browse SonarQube at http:\\localhost:9000.

Tuning the Web Server

By default, SonarQube is configured to run on any computer with a simple Java JRE. The first thing to do when installing a production instance is to use a Java JDK and activate the server mode by uncommenting the following line in <install_directory>/conf/wrapper.conf:

To change the Java JVM used by SonarQube, simply edit <install_directory>/conf/wrapper.conf and update the following line:

Advanced Installation Features

Installing the Clients

Multiple analysis clients are available:

  • No labels