Install the Server
Installing the Database
Several database engines are supported. Be sure to follow the requirements listed for your database, they are real requirements not recommendations.
Create an empty schema and a
sonarqube user. Grant this
sonarqube user permissions to
delete objects for this schema.
Microsoft SQL Server
Collation MUST be case-sensitive (CS) and accent-sensitive (AS).
READ_COMMITED_SNAPSHOT MUST be set on the SonarQube database.
MS SQL database's shared lock strategy may impact SonarQube runtime. Making sure that
is_read_committed_snapshot_on is set to
true to prevent SonarQube from facing potential deadlocks under heavy loads.
Example of query to check
SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name='YourSonarQubeDatabase';
Example of query to update
ALTER DATABASE YourSonarQubeDatabase SET READ_COMMITTED_SNAPSHOT ON WITH ROLLBACK IMMEDIATE;
To use integrated security:
- Download the Microsoft SQL JDBC Driver 7.2.2 package and copy the 64-bit version of
sqljdbc_auth.dllto any folder in your path.
If you're running SonarQube as a Windows service, make sure the Windows account under which the service is running has permission to connect your SQL server. The account should have
db_ownerdatabase role membership.
If you're running the SonarQube server from a command prompt, the user under which the command prompt is running should have
db_ownerdatabase role membership.
- Ensure that
sonar.jdbc.passwordproperties are commented out or SonarQube will use SQL authentication.
To use SQL Authentication, use the following connection string. Also ensure that
sonar.jdbc.password are set appropriately:
sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar sonar.jdbc.username=sonarqube sonar.jdbc.password=mypassword
If there are two SonarQube schemas on the same Oracle instance, especially if they are for two different versions, SonarQube gets confused and picks the first it finds. To avoid this issue:
- Either privileges associated to the SonarQube Oracle user should be decreased
- Or a trigger should be defined on the Oracle side to automatically alter the SonarQube Oracle user session when establishing a new connection:
Oracle JDBC driver versions 184.108.40.206 and 220.127.116.11 have major bugs, and are not recommended for use with the SonarQube (see more details).
If you want to use a custom schema and not the default "public" one, the PostgreSQL
search_path property must be set:
ALTER USER mySonarUser SET search_path to mySonarQubeSchema
Installing the Server from the ZIP file
SonarQube cannot be run as
root on Unix-based systems, so create a dedicated user account to use for SonarQube if necessary.
$SONARQUBE-HOME (below) refers to the path to the directory where the SonarQube distribution has been unzipped.
Setting the Access to the Database
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:
Example for PostgreSQL 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 $SONARQUBE-HOME/extensions/jdbc-driver/oracle.
Configuring the Elasticsearch storage path
By default, Elasticsearch data is stored in $SONARQUBE-HOME/data, but this is not recommended for production instances. Instead, you should store this data elsewhere, ideally in a dedicated volume with fast I/O. Beyond maintaining acceptable performance, doing so will also ease the upgrade of SonarQube.
Edit $SONARQUBE-HOME/conf/sonar.properties to configure the following settings:
The user used to launch SonarQube must have read and write access to those directories.
Starting the Web Server
The default port is "9000" and the context path is "/". These values can be changed in $SONARQUBE-HOME/conf/sonar.properties:
sonar.web.host=192.0.0.1 sonar.web.port=80 sonar.web.context=/sonarqube
Execute the following script to start the server:
- On Linux/Mac OS: bin/
- On Windows: bin/windows-x86-64/StartSonar.bat
You can now browse SonarQube at http://localhost:9000 (the default System administrator credentials are
Adjusting the Java Installation
If there are multiple versions of Java installed on your server, you may need to explicitly define which version of Java is used.
To change the Java JVM used by SonarQube, edit $SONARQUBE-HOME/conf/wrapper.conf and update the following line:
Advanced Installation Features
- Running SonarQube as a Service on Windows or Linux
- Running SonarQube behind a Proxy
- Monitoring and adjusting Java Process Memory
Installing the Server from the Docker Image
See your SonarQube version below for instructions on installing the server from a Docker image.
Follow these steps for your first installation:
Creating the following volumes helps prevent the loss of information when updating to a new version or upgrading to a higher edition:
sonarqube_data– contains data files, such as the embedded H2 database and Elasticsearch indexes
sonarqube_logs– contains SonarQube logs about access, web process, CE process, and Elasticsearch
sonarqube_extensions– contains plugins, such as language analyzers
Create the volumes with the following commands:
$> docker volume create --name sonarqube_data $> docker volume create --name sonarqube_extensions $> docker volume create --name sonarqube_logs
Drivers for supported databases (except Oracle) are already provided. If you're using an Oracle database, you need to add the JDBC driver to the
sonar_extensionsvolume. To do this:
a. Start the SonarQube container with the embedded H2 database:
$ docker run --rm \ -p 9000:9000 \ -v sonarqube_extensions:/opt/sonarqube/extensions \ <image_name>
b. Exit once SonarQube has started properly.
c. Copy the Oracle driver into
Run the image with your database properties defined using the -e environment variable flag:
$> docker run -d --name sonarqube \ -p 9000:9000 \ -e SONAR_JDBC_URL=... \ -e SONAR_JDBC_USERNAME=... \ -e SONAR_JDBC_PASSWORD=... \ -v sonarqube_data:/opt/sonarqube/data \ -v sonarqube_extensions:/opt/sonarqube/extensions \ -v sonarqube_logs:/opt/sonarqube/logs \ <image_name>
For more configuration environment variables, see the Docker Environment Variables.
Use of the environment variables
SONARQUBE_JDBC_URLis deprecated and will stop working in future releases.
SonarQube 7.9.x LTS
Follow these steps for your first installation:
sonarqube_extensionsand start the image with the following command. This will populate all the volumes (copying default plugins, create the Elasticsearch data folder, create the sonar.properties configuration file). Watch the logs, and, once the container is properly started, you can force-exit (ctrl+c) and proceed to the next step.
$ docker run --rm \ -p 9000:9000 \ -v sonarqube_conf:/opt/sonarqube/conf \ -v sonarqube_extensions:/opt/sonarqube/extensions \ -v sonarqube_logs:/opt/sonarqube/logs \ -v sonarqube_data:/opt/sonarqube/data \ <image_name>
Configure sonar.properties if needed. Please note that due to SONAR-12501, providing
sonar.propertiesis not working, and you will need to explicitly define theses values in the docker run command with the
#Example for PostgreSQL -e sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube
Drivers for supported databases (except Oracle) are already provided. Do not replace the provided drivers; they are the only ones supported. For Oracle, you need to copy the JDBC driver into
Run the image with your JDBC username and password :
$ docker run -d --name sonarqube \ -p 9000:9000 \ -e sonar.jdbc.url=... \ -e sonar.jdbc.username=... \ -e sonar.jdbc.password=... \ -v sonarqube_conf:/opt/sonarqube/conf \ -v sonarqube_extensions:/opt/sonarqube/extensions \ -v sonarqube_logs:/opt/sonarqube/logs \ -v sonarqube_data:/opt/sonarqube/data \ <image_name>
Failed to connect to the Marketplace via proxy
Double check that settings for proxy are correctly set in
Note that if your proxy username contains a backslash, then it should be escaped - for example username "domain\user" in file should look like:
For some proxies, the exception "java.net.ProtocolException: Server redirected too many times" might mean an incorrect username or password has been configured.
Exception java.lang.RuntimeException: can not run elasticsearch as root
SonarQube starts an Elasticsearch process, and the same account that is running SonarQube itself will be used for the Elasticsearch process. Since Elasticsearch cannot be run as
root, that means SonarQube can't be either. You must choose some other, non-
root account with which to run SonarQube, preferably an account dedicated to the purpose.