> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/software-engineering-insights/use-software-engineering-insights/setup-sei/configure-integrations/beta-integrations/sonarqube/sei-sonar-self-managed.md).

# Connect with SonarQube Server

To integrate SEI with on-premises SonarQube instances, you must use an Ingestion Satellite. The configuration steps for this integration are similar to those for SonarQube Cloud, with the key difference being the use of the satellite for communication with the SonarQube server.

The following settings are applicable to SonarQube Server.

#### Requirements <a href="#requirements" id="requirements"></a>

Setting up the SEI SonarQube Server integration requires a **SonarQube API Token**, and the user creating the token must have **Administer System** permissions.

To configure permissions in SonarQube, go to **Administration**, then **Security**, and then **Global Permissions**. Due to the scope of access required, consider using a managed service account, rather than a personal user account, to create the token.

For instructions on creating API tokens, see the [official SonarQube documentation](https://docs.sonarsource.com/sonarqube/9.7/user-guide/user-account/generating-and-using-tokens/). Copy the key somewhere that you can retrieve it when you configure the integration.

#### Add the integration <a href="#add-the-integration" id="add-the-integration"></a>

1. In your **Harness Project**, go to the **SEI Module**, and select **Account**.
2. Select **Integrations** under **Data Settings**.
3. Select **Available Integrations**, locate the **SonarQube** integration, and select **Install**.
4. Configure the following fields:
   * **URL:** Enter the URL of the server where SonarQube is running. For SonarCloud, enter `https://sonarcloud.io`.
   * **Username:** The email address of the user that created the token in SonarQube.
   * **API Key:** Enter the SonarQube API token.
   * **Organization:** Enter your SonarQube **Organization Name**. For SonarCloud, you can find your organization name under **My Account**. Note that **Organization Key** is different from the **Organization Name**.
   * **Project Keys:** Enter one or more project keys to ingest. If you want SEI to ingest all projects, leave this field empty. Project keys are case sensitive.
   * **Name:** Enter a name for the integration.
   * **Description** and **Tags** are optional.
5. Save the integration.
6. Click **Download YAML file** to download the satellite configuration file. The `satellite.yml` file will be automatically generated and downloaded to your computer. For instructions on updating this file, see [Ingestion Satellite](/software-engineering-insights/use-software-engineering-insights/setup-sei/sei-ingestion-satellite/satellite-overview.md).

Here’s a sample `satellite.yml` file:

```yaml
satellite:
  tenant: <ACCOUNT_ID>
  api_key: <ACCOUNT_API_KEY>
  url: 'https://app.harness.io/gratis/sei/api' 
  # Note that this URL is relative to the Environment of your Harness Account.

integrations:
  - id: '<INTEGRATION_ID>'
    application: sonarqube
    url: '<SONARQUBE_URL>'
    username: <SONARQUBE_USERNAME>
    api_key: <SONARQUBE_API_KEY>
    metadata:
      organization: <SONARQUBE_ORG_NAME>
      project_keys: <SONARQUBE_PROJECT_KEYS>
```

If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the [Ingestion Satellite Troubleshooting and FAQs](/software-engineering-insights/use-software-engineering-insights/setup-sei/sei-ingestion-satellite/satellite-troubleshooting-and-faqs.md).

#### Supported metadata <a href="#supported-metadata" id="supported-metadata"></a>

|                       |         |                                                                                                                                                                                                                                                                                                                                     |
| --------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Metadata              | Type    | Description                                                                                                                                                                                                                                                                                                                         |
| allow\_unsafe\_ssl    | Boolean | Allows users to bypass SSL verification for custom certificates authorized by the SonarQube server                                                                                                                                                                                                                                  |
| use\_privileged\_APIs | Boolean | Set to True to enable the use of privileged APIs, which are required when all project data is not visible. This requires the API key to have the **Administer System** permission in SonarQube. For more information, see the [official SonarQube documentation](https://next.sonarqube.com/sonarqube/web_api/api/projects/search). |