title: Install the Server
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 create
, update
, and delete
objects for this schema.
warning
| 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 is_read_committed_snapshot_on
:
SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name='YourSonarQubeDatabase';
Example of query to update is_read_committed_snapshot_on
:
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.dll
to 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_owner
database 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_owner
database role membership.
Ensure that sonar.jdbc.username
or sonar.jdbc.password
properties are commented out or SonarQube will use SQL authentication.
sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar;integratedSecurity=true
To use SQL Authentication, use the following connection string. Also ensure that sonar.jdbc.username
and 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:
warning | Oracle JDBC driver versions 12.1.0.1 and 12.1.0.2 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
First, check the requirements. Then download and unzip the distribution (do not unzip into a directory starting with a digit).
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.
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
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.
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:
sonar.path.data=/var/sonarqube/data
sonar.path.temp=/var/sonarqube/temp
The user used to launch SonarQube must have read and write access to those directories.
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:
You can now browse SonarQube at http://localhost:9000 (the default System administrator credentials are admin
/admin
).
By default, SonarQube is configured to run on any computer with a simple Java JRE.
For better performance, the first thing to do when installing a production instance is to use a Java JDK and activate the server mode by uncommenting/setting the following line in $SONARQUBE-HOME/conf/sonar.properties:
sonar.web.javaOpts=-server
To change the Java JVM used by SonarQube, simply edit $SONARQUBE-HOME/conf/wrapper.conf and update the following line:
wrapper.java.command=/path/to/my/jdk/bin/java
Click your SonarQube version below for instructions on installing the server from a Docker image.
collapse
| ## SonarQube 8.2+
|
| Follow these steps for your first installation:
|
| 1. 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:
| bash
| $> docker volume create --name sonarqube_data
| $> docker volume create --name sonarqube_extensions
| $> docker volume create --name sonarqube_logs
|
|
| 2. Configure the database with SonarQube properties using environment variables. Define these variables using the -e flag as shown in the following example:
|
| console
| #Example for PostgreSQL
| -e SONAR_JDBC_USERNAME=sonar \
| -e SONAR_JDBC_PASSWORD=sonar \
| -e SONAR.JDBC.URL=jdbc:postgresql://localhost/sonar \
|
|
| For more configuration environment variables, see the Docker Environment Variables.
|
| info
| | 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 the sonarqube_extensions
volume.
|
| warning
| | Use of the environment variables SONARQUBE_JDBC_USERNAME
, SONARQUBE_JDBC_PASSWORD
, and SONARQUBE_JDBC_URL
is deprecated and will stop working in future releases.
|
| 3. Run the image:
|
| bash
| $> 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>
|
collapse
| ## SonarQube 7.9.x LTS
|
| Follow these steps for your first installation:
|
| 1. Create volumes sonarqube_conf
, sonarqube_data
, sonarqube_logs
, and sonarqube_extensions
and 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.
|
| console
| $ 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>
|
|
|2. Configure sonar.properties if needed. Please note that due to SONAR-12501, providing sonar.jdbc.url
, sonar.jdbc.username
, sonar.jdbc.password
and sonar.web.javaAdditionalOpts
in sonar.properties
is not working, and you will need to explicitly define theses values in the docker run command with the -e
flag.
|
| plain
| #Example for PostgreSQL
| -e sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube
|
|
|info
|| 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 |$SONARQUBE_HOME/extensions/jdbc-driver/oracle
.
|
|3. Run the image with your JDBC username and password :
|
| console
| $ 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>
|
Once your server is installed and running, you may also want to Install Plugins. Then you’re ready to begin Analyzing Source Code.
To grant more memory to a server-side process, uncomment and edit the relevant javaOpts property in $SONARQUBE_HOME/conf/sonar.properties
, specifically:
sonar.web.javaOpts
(minimum values: -server -Xmx768m
)sonar.ce.javaOpts
sonar.search.javaOpts
SonarQube seems unable to start when installed under the Program Files
directory on Windows Vista. It should therefore not be installed there.
USERS
table structureWhen other USERS
tables exist in the Oracle DB, if the sonarqube
user has read access on this other USERS
table, the SonarQube web server can’t start and an exception like the following one is thrown:
ActiveRecord::ActiveRecordError: ORA-00904: "TOTO": invalid identifier
: INSERT INTO users (login, name, email, crypted_password, salt,
created_at, updated_at, remember_token, remember_token_expires_at, toto, id)
VALUES('admin', 'Administrator', '', 'bba4c8a0f808f9798cf8b1c153a4bb4f9178cf59', '2519754f77ea67e5d7211cd1414698f465aacebb',
TIMESTAMP'2011-06-24 22:09:14', TIMESTAMP'2011-06-24 22:09:14', null, null, null, ?)
ActiveRecord::ActiveRecordError: ORA-00904: "TOTO": invalid identifier
: INSERT INTO users (login, name, email, crypted_password, salt,
created_at, updated_at, remember_token, remember_token_expires_at, toto, id)
VALUES('admin', 'Administrator', '', 'bba4c8a0f808f9798cf8b1c153a4bb4f9178cf59',
'2519754f77ea67e5d7211cd1414698f465aacebb', TIMESTAMP'2011-06-24 22:09:14', TIMESTAMP'2011-06-24 22:09:14', null, null, null, ?)
To fix this issue, the rights of the sonarqube
Oracle user must be decreased to remove read access on the other USERS
table(s).
Double check that settings for proxy are correctly set in $SONARQUBE_HOME/conf/sonar.properties
.
Note that if your proxy username contains “\” (backslash), then it should be escaped - for example username “domain\user” in file should look like:
http.proxyUser=domain\\user
For some proxies, the exception “java.net.ProtocolException: Server redirected too many times” might mean an incorrect username or password has been configured.
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.