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

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 129 Next »

Table of Contents

Overview

Sonar is made of 3 components:

  1. A Database that stores the configuration and results of quality analysis
  2. A Web Server that is used to navigate the results of the analyzes and make configuration
  3. A Client that will run source code analyzers to compute data on projects

Client

Prior to the installation, check the requirements.

Download and unzip the distribution.

Database

Install Database

Sonar supports several database engines you can choose amongst.

If you simply want to make a test or a demo, you can use Apache Derby as a database. Derby is shipped with Sonar and does not need any installation. Derby is not robust nor scalable and should not be used for production.

To use one of the other databases, you simply need to create a schema and provide permissions to create, update and delete objects. Tables and indexes will then be automatically created when launching Sonar for the first time. A sample scripts to create the schema in MySQL can be found in here.

Character Set

Icon

When creating a database, the recommended character set is UTF-8.

Collation

Icon

Collation must be case-sensitive. It must also be accent-sensitive in Microsoft SQL Server.

Configure Database

If you do not use the default embedded database, edit conf/sonar.properties to configure the database access. Templates are available for every supported database. Just uncomment them and comment the first four lines dedicated to derby.

  • sonar.jdbc.url : the URL of the database
  • sonar.jdbc.driver : the class of the driver
  • sonar.jdbc.user : the username (default value is 'sonar')
  • sonar.jdbc.password : the password (default value is 'sonar')

Example for MySQL:

For Oracle, copy the JDBC driver to /extensions/jdbc-driver/[YOUR DATABASE]/. Other drivers for supported database are already provided.

Sonar Server

Mode 1 - Start the standalone application

The default listen port is 9000, the default context path is / and Sonar listens by default to all network interfaces : '0.0.0.0'. Once launched, the Sonar web server is available on http://localhost:9000. Parameters can be changed into the file conf/sonar.properties. Here is an example to listen to http://localhost:80/sonar :


Execute the following script to start the server :

Note that you can also run as a NT service with bin/windows-x86-32/InstallNTService.bat then bin/windows-x86-32/StartNTService.bat

You can now browse to http://localhost:9000.

Mode 2 - Deploy on JEE Server

Sonar can be packaged as a WAR then deployed into an existing JEE server. To use this method of installation, you must already know how to deploy a web application on the application server of choice. The supported servers are Tomcat 5.x, 6.x, 7.x and Jetty 6.x.

Installation steps are :

  • Edit conf/sonar.properties as described in standalone mode. The file conf/wrapper.conf is never used when deploying to application server.
  • Execute the script build-war.sh (or build-war.bat on MS Windows) from the directory war/
  • Deploy war/sonar.war to the application server
  • Browse to http://localhost/sonar and follow setup instructions

You can inject environment variables in the "sonar.properties" file

Icon

You have a specific syntax for that. For instance, to inject the JDBC connection string:

This can be quite valuable to better handle production environments.

Icon

A minimum heap size of 512Mb is required. To increase memory heap size on Tomcat, set the CATALINA_OPTS variable before starting Tomcat

Prior to Sonar 2.2, the WAR file must be rebuilt each time the configuration is updated (new plugins or new extensions).
From Sonar 2.2 onwards, the WAR file is now linked to the Sonar directory (the directory where the distribution is unzipped). It implies that :

  • the directory where the distribution is unzipped cannot be removed
  • there is no need to rebuild the WAR when installing/uninstalling plugins or rule extensions
  • the WAR file must be deployed on the host which contains the Sonar directory
  • the WAR file must be rebuilt when the Sonar directory is moved
  • the WAR file must be rebuilt when a configuration file is updated (directory conf/)

    Icon

    The user who runs Tomcat must have read & write access to Sonar home directory (to allow plugin install from the Web admin console for instance).

More details on this blog.

Mode 3 - Run as a service on MS Windows

Install/uninstall NT service (may have to run these batch files via "Run As Administrator"):

Start/stop the service :

 

Mode 4 - Run as a service on Linux

The following has been tested on Ubuntu 8.10 and CentOS 6.2.

Create the file /etc/init.d/sonar with this content :

Register Sonar at boot time (Ubuntu, 32 bit):

Register Sonar at boot time (RedHat, CentOS, 64 bit):

Analyzer

The Client can be launched by 3 different kinds of analyzer:

Advanced Intallation

To run Sonar behind a proxy, browse this page.

  • No labels