How to Upgrade

Note that you can directly upgrade from one version to another. For example, to upgrade from version 3.1 to version 3.5, it is not necessary to first upgrade to version 3.2, then to version 3.3, and so on.

  1. Read the upgrade notes below for each version
  2. Stop the SonarQube server:

    bin/<SYSTEM>/sonar stop
  3. Download and unzip the new SonarQube distribution in a fresh directory, let's say NEW_SONARQUBE_HOME
  4. Update the content of the sonar.properties and wrapper.conf files located in the NEW_SONARQUBE_HOME/conf directory with the content of the related files in the OLD_SONARQUBE_HOME/conf directory (web server URL, database settings, etc.). Do not copy-paste the old files.
  5. Copy the OLD_SONARQUBE_HOME/extensions/plugins directory into NEW_SONARQUBE_HOME/extensions/plugins.
    (warning) Check for plugins compatibility and upgrade manually the plugins if necessary: see Compatibility Matrix
  6. If a custom JDBC driver is used, copy it into NEW_SONARQUBE_HOME/extensions/jdbc-driver/<dialect>
  7. Back up your database
  8. (warning) In case a "es" directory exists in the "data" directory, remove this "es" directory (should not according to above step 3)
  9. Start the web server:

     NEW_SONARQUBE_HOME/bin/<SYSTEM>/sonar start
  10. Browse to http://localhost:9000/setup (replace "localhost:9000" by your own URL) and follow the setup instructions
  11. Analyze your projects to get fresh measures

 

Upgrading can take a while depending on the size of projects portfolio. To monitor the process, check the logs.

Upgrade is completed when an analysis has been run on project. Only at that point will you get new functionality working for sure.

How to Roll Back

If, for some reasons, your upgrade failed, you can roll back by:

  1. Restoring your backed up database
  2. Updating the OLD_SONARQUBE_HOME/conf/sonar.properties configuration file to link to the restored database
  3. Restarting the previous version of the web server:

     OLD_SONARQUBE_HOME/bin/<SYSTEM>/sonar start

Release Upgrade Notes

Usually the SonarQube releases come with some specific recommendations for upgrading from the previous version. You have to read the upgrade notes for all versions between your current version and the target version.