Installing a plugin

Learn how to install a plugin in SonarQube Community Build.

There are two ways to install plugins in SonarQube Community Build:

• Marketplace: You can automatically install plugins from the Administration > Marketplace tab. See Using Marketplace.

• Manual Installation: You can manually install plugins if your SonarQube Community Build instance doesn’t have internet access, or if the plugin you’re installing isn’t in the SonarQube Marketplace.

If your SonarQube instance doesn’t have internet access, use the Plugin version matrix to see what plugins are available and which version is appropriate for your instance. Otherwise, you can use the Marketplace.

Plugins are not provided by Sonar; therefore, you install them at your own risk. A SonarQube Community Build administrator needs to acknowledge this risk in the Marketplace before installing plugins or when prompted in SonarQube Community Build after installing a plugin manually.

Manually installing a plugin

ZIP INSTALLATION

• 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.

DOCKER INSTALLATION

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 Installation overview article in our documentation for more details about creating the volume and container.

Once SonarQube UI is up, you can encrypt sensitive properties stored in <sonarqubeHome>/conf/sonar.properties. See Sensitive settings.

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 in Basic installation, the resulting plugin will be available in the sonarqube_extensions volume, which is attached to the <SONARQUBE_HOME>/extensions/plugins folder.

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.

Related pages

• Starting / stopping server (ZIP installation)

• Starting SonarQube container