Installing a plugin

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

• Marketplace: You can automatically install plugins from the Administration > Marketplace tab. See Using the 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.

Manually installing a plugin

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. 

Uninstalling a plugin

To uninstall a plugin:

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

Installing a plugin under Docker

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

Let’s assume that your SonarQube Community Build 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 Community Build 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.