# SonarQube Server 10.5 documentation > You're in the SonarQube Server 10.5 documentation. This file lists the 216 pages for version 10.5 only. Every link points to a Markdown version of the page. ## Other versions and products - Page index for the whole site: https://docs.sonarsource.com/llms.txt - Full text of the whole site: https://docs.sonarsource.com/llms-full.txt - For another SonarQube Server version, replace 10.5 in the URL with that version, for example https://docs.sonarsource.com/sonarqube-server/2025.4/. - The latest SonarQube Server version has no version number in its URL: https://docs.sonarsource.com/sonarqube-server/ ## Get started - [Homepage](https://docs.sonarsource.com/sonarqube-server/10.5/readme.md): SonarQube 10.5 provides automated code quality and security reviews, delivering actionable intelligence that helps developers build better and faster. - [Try out SonarQube](https://docs.sonarsource.com/sonarqube-server/10.5/try-out-sonarqube.md): Follow these steps to try out SonarQube 10.5. ## Server installation and setup - [Server installation and setup](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/overview.md): Overview of how to set up and upgrade SonarQube 10.5. - [Installation requirements](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/installation-requirements.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/installation-requirements/overview.md): Find the general hardware and software requirements for the SonarQube 10.5 server and database hosts for the Community, Developer, and Enterprise Editions. - [Server host requirements and recommendations](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/installation-requirements/server-host.md): This section describes the requirements and recommendations for the machine running SonarQube 10.5. - [Database requirements](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/installation-requirements/database-requirements.md): SonarQube 10.5 supports the following database engines: Microsoft SQL Server, Oracle, and PostgreSQL. - [Perform pre-installation steps](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/pre-installation.md) - [On Linux systems](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/pre-installation/linux.md): This section explains pre-installation steps on the SonarQube 10.5 host for the Community, Developer and Enterprise Editions on Linux systems. - [On Unix-based systems](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/pre-installation/unix.md): This section explains pre-installation steps on the SonarQube 10.5 host for the Community, Developer and Enterprise Editions on Unix systems. - [On macOS systems](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/pre-installation/macos.md): This section explains pre-installation steps on the SonarQube 10.5 host for the Community, Developer and Enterprise Editions on macOS systems. - [Install the server](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server.md) - [Introduction](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server/introduction.md): Read this before starting the SonarQube 10.5 server installation. - [Installing the database](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server/installing-the-database.md): Install the SonarQube 10.5 database according to the database engine used: MicrosoftSQL Server, Oracle, PostgreSQL - [Installing SonarQube from the Docker image](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server/installing-sonarqube-from-docker.md): Explains how to install the SonarQube 10.5 server from the Docker image. - [Installing SonarQube from the ZIP file](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server/installing-sonarqube-from-zip-file.md): Explains how to install the SonarQube 10.5 server from the ZIP file. - [Advanced installation features](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server/advanced-installation-features.md): Explains how to perform advanced setup on SonarQube 10.5 server including web connection parameter change. - [Troubleshooting](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server/troubleshooting.md): Explains how to troubleshoot issues with SonarQube 10.5 server installation. - [Configure and operate a server](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/configure-and-operate-a-server.md) - [Operating the server](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/configure-and-operate-a-server/operating-the-server.md): Learn how to configure and operate the SonarQube 10.5 server. - [Environment variables](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/configure-and-operate-a-server/environment-variables.md): This page provides environment variables used for configuring SonarQube 10.5 with Docker. - [Install a plugin](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-a-plugin.md): Learn how to install a plugin in SonarQube 10.5. - [Install the server as a cluster](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/install-the-server-as-a-cluster.md): The Data Center Edition allows SonarQube 10.5 to run in a clustered configuration to make it resilient to failures. - [Configure and operate a cluster](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/configure-and-operate-a-cluster.md): Once the SonarQube 10.5 cluster is installed, your configuration allows your SonarQube instance to stay up even in case of a crash or failure in one of the nodes. - [Deploy on Kubernetes](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes.md) - [Deploying SonarQube](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/sonarqube.md): Learn how to deploy SonarQube 10.5 on Kubernetes. - [Deploying a SonarQube cluster](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/cluster.md): Learn how to deploy a SonarQube 10.5 cluster on Kubernetes. - [Setting up the monitoring](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/set-up-monitoring.md) - [Introduction](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/set-up-monitoring/introduction.md): If you deploy SonarQube 10.5 on Kubernetes, Prometheus metrics can be collected. - [Setting up with the Prometheus server](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/set-up-monitoring/prometheus.md): The SonarQube Helm chart triggers the deployment of a Prometheus server that will pull the metrics from the SonarQube 10.5 instance. - [Setting up with Datadog](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/set-up-monitoring/datadog.md): In case of a Kubernetes deployment, you can use Datadog to collect the metrics provided through the Web API of SonarQube 10.5 (Openmetrics format). - [List of Prometheus metrics](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/deploy-on-kubernetes/set-up-monitoring/prometheus-metrics.md): List of the SonarQube 10.5 metrics exposed by Prometheus. - [Upgrade the server](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server.md) - [Upgrade roadmap](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/roadmap.md): The section lists the steps you have to perform to upgrade your SonarQube server installation. This page is for SonarQube 10.5. - [Determining the upgrade path](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/determine-path.md): This section explains the principles to follow in order to determine if you can perform the upgrade directly or must upgrade first to intermediary version(s). This page is for SonarQube 10.5. - [Testing the upgrade](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/testing.md): Test your upgrade before performing the upgrade. This page is for SonarQube 10.5. - [Performing the upgrade](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/upgrade.md): Once you have determined your upgrade path and tested your upgrade, you can perform your SonarQube server upgrade. This page is for SonarQube 10.5. - [Performing the post-upgrade steps](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/post-upgrade-steps.md): You must perform various tasks after a SonarQube server upgrade. This page is for SonarQube 10.5. - [Other migration-related procedures](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/other-procedures.md): This section explains how to revert to the previous version of SonarQube, how to move to another edition, how to migrate the database to another vendor. This page is for SonarQube 10.5. - [Patched versions](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/upgrade-the-server/active-versions.md): A detailed explanation of the SonarQube release cycle and patch policy. This page is for SonarQube 10.5. - [Release upgrade notes](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/release-upgrade-notes.md): List of release upgrade notes for SonarQube 10.5. - [Troubleshooting](https://docs.sonarsource.com/sonarqube-server/10.5/setup-and-upgrade/troubleshooting.md): Try these troubleshooting methods if you’re encountering unexpected behaviors with your SonarQube 10.5 instance. ## Analyzing source code - [Analyzing source code](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/overview.md): SonarQube 10.5 can perform analysis on 20+ different languages. - [Scanner environment](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanner-environment.md) - [General requirements](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanner-environment/general-requirements.md): This page describes requirements or recommendations regarding the machine running the scanner and the actions you may need to take in order to meet them. This page is for SonarQube 10.5. - [Managing TLS certificates on client side](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanner-environment/install-self-signed-certificate.md): If your SonarQube 10.5 server is secured, you must add the self-signed certificate to CI/CD host. If mutual TLS is used then an additional setup is required. - [Scanners](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners.md) - [SonarScanner CLI](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner.md): The SonarScanner CLI analyzes code in CI/CD pipelines when no build-system-specific scanner exists. Distinct from the SonarQube CLI, a developer management interface. This page is for SonarQube 10.5. - [SonarQube extension for Azure DevOps](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarqube-extension-for-azure-devops.md): The SonarQube extension for Azure DevOps makes it easy to integrate analysis into your build pipeline, allowing the analysis of all supported languages. This page is for SonarQube 10.5. - [SonarQube extension for Jenkins](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/jenkins-extension-sonarqube.md): This extension lets you centralize the configuration of SonarQube server connection details in Jenkins global configuration. This page is for SonarQube 10.5. - [SonarScanner for .NET](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner-for-dotnet.md): The SonarScanner for .NET is the recommended way to launch an analysis for projects built using MSBuild or dotnet. This page is for SonarQube 10.5. - [SonarScanner for Maven](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner-for-maven.md): The SonarScanner for Maven is recommended as the default scanner for Maven projects. This page is for SonarQube 10.5. - [SonarScanner for Gradle](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner-for-gradle.md): The SonarScanner for Gradle provides an easy way to start the analysis of a Gradle project with SonarQube. This page is for SonarQube 10.5. - [SonarScanner for Ant](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner-for-ant.md): The SonarScanner for Ant provides a task to allow the integration of SonarQube analysis into an Apache Ant build script. This page is for SonarQube 10.5. - [SonarScanner for Python](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner-for-python.md): The SonarScanner for Python provides an easy way to start the analysis of a Python project with SonarQube. This page is for SonarQube 10.5. - [Analysis parameters](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/analysis-parameters.md): The most comprehensive listing of the parameters available in SonarQube 10.5. - [Languages](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/overview.md): SonarQube 10.5 provides analysis of different languages depending on the edition you’re running. - [ABAP](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/abap.md): ABAP analysis is available starting in Developer Edition of SonarQube 10.5. - [Apex](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/apex.md): Apex analysis is available starting in Enterprise Edition of SonarQube 10.5. - [Azure Resource Manager](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/azure-resource-manager.md): SonarQube 10.5 analysis supports Azure Resource Manager templates in the JSON & Bicep formats, and is available starting in Community Edition. - [C/C++/Objective-C](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/c-family.md): C/C++/Objective-C analysis in SonarQube 10.5 is available starting in Developer Edition. - [CloudFormation](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/cloudformation.md): SonarQube 10.5 can analyze Infrastructure-as-Code (IaC) languages such as CloudFormation, Kubernetes, and Terraform. - [COBOL](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/cobol.md): Cobol analysis in SonarQube 10.5 is available starting in Enterprise Edition. - [C#](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/csharp.md): C# analysis is available in all editions of SonarQube 10.5. - [Docker](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/docker.md): SonarQube 10.5 can analyze Infrastructure-as-Code (IaC) languages such as CloudFormation, Kubernetes, and Terraform. - [Flex](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/flex.md): Flex analysis is available starting in all editions of SonarQube 10.5. - [Go](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/go.md): Go analysis is available in all editions of SonarQube 10.5. - [HTML](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/html.md): HTML analysis is available in all editions of SonarQube 10.5. - [Java](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/java.md): Java analysis is available in all editions of SonarQube 10.5. - [JavaScript/TypeScript/CSS](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/javascript-typescript-css.md): JavaScript/TypeScript/CSS analysis is available in all editions of SonarQube 10.5. - [JCL](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/jcl.md): JCL analysis in SonarQube 10.5 is available starting in Enterprise Edition and supported by SonarLint for Eclipse when running in Connected Mode. - [Kotlin](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/kotlin.md): Kotlin analysis is available starting in all editions of SonarQube 10.5. - [Kubernetes/Helm](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/kubernetes.md): SonarQube 10.5 can analyze Infrastructure-as-Code (IaC) languages such as CloudFormation, Kubernetes, and Terraform. - [PHP](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/php-analysis.md): PHP analysis is available in all editions of SonarQube 10.5. - [PLI](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/pli.md): PL/I analysis in SonarQube 10.5 is available starting in Enterprise Edition. - [PL/SQL](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/pl-sql.md): PL/SQL analysis in SonarQube 10.5 is available starting in Developer Edition. - [Python](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/python.md): Python analysis is available in all editions of SonarQube 10.5. - [RPG](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/rpg.md): RPG analysis in SonarQube 10.5 is available starting in Enterprise Edition. - [Ruby](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/ruby.md): Ruby analysis is available in all editions of SonarQube 10.5. - [Scala](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/scala.md): Scala analysis is available in all editions of SonarQube 10.5. - [Swift](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/swift.md): Swift analysis in SonarQube 10.5 is available starting in Developer Edition. - [Secrets](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/secrets.md): SonarQube 10.5 detects exposed Secrets in your source code and language-agnostic config files, starting in Community Edition. - [Terraform](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/terraform.md): SonarQube 10.5 can analyze Infrastructure-as-Code (IaC) languages such as CloudFormation, Kubernetes, and Terraform. - [T-SQL](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/t-sql.md): T-SQL analysis in SonarQube 10.5 is available starting in Developer Edition. - [VB.NET](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/vb-dotnet.md): VB.NET analysis is available in all editions of SonarQube 10.5. - [VB6](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/vb6.md): VB6 analysis in SonarQube 10.5 is available starting in Enterprise Edition. - [XML](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/languages/xml.md): XML analysis is available in all editions of SonarQube 10.5. - [Test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/overview.md): In SonarQube 10.5, test coverage reports and test execution reports are important metrics in assessing the quality of your code. - [Java test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/java-test-coverage.md): SonarQube 10.5 supports the reporting of test coverage as part of the analysis of your Java project. - [JavaScript/TypeScript test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/javascript-typescript-test-coverage.md): SonarQube 10.5 supports the reporting of test coverage information as part of the analysis of your JS/TS project. - [.NET test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/dotnet-test-coverage.md): SonarQube 10.5 supports the reporting of test coverage information as part of the analysis of your .NET project. - [Python test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/python-test-coverage.md): SonarQube 10.5 supports the reporting of test coverage information as part of the analysis of your Python project. - [PHP test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/php-test-coverage.md): SonarQube 10.5 supports the reporting of test coverage information as part of the analysis of your PHP project. - [C/C++/Objective-C test coverage](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/c-family-test-coverage.md): SonarQube 10.5 supports the reporting of test coverage information as part of the analysis of your C/C++/Objective-C project. - [Generic test data](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/generic-test-data.md): SonarQube 10.5 supports generic formats for test coverage and test execution import. - [Test coverage parameters](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/test-coverage-parameters.md): In SonarQube 10.5, test coverage reports describe the percentage of your code that has been tested by your test suite during a build. - [Test execution parameters](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/test-coverage/test-execution-parameters.md): In SonarQube 10.5, test execution reports describe which tests within your test suite have been run during a build. - [Importing external issues](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/importing-external-issues.md) - [External analyzer reports](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/importing-external-issues/external-analyzer-reports.md): This page lists SonarQube 10.5 analysis parameters related to the import of issues raised by external, third-party analyzers. - [Generic issue import format](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/importing-external-issues/generic-issue-import-format.md): SonarQube 10.5 supports a generic import format for raising external issues in code. - [SARIF reports](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/importing-external-issues/importing-issues-from-sarif-reports.md): SonarQube 10.5 supports the standard Static Analysis Results Interchange Format (SARIF) for raising external issues in code. - [Background tasks](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/background-tasks.md): In SonarQube 10.5, a background task can be: the import of an analysis report, the computation of a portfolio, or the import or export of a project. - [Pull request analysis](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/pull-request-analysis.md): Pull request analysis shows your pull request’s quality gate and analysis in the SonarQube 10.5 interface. - [Branches](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/branches.md) - [Branch analysis](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/branches/branch-analysis.md): With branch analysis in SonarQube 10.5, you can ensure that you’re maintaining consistent code quality all the way down to the branch level of your projects. - [Branch FAQ](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/branches/branch-faq.md): Frequently asked questions about branch analysis in SonarQube 10.5. - [CI integration](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/overview.md): SonarQube 10.5 supports integration on multiple platforms allowing you to maintain code quality and security in your projects. - [Jenkins integration](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/jenkins-integration.md) - [Key features](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/jenkins-integration/key-features.md): Sonar provides an extension for Jenkins to enable smooth integration with Jenkins. This section explains the key features of this integration. This page is for SonarQube 10.5. - [Setting up Jenkins](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/jenkins-integration/global-setup.md): This page explains how to set up Jenkins globally for the integration with SonarQube 10.5 by using SonarQube extension for Jenkins. - [Adding analysis to a Jenkins job](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/jenkins-integration/add-analysis-to-job.md): This section explains how to add the SonarQube 10.5 analysis to your Jenkins Freestyle or Pipeline jobs. - [Setting up a pipeline pause](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/jenkins-integration/pipeline-pause.md): To configure an automatic failing of your Jenkins pipeline in case the quality gate computed by SonarQube 10.5 fails, you must set up a pipeline pause. - [Codemagic integration](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/ci-integration/codemagic-integration.md): SonarScanners running in Codemagic can automatically detect branches and merge or pull requests in certain jobs. This page is for SonarQube 10.5. - [SCM integration](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scm-integration.md): Collecting SCM data during code analysis can unlock a number of SonarQube 10.5 features. - [Security engine custom configuration](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/security-engine-custom-configuration.md): Security Engine Custom Configuration in SonarQube 10.5 is available as part of the Enterprise Edition. The security engine tracks the path that data follows through your code. - [Troubleshooting the analysis](https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/troubleshooting-the-analysis.md): If your SonarQube 10.5 analysis errors out. ## DevOps platform integration - [DevOps platform integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration.md) - [GitHub integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/github-integration.md) - [Introduction](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/github-integration/introduction.md): The integration of SonarQube 10.5 with GitHub Enterprise and GitHub.com allows you to maintain code quality and security in your GitHub repositories. - [Setting up the GitHub integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/github-integration/setting-up-global-integration.md): This section explains how to set up the GitHub integration for SonarQube 10.5. - [Adding analysis to GitHub Actions workflow](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/github-integration/adding-sonarqube-analysis-to-your-workflow.md): SonarScanners running in GitHub Actions can automatically detect branches and pull requests being built. This page is for SonarQube 10.5. - [Setting up your projects](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/github-integration/setting-up-your-projects.md): After creating and installing your GitHub App, SonarQube 10.5 can report your quality gate status and metrics directly to your GitHub branches and pull requests. - [If you're using a monorepo](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/github-integration/monorepo.md): This section explains how to manage the SonarQube 10.5 analysis of GitHub projects related to a monorepo. - [Bitbucket integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/bitbucket-integration.md) - [Bitbucket Server integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/bitbucket-integration/bitbucket-server-integration.md): The integration of SonarQube 10.5 with Bitbucket Server allows you to maintain code quality and security in your Bitbucket Server repositories. - [Bitbucket Cloud integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/bitbucket-integration/bitbucket-cloud-integration.md): The integration of SonarQube 10.5 with Bitbucket Cloud allows you to maintain code quality and security in your Bitbucket Cloud repositories. - [GitLab integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/gitlab-integration.md): The integration of SonarQube 10.5 with GitLab Self-Managed and GitLab.com allows you to maintain code quality and security in your GitLab projects. - [Azure DevOps integration](https://docs.sonarsource.com/sonarqube-server/10.5/devops-platform-integration/azure-devops-integration.md): The integration of SonarQube 10.5 with Azure DevOps allows you to maintain code quality and security in your Azure DevOps repositories. ## User guide - [User guide](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide.md) - [Concepts](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/concepts.md): An overview of the key concepts used within SonarQube 10.5. - [Software qualities](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/software-qualities.md): Software qualities describe the key attributes of high-quality code: secure, reliable, and maintainable. This page is for SonarQube 10.5. - [Improving code quality](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/clean-as-you-code.md): SonarQube 10.5 helps developers and organizations improve code quality by focusing on code that's added or changed. - [SonarLint Connected Mode](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/sonarlint-connected-mode.md): SonarLint Connected Mode connects SonarLint to your SonarQube 10.5 project and provides additional benefits you will not get by using SonarLint or SonarQube alone. - [Metric definitions](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/metric-definitions.md): SonarQube 10.5 analysis produces many types of code analysis metrics. - [Quality gates](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/quality-gates.md): Quality gates in SonarQube 10.5 enforce a quality policy in your organization by answering one question: is my project ready for release? - [Rules](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/rules.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/rules/overview.md): SonarQube 10.5 evaluates your source code against its set of rules to generate issues. - [Security-related rules](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/rules/security-related-rules.md): The SonarQube 10.5 Quality Model has four different types of rules: Reliability (bug), Maintainability (code smell), Security (vulnerability and hotspot) rules. - [Built-in rule tags](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/rules/built-in-rule-tags.md): SonarQube 10.5 users can add tags to rules and issues and most rules have some built-in tags out of the box. - [User account](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/user-account.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/user-account/overview.md): As a SonarQube 10.5 user, you have your own space where you can see the things that are relevant to you. - [Generating and using tokens](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/user-account/generating-and-using-tokens.md): In SonarQube 10.5, users can generate tokens that can be used to run analyses or invoke web services without access to the user’s actual credentials. - [Issues](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/issues.md): While running an analysis, SonarQube 10.5 raises an issue every time a piece of code breaks a coding rule. - [Security Hotspots](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/security-hotspots.md): In SonarQube 10.5, a security hotspot highlights a security-sensitive piece of code that the developer needs to review. - [Portfolios](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/portfolios.md): The SonarQube 10.5 portfolios home page is the central place for managers and tech leads to keep an eye on the releasability of the projects under their supervision. - [Applications](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/applications.md): In SonarQube 10.5, an application aggregates multiple projects into a synthetic single project. - [Security Reports](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/security-reports.md): SonarQube 10.5 security reports give you the big picture of your application’s security. They allow you to know where you stand compared to the most common security mistakes. - [Activity and history](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/activity-and-history.md): The Activity page in SonarQube 10.5 offers you the ability to see the evolution of project measures over time. - [Project page](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/project-page.md): The SonarQube 10.5 Project homepage is the entry point of any project showing the releasability status of the project, its current code quality, and the code quality to date. - [Keyboard shortcuts](https://docs.sonarsource.com/sonarqube-server/10.5/user-guide/keyboard-shortcuts.md): A list of keyboard shortcuts for use with SonarQube 10.5. ## Project administration - [Project administration](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration.md) - [Creating and importing projects](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/creating-and-importing-projects.md): How to create and import projects in SonarQube 10.5. - [Managing monorepo projects](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/monorepos.md): This section explains the simplified management of projects related to a monorepo. This feature is supported in SonarQube 10.5 with GitHub and GitLab repositories. - [Managing project history](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/managing-project-history.md): One of the most powerful features of SonarQube 10.5 is that it shows you not just your project health today, but how it has changed over time. - [Analysis scope](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/analysis-scope.md): In SonarQube 10.5, there are many cases where you do not want to analyze every source file in your project. In such cases, you can adjust the analysis scope. - [New code settings](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/clean-as-you-code-settings.md) - [Defining new code](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/clean-as-you-code-settings/defining-new-code.md): Defining what is considered new code is an important part of the approach to improving code quality and safety in SonarQube 10.5. - [Managing portfolios](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/managing-portfolios.md): This page has information on managing and setting up portfolios in SonarQube 10.5. - [Managing applications](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/managing-applications.md): This page explains how to manage SonarQube 10.5 applications. - [PDF reports](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/pdf-reports.md): In SonarQube 10.5, PDF reports give a periodic, high-level overview of the overall code quality and security of your projects, applications, or portfolios. - [Project settings](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/project-settings.md): In SonarQube 10.5, project administration is accessible through the Project Settings menu of each project. - [Webhooks](https://docs.sonarsource.com/sonarqube-server/10.5/project-administration/webhooks.md): Webhooks in SonarQube 10.5 notify external services when a project analysis is complete. ## Instance administration - [Instance administration](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration.md) - [Quality profiles](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/quality-profiles.md): Quality profiles are a key part of your SonarQube 10.5 configuration. They define the set of rules to be applied during code analysis. - [Security](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/security.md): SonarQube 10.5 comes with a number of global security features. - [Authentication and provisioning](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/overview.md): SonarQube 10.5 can delegate authentication via HTTP Headers, GitHub Authentication, GitLab Authentication, Bitbucket Cloud Authentication, SAML, or LDAP. - [HTTP header](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/http-header.md): In SonarQube 10.5, you can delegate user authentication to third-party systems (proxies/servers) using HTTP header authentication. - [LDAP](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/ldap.md): You can configure SonarQube 10.5 authentication and authorization to an LDAP server (including the LDAP service of Active Directory) - [SAML](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/overview.md): You can delegate authentication to a SAML 2.0 identity provider using SAML authentication. SonarQube 10.5 uses the Service Provider (SP) initiated SAML. - [How to setup Azure AD](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/how-to-set-up-azure-ad.md): The following content may be useful if you’re using Azure AD as a SAML Identity Provider with SonarQube 10.5. - [How to set up Keycloak](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/how-to-set-up-keycloak.md): The following content may be useful if you’re using Keycloak as a SAML identity provider with SonarQube 10.5. - [How to set up Okta](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/how-to-set-up-okta.md): The following example may be useful if you are using Okta as a SAML identity provider with SonarQube 10.5. - [SCIM](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/scim.md) - [Overview](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/scim/overview.md): SCIM helps you automatically provision user and groups to SonarQube 10.5. - [SCIM provisioning with Azure AD](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/scim/scim-provisioning-with-azure-ad.md): Enable SCIM to automate user and group provisioning from Azure AD to SonarQube 10.5 - [SCIM provisioning with Okta](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/saml/scim/scim-provisioning-with-okta.md): Enable SCIM to automate user and group provisioning from Okta to SonarQube 10.5 - [GitHub](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/github.md): In SonarQube 10.5, to allow users to log in with GitHub credentials, you must use a GitHub App. - [Bitbucket Cloud](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/bitbucket-cloud.md): To allow users to log in with Bitbucket Cloud credentials, you need to use an OAuth consumer and set the authentication settings in SonarQube 10.5. - [GitLab](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/authentication/gitlab.md): In SonarQube 10.5, you can delegate authentication to GitLab using a dedicated GitLab OAuth application. - [Look and feel](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/look-and-feel.md): In SonarQube 10.5, you can set your own home logo and use a Gravatar avatar. - [Marketplace](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/marketplace.md): The Marketplace is the place for keeping the pieces of the SonarQube platform up to date. This page is for SonarQube 10.5. - [Plugin version matrix](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/plugin-version-matrix.md): This table describes the version of each plugin that is compatible with each version of SonarQube. This page is for SonarQube 10.5. - [Housekeeping](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/housekeeping.md): Default settings for the SonarQube 10.5 database cleaner. - [Monitoring](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/monitoring.md) - [Instance monitoring](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/monitoring/instance.md): Monitor your SonarQube 10.5 instance to keep it healthy and happy. - [Lines of Code](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/monitoring/lines-of-code.md): Information about how SonarQube 10.5 calculates the Lines of Code analyzed to measure against the subscription’s limit defined by the license. - [Audit logs](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/monitoring/audit-logs.md): How to manage the trail of your SonarQube 10.5 audit logs. - [API deprecation](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/monitoring/api-deprecation.md): If you use custom plugins based on the plugin API or consume SonarQube 10.5 services, you should monitor the deprecation of the APIs. - [Server logs and system info](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/server-logs-and-system-info.md): How to gather detailed information about your SonarQube 10.5 instance. - [Notifications](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/notifications.md): Everything to know about configuring SonarQube 10.5 email notifications. - [License administration](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/license-administration.md): How to retrieve, setup, stage and request new SonarQube licenses. This page is for SonarQube 10.5. - [Project move](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/project-move.md): Project Move in SonarQube 10.5 allows you to export a project from one instance and import it into another. - [Improving performance](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/improving-performance.md): How to improve the performance of your SonarQube 10.5 instance. - [SonarQube DB Copy Tool](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/sonarqube-db-copy-tool.md): The SonarQube 10.5 database copy tool helps you migrate your database between vendors. - [Backup and restore](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/backup-and-restore.md): We recommend using your database’s tools to back up your SonarQube 10.5 data. - [Reindexing](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/reindexing.md): Starting SonarQube after an upgrade or after a restore from a backup triggers a rebuild of the Elasticsearch indexes. This page is for SonarQube 10.5. - [Telemetry](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/telemetry.md): SonarQube 10.5 sends anonymized telemetry data to Sonar daily. No personally identifiable information is sent. - [Custom messages](https://docs.sonarsource.com/sonarqube-server/10.5/instance-administration/custom-messages.md): Administrators using the Enterprise edition of SonarQube 10.5 can now display a custom login message that all users will see on their login screen. ## Extension Guide - [Extension Guide](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide.md) - [Web API](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/web-api.md): SonarQube 10.5 provides the Web API to access its functionalities from applications. - [Adding coding rules](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/adding-coding-rules.md): How to add custom coding rules to your SonarQube 10.5 analysis. - [Developing a plugin](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/developing-a-plugin.md) - [Plugin basics](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/developing-a-plugin/plugin-basics.md): The sonar-plugin-api is a Java API used to develop plugins for SonarQube, SonarCloud and SonarLint. This page is for SonarQube 10.5. - [Supporting new languages](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/developing-a-plugin/supporting-new-languages.md): Six steps to support new languages in SonarQube 10.5. - [Executable lines](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/developing-a-plugin/executable-lines.md): Sonar internal guidelines to define executable lines for a language in SonarQube 10.5. - [Adding pages to the webapp](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/developing-a-plugin/adding-pages-to-the-webapp.md): Creating page extensions to run in your SonarQube 10.5 environment. - [Supporting SCM providers](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/developing-a-plugin/supporting-scm-providers.md): Information from the Source Code Management (SCM) provider is used by the SonarQube scanner. This page is for SonarQube 10.5. - [Internationalization](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/internationalization.md): Guidelines to apply the i18n mechanism in SonarQube 10.5 and how to help the Community - [Contributing](https://docs.sonarsource.com/sonarqube-server/10.5/extension-guide/contributing.md): Guidelines about giving feedback and using the SonarQube 10.5 community forum.