Start Free
10.6 | Server installation and setup | Install a plugin

Was this page helpful?

Install a plugin

On this page

There are two ways to install plugins in SonarQube:

  • Marketplace: With Community Edition, you can automatically install plugins from the Administration > Marketplace tab. With Commercial Editions, you can browse plugins in the Marketplace, but you must manually install and update your plugins.
  • Manual Installation: You need to manually install plugins when using any commercial edition of SonarQube. You can also manually install plugins if your SonarQube instance doesn't have internet access, or if the plugin you're installing isn't in the SonarQube Marketplace.

Installing plugins from the marketplace

If your instance has internet access and you're connected with a SonarQube user with the Administer System global permission, you can find the Marketplace at Administration > Marketplace. From here:

  • Find the plugin you want to install.
  • Click Install and wait for the download to be processed.

Once the download is complete, a Restart button will be available to restart your instance. Restarting will enable the new plugin. This restart will not take into account any change to sonar-properties settings.

See Marketplace for more details on how to configure your SonarQube Server to connect to the internet.

Manually installing plugins

To manually install a plugin:

  1. Download the plugin you want to install. The version needs to be compatible with your SonarQube version.
  2. Put the downloaded jar in <sonarqubeHome>/extensions/plugins, and remove any previous versions of the same plugins.
  3. Restart your SonarQube server.

Uninstalling plugins

To uninstall a plugin:

  1. Delete the plugin from the <sonarqubeHome>/extensions/plugins folder.
  2. Restart your SonarQube server.

Install plugins under Docker

When running SonarQube under Docker, any plugin you want to install must also be copied into the Docker volume you create during installation. See the Installing SonarQube from the Docker image article in our documentation for more details about creating the volume and container.

Manually install a plugin in a SonarQube docker container

Let’s assume that your SonarQube docker container is called sonarqube. The easiest way to install manually a plugin in the container is the following.

  1. Check if an existing version of the plugin exists. Run docker exec sonarqube bash -c 'ls "$SONARQUBE_HOME"/extensions/plugins' to see the entire list of plugins that are installed manually.
  2. If a previous version of the plugin is listed, remove it using docker exec sonarqube bash -c 'rm "$SONARQUBE_HOME"/extensions/plugins/<PLUGIN_JAR_FILE_NAME>'
  3. Install the new plugin using docker exec sonarqube bash -c 'wget <PLUGIN_JAR_URL> -P "$SONARQUBE_HOME"/extensions/plugins/'
  4. Restart the SonarQube docker container using docker restart sonarqube

Please note that if you have followed the guidelines outlined on this page, the resulting plugin will be available in the sonarqube_extensions volume, which is attached to the <SONARQUBE_HOME>/extensions/plugins folder.

© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARLINT, SONARQUBE, SONARCLOUD, and CLEAN AS YOU CODE are trademarks of SonarSource SA.

Creative Commons License