Installing a plugin
Learn how to install or uninstall a plugin in SonarQube Server.
You need to manually install plugins when using SonarQube Server (you cannot use the SonarQube Marketplace).
To see what plugins are available and which version is appropriate for your SonarQube Server, use the Plugin version matrix, which is kept up to date with current plugin availability and compatibility.
Plugins are not provided by Sonar; therefore, you install them at your own risk. A SonarQube Server administrator needs to acknowledge this risk in the Marketplace before installing plugins or when prompted in SonarQube Server after installing a plugin manually.
Installing a plugin
Download the plugin you want to install. The version needs to be compatible with your SonarQube version.
Put the downloaded jar in
<sonarqubeHome>/extensions/plugins, and remove any previous versions of the same plugins.Restart your SonarQube.
In case of a Data Center edition:
Plugins are not shared, meaning if you install/uninstall/upgrade a given plugin on one application node, you need to perform the same actions on the other application nodes.
All application nodes must be stopped when installing, uninstalling, or upgrading a plugin.
When running SonarQube Server under Docker, any plugin you want to install must also be copied into the Docker volume you create during installation. See the Installation overview article in our documentation for more details about creating the volume and container.
Once SonarQube Server UI is up, you can encrypt sensitive properties stored in <sonarqubeHome>/conf/sonar.properties. See the Sensitive settings page.
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.
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.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>'Install the new plugin using
docker exec sonarqube bash -c 'wget <PLUGIN_JAR_URL> -P "$SONARQUBE_HOME"/extensions/plugins/'Restart the SonarQube docker container using
docker restart sonarqube
Note that if you have followed the guidelines outlined on the Prepare the Docker installation page, the resulting plugin will be available in the sonarqube_extensions volume, which is attached to the <SONARQUBE_HOME>/extensions/plugins folder.
In case of a Data Center edition:
Plugins are not shared, meaning if you install/uninstall/upgrade a given plugin on one application node, you need to perform the same actions on the other application nodes.
All application nodes must be stopped when installing, uninstalling, or upgrading a plugin.
Download the appropriate plugin JAR file from a trusted source, ensuring it’s compatible with your SonarQube version.
Add the plugins section to your
values.yamlfile as illustrated below and use thehelm upgradecommand to apply the new chart.
Or use the helm upgrade command as illustrated below:
To verify the plugin installation, go to Administration > Marketplace.
Uninstalling a plugin
To uninstall a plugin:
Delete the plugin from the
<sonarqubeHome>/extensions/pluginsfolder.Restart your SonarQube Server.
Was this helpful?