Installing a plugin

How to install / 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 SonarSource; 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

ZIP INSTALLATION

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.

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.

DOCKER INSTALLATION

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 Sensitive settings.

Let’s assume that your SonarQube Server 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 Server docker container using docker restart sonarqube

Note that if you have followed the guidelines outlined Basic installation, 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.

KUBERNETES INSTALLATION

1. Download the appropriate plugin JAR file from a trusted source, ensuring it’s compatible with your SonarQube version.

2. Add the plugins section to your values.yaml file as illustrated below and use the helm upgrade command to apply the new chart.

plugins:
  install:
   - "https://github.com/SonarOpenCommunity/sonar-cxx/releases/download/cxx-2.0.7/sonar-cxx-plugin-2.0.7.3119.jar"

Or use the helm upgrade command as illustrated below:

helm upgrade --install -n sonarqube sonarqube sonarqube/sonarqube \
 --set "plugins.install={https://github.com/SonarOpenCommunity/sonar-cxx/releases/download/cxx-2.0.7/sonar-cxx-plugin-2.0.7.3119.jar}"

To verify the plugin installation, go to Administration > Marketplace.

Uninstalling a plugin

To uninstall a plugin:

1. Delete the plugin from the <sonarqubeHome>/extensions/plugins folder.

2. Restart your SonarQube Server.