Install a plugin

Learn how to install a plugin in SonarQube Server.

There are two ways to install plugins in SonarQube Server:

• Marketplace: With SonarQube Community Build, you can automatically install plugins from the Administration > Marketplace tab. With SonarQube Server 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 Server. You can also manually install plugins if your SonarQube Server instance doesn’t have internet access, or if the plugin you’re installing isn’t in the SonarQube Server Marketplace.

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 plugins from the marketplace

For SonarQube Server, you need to manually install and update plugins. You can only install and update plugins from the Marketplace in SonarQube Community Build.

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 Using Marketplace for more details on how to configure your SonarQube Community Build 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 Server 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 Server under Docker, any plugin you want to install must also be copied into the Docker volume you create during installation. See the Installing SonarQube Server from the Docker image article in our documentation for more details about creating the volume and container.

Manually install a plugin in a SonarQube Server docker container

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

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