Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel2

SonarQube Platform Overview

The SonarQube platform is made of 3 components:

...

  • The SonarQube platform cannot have more than a single web server and a 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.

Anchor
installingDatabase
installingDatabase
Installing the Database

Several database engines are supported.

...

Info
titleTuning 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.

Anchor
installingWebServer
installingWebServer
Installing the Web Server

First, check the requirements.

...

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

Setting the access to the Database

Edit <install_directory>/conf/sonar.properties 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:

Code Block
titleExample for PostgreSQL
languagenone
sonar.jdbc.username:  sonarqube
sonar.jdbc.password:  mypassword
sonar.jdbc.url:       jdbc:postgresql://localhost/sonarqube

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

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

...

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:

...

Code Block
languagenone
wrapper.java.command=/path/to/my/jdk/bin/java

Advanced Installation Features

Anchor
InstallingClient
InstallingClient
Installing the Clients

Multiple analysis clients are available:

...