Difference between revisions of "Sonar"

Line 5: Line 5:
* 2016-12-25 : update for Ubuntu 16.10
* 2016-12-25 : update for Ubuntu 16.10
* 2019-03-26 : update for SonarQube 7.x on CentOs 7.x ; with PostgreSQL server
You can find all these instructions and more on the Official how-to: http://sonar-pkg.sourceforge.net/
You can find all these instructions and more on the [https://docs.sonarqube.org/latest/setup/install-server/ Official how-to]
=Requirements: database server=
You need to have a MySQL server available.  
You need to have a MySQL server available.  
Line 25: Line 28:
Source: [https://www.linode.com/docs/databases/postgresql/how-to-install-postgresql-relational-databases-on-centos-7/ Linode tutorial]

Revision as of 08:27, 26 March 2019

The following instructions are for Ubuntu.

  • 2016-12-25 : update for Ubuntu 16.10
  • 2019-03-26 : update for SonarQube 7.x on CentOs 7.x ; with PostgreSQL server

You can find all these instructions and more on the Official how-to

Requirements: database server


You need to have a MySQL server available.

Create an empty DB and MySQL user "sonarqube"

mysql -u root -p

CREATE USER 'sonarqube'@'localhost' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON sonarqube.* TO 'sonarqube'@'localhost';


Source: Linode tutorial


I advise you to use the manual set-up and update. Experience proved that it can be cumbersome to upgrade SonarQube.

Get SonarQube and SonarRunner

  • SonarQube == Application to detect issues and display them (web-based)
  • SonarRunner == Command line tool to interact with SonarQube. This is required for Jenkins and other tools.

Download the latest version (or the LTS) on http://www.sonarqube.org/downloads/

cd /opt

# SonarQube
wget https://sonarsource.bintray.com/Distribution/sonarqube/sonarqube-5.1.2.zip
unzip sonarqube-5.1.2.zip
ln -s /opt/sonarqube-5.1.2 /opt/sonarqube

# SonarRunner
wget http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip
unzip sonar-runner-dist-2.4.zip
ln -s /opt/sonar-runner-2.4/ /opt/sonar-runner

# Make the SonarRunner available from anywhere
ln -s /opt/sonar-runner/bin/sonar-runner /usr/bin/sonar-runner

(i) It's always good to use a symlink. This make the update and rollback a bit easier.

Configuration (sonar.properties)

Edit the SonarQube configuration file

vim /opt/sonarqube/conf/sonar.properties


Disable embedded H2DB and enable MySQL database, lines 20 to 40:


Port number and root context

Adjust port number and context (~ line 107)

#sonar.web.port:             9000
sonar.web.context:           /sonarqube

!!! This is VERY important that you uncomment and set the sonar.web.context !!! Without it you cannot use Apache2 proxy.

Sonar symlink

The default path to manage SonarQube is, in that example: /opt/sonarqube/bin/linux-x86-64/sonar.sh idem for the logs...

ln -s /opt/sonarqube/bin/linux-x86-64/sonar.sh /usr/bin/sonarqube
ln -s /opt/sonarqube/bin/linux-x86-64/sonar.sh /etc/init.d/sonarqube

mkdir -p /var/log/sonar
ln -s /opt/sonarqube/logs/sonar.log /var/log/sonar/sonar.log
ln -s /opt/sonarqube/logs/access.log /var/log/sonar/access.log

Configuration (wrapper.properties)

There is a new configuration file to edit since 5.x. Edit the WRAPPER configuration file

vim /opt/sonarqube/conf/wrapper.properties

Adjust your JVM path, if required, on the first line. This should point to a JDK.


Apply changes

You must start Sonar to use the new settings.

sonarqube restart

... wait for some times on 1st start (5 to 7 mn) !! Logs are in

Check that Sonar is up:

netstat -pl --numeric | grep 9000

You should have:

tcp        0      0  *               LISTEN      xxxxx/java

Bug fix

If the port 9000 is already used by PHP you must remove PHP7 FPM

sudo apt-get remove php7.0-fpm

Access SonarQube


Apache2 proxy

Instead of opening port 9000, it's better to access Sonar through Apache2 proxy.

To use the proxy rule, the target /sonar must match the root URL (see sonar.properties)

Apache2 configuration

Edit configuration file: module or virtual host

vim /etc/apache2/mods-enabled/proxy.conf


vim /etc/apache2/sites-enabled/mySite.conf

Set the following:

# Proxy to a Java application running over Tomcat, with IP filter
<Location /sonarqube >
	ProxyPass http://localhost:9000/sonarqube/
	ProxyPassReverse http://localhost:9000/sonarsonarqube/

        #Require all denied
        #AllowOverride none
        Require local
        Require ip 192.168.1
        Require host

        #Require all granted
        #Satisfy any

Test Sonar

The default user and password are “admin” and “admin“.


Sonar logs are in:


Sonar Runner


Edit the Sonar-Runner configuration file

vim /opt/sonar-runner/conf/sonar-runner.properties

Enable MySQL database:

!! (i) note that I'm using sonarqube instead of sonar !!



Environment variable

Create a new environment variable SONAR_RUNNER_HOME

vim /etc/environment


Start SonarQube on boot

Adjust sonar.sh

(i) you must do that on each update as well

You need to update the SonarQube bin exec so Debian|ubuntu can start it on boot.

vim /opt/sonarqube/bin/linux-x86-64/sonar.sh

Add the following lines right after the #!/bin/sh

# Provides:             sonarqube
# Required-Start:       $all
# Required-Stop:
# Default-Start:        4 5
# Default-Stop:         0 1 6
# Short-Description:    Sonarqube code quality analysis

Register sonarqube to boot sequence

(i) You just need to do that once.

cd /etc/init.d/
update-rc.d sonarqube defaults

Sonar Maven plugin

See http://docs.sonarqube.org/display/SONAR/Installing+and+Configuring+Maven

Upgrade Sonar

Sometimes when there are a lot of changes the new sonar version required some database change.

The service will not be available until you go to http://myServer/sonarqube/setup

You have to agree to the terms and upgrade database