Difference between revisions of "Sonar"

Line 142: Line 142:
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
vim /etc/apache2/mods-enabled/proxy.conf
 
vim /etc/apache2/mods-enabled/proxy.conf
 +
 +
#or
 +
 +
vim /etc/apache2/sites-enabled/mySite.conf
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 149: Line 153:
 
<syntaxhighlight lang="apache">
 
<syntaxhighlight lang="apache">
 
# Proxy to a Java application running over Tomcat, with IP filter
 
# Proxy to a Java application running over Tomcat, with IP filter
<Location /sonar>
+
<Location /sonarqube >
ProxyPass http://localhost:9000/sonar
+
ProxyPass http://localhost:9000/sonarqube/
ProxyPassReverse http://localhost:9000/sonar
+
ProxyPassReverse http://localhost:9000/sonarsonarqube/
  
         ### Apache < 2.4
+
         #Require all denied
#Order allow,deny
+
        #AllowOverride none
#Allow from 127.0.0.1 192.168.1.0/24 193.12.118.196
+
          
 
         ### Apache 2.4
 
 
         Require local
 
         Require local
 
         Require ip 192.168.1
 
         Require ip 192.168.1
 
         Require host 193.12.118.196
 
         Require host 193.12.118.196
 +
 +
        #Require all granted
 +
        #Satisfy any
 
</Location>
 
</Location>
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 167: Line 172:
 
==Test Sonar==
 
==Test Sonar==
  
* Default URL: http://localhost:9000/sonar  
+
* Default URL: http://localhost:9000/sonarqube/  
* Using Apache2 proxy: http://myServer/sonar
+
* Using Apache2 proxy: http://myServer/sonarqube
  
 
The default user and password are “admin” and “admin“.
 
The default user and password are “admin” and “admin“.
Line 182: Line 187:
 
/opt/sonar/logs/sonar.log
 
/opt/sonar/logs/sonar.log
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
 +
 +
=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.
 +
 +
<syntaxhighlight lang="bash">
 +
vim /opt/sonarqube/bin/linux-x86-64/sonar.sh
 +
</syntaxhighlight>
 +
 +
 +
Add the following lines right after the <code>#!/bin/sh</code>
 +
 +
<syntaxhighlight lang="bash">
 +
### BEGIN INIT INFO
 +
# Provides:            sonarqube
 +
# Required-Start:      $all
 +
# Required-Stop:
 +
# Default-Start:        4 5
 +
# Default-Stop:        0 1 6
 +
# Short-Description:    Sonarqube code quality analysis
 +
### END INIT INFO
 +
</syntaxhighlight>
 +
 +
 +
 +
==Register sonarqube to boot sequence==
 +
 +
(i) You just need to do that once.
 +
 +
<syntaxhighlight lang="bash">
 +
cd /etc/init.d/
 +
update-rc.d sonarqube defaults
 +
</syntaxhighlight>
 +
 +
  
  
Line 189: Line 236:
  
  
The service will not be available until you go to '''http://myServer/sonar/setup'''
+
The service will not be available until you go to '''http://myServer/sonarqube/setup'''
  
  
 
You have to agree to the terms and upgrade database
 
You have to agree to the terms and upgrade database

Revision as of 20:47, 11 September 2015


The following instructions are for Ubuntu 14.04 LTS.


You can find all these instructions and more on the Official how-to: http://sonar-pkg.sourceforge.net/


Requirements

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';
CREATE DATABASE IF NOT EXISTS sonarqube;
GRANT ALL PRIVILEGES ON sonarqube.* TO 'sonarqube'@'localhost';
FLUSH PRIVILEGES;


Installation

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


Get SonarQube

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

cd /opt
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


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


Configuration

Edit the SonarQube configuration file

vim /opt/sonarqube/conf/sonar.properties


Database

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

sonar.jdbc.username=sonarqube			            
sonar.jdbc.password=sonarqube
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonarqube?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true


Port number and root context

Adjust port number and context

#sonar.web.host:             0.0.0.0
#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


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 0.0.0.0:9000            0.0.0.0:*               LISTEN      xxxxx/java


Access SonarQube

http://myserver:9000/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

#or

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 193.12.118.196

        #Require all granted
        #Satisfy any
</Location>


Test Sonar

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


Logs

Sonar logs are in:


/opt/sonar/logs/sonar.log


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

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


Register sonarqube to boot sequence

(i) You just need to do that once.

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



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