> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/sonarqube-server/10.8/analyzing-source-code/overview.md).

# Project analysis setup

This page introduces briefly the prerequisites and the setup steps necessary for a project analysis with SonarQube Server 10.8.

{% hint style="info" %}
**For AI agents:** You're in the SonarQube Server 10.8 documentation. For a list of all 10.8 pages, see the [SonarQube Server 10.8 page index](https://312504542-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiJj3TXBdWssTGGg8qK5I%2Fuploads%2FmeJ1nVNGPezOurNrTy4A%2Fsonarqube-server-10.8-llms.txt?alt=media). For the whole site, see the [page index](https://docs.sonarsource.com/llms.txt) or the [full text](https://docs.sonarsource.com/llms-full.txt). For another version, replace 10.8 in the URL with that version. The [latest version](https://docs.sonarsource.com/sonarqube-server/) has no version number in its URL.
{% endhint %}

This page introduces briefly the prerequisites and the setup steps necessary for a project analysis.

For an overview of the analysis process, see the [SonarQube Server analysis overview](/sonarqube-server/10.8/analyzing-source-code/analysis-overview.md) page.

## Prerequisites and recommendations <a href="#prerequisites" id="prerequisites"></a>

<details>

<summary>SonarQube Server is integrated with your DevOps platform / CI tool</summary>

It is highly recommended that you integrate SonarQube Server with your DevOps platform or CI tool. See:

* [Introduction](/sonarqube-server/10.8/devops-platform-integration/github-integration/setting-up-at-global-level/introduction.md)
* [Setting up integration at global level](/sonarqube-server/10.8/devops-platform-integration/gitlab-integration/global-setup.md)
* [Bitbucket Server & Data Center](/sonarqube-server/10.8/devops-platform-integration/bitbucket-integration/bitbucket-server-integration.md)
* [Bitbucket Cloud integration](/sonarqube-server/10.8/devops-platform-integration/bitbucket-integration/bitbucket-cloud-integration.md)
* [Azure DevOps integration](/sonarqube-server/10.8/devops-platform-integration/azure-devops-integration.md)
* [Setting up Jenkins](/sonarqube-server/10.8/analyzing-source-code/ci-integration/jenkins-integration/global-setup.md)

</details>

<details>

<summary>The SonarScanner is installed on the CI/CD host</summary>

The [SonarQube Server analysis overview](/sonarqube-server/10.8/analyzing-source-code/analysis-overview.md) must be installed on the CI/CD host. You must install the scanner that is most appropriate for your needs depending on your build system: Gradle, Maven, .NET, NPM, or Python. For other project types, use the SonarScanner CLI which requires more manual configuration.

For installation requirements, see [General requirements](/sonarqube-server/10.8/analyzing-source-code/scanners/scanner-environment/general-requirements.md).

For installation instructions, see the corresponding SonarScanner section: [SonarScanner for Maven](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-maven.md), [SonarScanner for Gradle](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-gradle.md), [Installing the scanner](/sonarqube-server/10.8/analyzing-source-code/scanners/dotnet/installing.md), [Installing the scanner](/sonarqube-server/10.8/analyzing-source-code/scanners/npm/installing.md), [SonarScanner for Python](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-python.md), or [SonarScanner CLI](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner.md).

{% hint style="info" %}
[SCM integration](/sonarqube-server/10.8/analyzing-source-code/scm-integration.md) used during the analysis will be automatically imported from Git and SVN. Other providers require additional plugins.
{% endhint %}

</details>

## Creating your SonarQube Server project <a href="#creating-sq-project" id="creating-sq-project"></a>

Your project repository is represented in SonarQube Server by a project.

You can create a SonarQube Server project in the SonarQube Server UI before starting the first project analysis. Or you can start your first project analysis to automatically create the SonarQube Server project on the server (SonarQube Server creates automatically a new project if the received project key does not exist in its database).

To create a project, see [Creating and importing projects](/sonarqube-server/10.8/project-administration/creating-and-importing-projects.md).

## Integrating the SonarQube Server analysis into your CI or build pipeline <a href="#integrating-into-ci-or-build" id="integrating-into-ci-or-build"></a>

To integrate the SonarQube Server analysis into your CI pipeline, see the corresponding section:

* Jenkins: [Adding analysis to a Jenkins job](/sonarqube-server/10.8/analyzing-source-code/ci-integration/jenkins-integration/add-analysis-to-job.md)
* GitHub Actions: [Adding analysis to GitHub Actions workflow](/sonarqube-server/10.8/devops-platform-integration/github-integration/adding-analysis-to-github-actions-workflow.md)
* GitLab CI/CD: [Adding analysis to GitLab CI/CD pipeline](/sonarqube-server/10.8/devops-platform-integration/gitlab-integration/adding-analysis-to-gitlab-ci-cd.md)
* [Azure DevOps integration](/sonarqube-server/10.8/devops-platform-integration/azure-devops-integration.md)
* [Bitbucket Cloud integration](/sonarqube-server/10.8/devops-platform-integration/bitbucket-integration/bitbucket-cloud-integration.md)

To integrate the SonarQube Server analysis into your build pipeline, see the scanner invoking instructions in the corresponding section: [SonarScanner for Maven](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-maven.md), [SonarScanner for Gradle](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-gradle.md), [Using the scanner](/sonarqube-server/10.8/analyzing-source-code/scanners/dotnet/using.md), [Using the scanner](/sonarqube-server/10.8/analyzing-source-code/scanners/npm/using.md), [SonarScanner for Python](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-python.md), or [SonarScanner CLI](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner.md).

For general information about SonarQube Server integration with a CI or build pipeline, see [SonarQube Server analysis overview](/sonarqube-server/10.8/analyzing-source-code/analysis-overview.md).

## Adjusting the analysis of your project <a href="#adjusting-analysis" id="adjusting-analysis"></a>

The analysis performed by the SonarScanner is configured through analysis parameters. The following applies:

* A few analysis parameters are mandatory.
* Many analysis parameters, such as those defining the analysis scope, have a default value and can be adjusted.
* Analysis parameters allow you to include the code and test coverage in your analysis, or to import issues generated by a third-party analyzer, etc.

SonarQube Server manages the analysis parameters through sonar properties (The sonar property key has the following syntax: `sonar.<property>`.).

You can configure the analysis parameters in different places. For more information, see [Analysis parameters](/sonarqube-server/10.8/analyzing-source-code/analysis-parameters.md) and the respective SonarScanner section: [SonarScanner for Maven](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-maven.md), [SonarScanner for Gradle](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-gradle.md), [Using the scanner](/sonarqube-server/10.8/analyzing-source-code/scanners/dotnet/using.md), [Configuring the scanner](/sonarqube-server/10.8/analyzing-source-code/scanners/npm/configuring.md), [SonarScanner for Python](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-python.md), or [SonarScanner CLI](/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner.md).

You can:

* Include the code and test coverage in your analysis: see [Overview](/sonarqube-server/10.8/analyzing-source-code/test-coverage/overview.md).
* Adjust the analysis scope: see [Analysis scope](/sonarqube-server/10.8/project-administration/analysis-scope.md).
* Import issues generated by third-party analyzers: see the [External analyzer reports](/sonarqube-server/10.8/analyzing-source-code/importing-external-issues/external-analyzer-reports.md) section.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sonarsource.com/sonarqube-server/10.8/analyzing-source-code/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.