SonarQube Platform Overview
The SonarQube platform is made of 3 components:
- One Database to store:
- the configuration of the SonarQube instance (security, plugins settings, etc.)
- the quality snapshots of projects, views, etc.
- One Web Server for users to browse quality snapshots and configure the SonarQube instance
- One or several Clients to analyze projects
- The SonarQube platform cannot have more than one single web server and one single database.
- To set a performant platform:
- Each component (Database, Web Server, Clients) should be installed on a dedicated machine
- The Database and the Clients should be located in the same network
Installing the Database
Several database engines are supported.
To give a quick try, you can stick with 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". Here is a sample script for MySQL.
Installing the Web Server
First, check the requirements.
Setting the access to the Database
If you're not using the embedded H2 database, you need to edit SONARQUBE_HOME/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:
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 the SONARQUBE_HOME/extensions/jdbc-driver/oracle directory.
Starting the Web Server
By default, SonarQube starts an embedded Jetty web server. The default port is "9000" and the context path is "/". Parameters can be changed in the SONARQUBE_HOME/conf/sonar.properties file:
Execute the following script to start the server:
- On Linux/Mac OS: bin/<YOUR OS>/sonar.sh start
- On Windows: bin/windows-x86-XX/StartSonar.bat
- Read Installing SonarQube on AIX, HPUX or Solaris for other platforms
You can now browse SonarQube at http:\\localhost:9000.
Advanced Installation Features
- Deploying SonarQube on a Tomcat or Jetty web server of your choice
- Running SonarQube as a Service on Windows or Linux
- Running SonarQube behind a Proxy
Installing the Clients
There are different clients available to run analyses:
- SonarQube Runner: recommended as the default one, see installation and configuration guide.
- Maven: recommended for projects built with Maven, see installation and configuration guide.
- SonarQube Ant Task: recommended for projects built with Ant, see installation and configuration guide.
- Gradle: recommended for projects built with Gradle, see installation and configuration guide.
- CI Engine: see Jenkins plugin or Hudson plugin or Bamboo plugin or AnthillPro plugin. Note that other CI engines can be used even if there is no SonarQube plugin available.