# GitHub

To allow users to log in with GitHub credentials, you must use a GitHub App. We highly recommend that you set up a dedicated one.

### Creating a dedicated app for authentication <a href="#creating-a-dedicated-app-for-authentication" id="creating-a-dedicated-app-for-authentication"></a>

If you want to use a dedicated app for GitHub authentication, you can create a GitHub OAuth app. You’ll find general instructions for creating a GitHub OAuth App [here](https://docs.github.com/en/free-pro-team@latest/developers/apps/creating-an-oauth-app). Specify the following settings in your OAuth App:

* **Homepage URL** – the public URL of your SonarQube server. For example, `https://sonarqube.mycompany.com`. For security reasons, HTTP is not supported, and you must use HTTPS. The public URL is configured in SonarQube at **Administration > General > Server base URL**.
* **Authorization callback URL** – your instance’s base URL. For example, `https://yourinstance.sonarqube.com`.

### Setting your authentication settings in SonarQube <a href="#setting-your-authentication-settings-in-sonarqube" id="setting-your-authentication-settings-in-sonarqube"></a>

Navigate to **Administration > Configuration > General Settings > Authentication > GitHub Authentication** and update the following:

1. **Enabled** – set the switch to `true`.
2. **Client ID** – the client ID is found below the GitHub App ID on your GitHub App’s page.
3. **Client Secret** – the client secret is found below the client ID on your GitHub App’s page.

Now, from the login page, your users can connect their GitHub accounts with the new **Log in with GitHub** button.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sonarsource.com/sonarqube-server/9.8/instance-administration/authentication/github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.