Skip to content

docs: update images for google SSO #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: docv2-site
Choose a base branch
from
Open

docs: update images for google SSO #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d640f94
docs: update images for google SSO
Hii-Arpit Nov 10, 2025
8c778dc
docs: removed vs code entries
Hii-Arpit Nov 11, 2025
e551ee8
docs: removed .vscode files
Hii-Arpit Nov 11, 2025
13354fd
docs: updated github sso snapshots and refined text
Hii-Arpit Nov 11, 2025
5a4dc98
docs: updated gitlab sso snapshots and refined text
Hii-Arpit Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*

checkEmptyOrHeadingFiles.mjs
checkEmptyOrHeadingFiles.mjsgit
26 changes: 15 additions & 11 deletions docs/user-guide/global-configurations/authorization/sso/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,20 @@ Getting the redirectURI from Devtron is a crucial component of the authenticatio

1. Navigate to **Global Configurations** → **Authorization** → **SSO Login Services**. The SSO Login Service page is displayed.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/github/sso-login-services-2.jpg)
<center>Figure 1: Get the redirectURI</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/github/github-sso-select-github.jpg)
<center>Figure 1: Select Github</center>

2. Select **GitHub** from the list of available SSO login services.

3. Click the URL suggested in green color next to the **Click to use** label to update the **URL** field. Update the **URL** field only if the host URL displayed in the **URL** field is incorrect.
3. Click the URL suggested in green color next to the **Click to use** label to update the **URL** field.

4. Click the **Update** button.
When you populate **URL** field, the redirectURI (or callbackURI) is updated automatically in the purple block displayed at the top of the SSO Login Service screen. This redirectURI is essential, as it is required while setting up the OAuth credentials in GitHub.

4. Copy the redirectURI from the purple block.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/github/github-sso-redirect-uri.jpg)
<center>Figure 2: Copy Redirect URI</center>

When you populate the Host URL in the **URL** field, the redirectURI (or callbackURI) is updated automatically in the purple block displayed at the top of the SSO Login Service screen. This redirectURI is essential, as it is required while setting up the OAuth credentials in GitHub.

---

Expand All @@ -46,8 +50,8 @@ Open Authentication (OAuth) allows you to authorize one application to sign in t

2. Select your preferred OAuth app and click **Edit**.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/github/oauth-application.jpg)
<center>Figure 2: Client ID and Client Secret</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/github/github-sso-oauth-application.jpg)
<center>Figure 3: Client ID and Client Secret</center>

3. Click the **Generate a new client secret** button to create a new client secret. The client secret is created and displayed in the **Client Secrets** section. The Client ID is created by default and can be found in the **Client ID** field.

Expand All @@ -67,8 +71,8 @@ To configure the GitHub SSO in Devtron, follow the below steps of instructions:

2. Select the **Configuration** section available below the **URL** field.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/github/configuration-section-2.jpg)
<center>Figure 3: Configuration Section</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/github/github-sso-config.jpg)
<center>Figure 4: Configuration Section</center>

3. Update the `clientID` attribute with the Client ID generated in the OAuth application on GitHub.

Expand All @@ -78,8 +82,8 @@ To configure the GitHub SSO in Devtron, follow the below steps of instructions:

6. Click **Update** to save the configuration. GitHub SSO is now successfully configured.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/github/github-sso-final.gif)
<center>Figure 4: Sign in with GitHub</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/github/github-sso-in-action.jpg)
<center>Figure 5: Sign in with GitHub</center>

---

Expand Down
29 changes: 16 additions & 13 deletions docs/user-guide/global-configurations/authorization/sso/gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,19 @@ Getting the redirectURI from Devtron is a crucial component of the authenticatio

1. Navigate to **Global Configurations** → **Authorization** → **SSO Login Services**. The SSO Login Service page is displayed.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/gitlab/gitlab-sso.jpg)
<center>Figure 1: Global Configurations</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/gitlab/gitlab-sso-select-gitlab.jpg)
<center>Figure 1: Select Gitlab</center>

2. Select **GitLab** from the list of available SSO login services.

3. Click the URL suggested in green color next to the **Click to use** label to update the **URL** field. Update the **URL** field only if the host URL displayed in the **URL** field is incorrect.
3. Click the URL suggested in green color next to the **Click to use** label to update the **URL** field.

4. Click the **Save** button.
When you populate **URL** field, the redirectURI (or callbackURI) is updated automatically in the purple block displayed at the top of the SSO Login Service screen. This redirectURI is essential, as it is required while setting up the OAuth credentials in GitHub.

When you populate the Host URL in the **URL** text box, the redirectURI (or callbackURI) is updated automatically in the purple block at the top of the SSO Login Service screen. This redirectURI is essential, as it is required while setting up the OAuth credentials in GitLab.
4. Copy the redirectURI from the purple block.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/gitlab/gitlab-sso-redirect-uri.jpg)
<center>Figure 2: Copy Redirect URI</center>

---

Expand All @@ -48,17 +51,17 @@ Open Authentication (OAuth) allows you to authorize one application to sign in t

2. Select your preferred OAuth app and click **Edit**.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/gitlab/gitlab-oauth-applist.jpg)
<center>Figure 2: GitLab OAuth Applications List</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/gitlab/gitlab-sso-oauth-applist.jpg)
<center>Figure 3: GitLab OAuth Applications List</center>

3. Update the **Redirect URI** field with the redirectURI created in Devtron.

4. Enable the required scopes in the **Scopes** section as per the requirements. To know more, refer to [Required scopes](https://docs.gitlab.com/integration/oauth_provider/).

5. Click the **Save Application** button. The following page is displayed.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/gitlab/gitlab-oauth-edit-page.jpg)
<center>Figure 3: GitLab OAuth Application</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/gitlab/gitlab-sso-edit-page.jpg)
<center>Figure 4: GitLab OAuth Application</center>

The client ID is displayed in the **Application ID** field.

Expand All @@ -74,8 +77,8 @@ To configure the GitLab SSO in Devtron, follow the below steps of instructions:

2. Select the **Configuration** section available next to the **URL** field.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/gitlab/configuration-gitlab.jpg)
<center>Figure 4: GitLab SSO Configuraion</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/gitlab/gitlab-sso-config.jpg)
<center>Figure 5: GitLab SSO Configuration</center>

3. Update the `clientID` attribute with the Client ID generated in the OAuth application on GitLab.

Expand All @@ -85,8 +88,8 @@ To configure the GitLab SSO in Devtron, follow the below steps of instructions:

6. Click **Update** button to save the configuration. GitLab SSO is now successfully configured.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/gitlab/gitlab-sso-login.gif)
<center>Figure 5: Login with GitLab</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/gitlab/gitlab-sso-in-action.jpg)
<center>Figure 6: Login with GitLab</center>

:::caution Important Note
Although GitLab SSO is now configured, you will not be able to sign in with GitLab unless you add yourself as a user with the necessary permissions and manage other user permissions as well in Devtron. It is highly recommended to create [User Permissions](../user-access.md).
Expand Down
19 changes: 10 additions & 9 deletions docs/user-guide/global-configurations/authorization/sso/google.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Before configuring Google as an SSO provider,
* Click the URL next to **Click to use** in green color. The URL field will be automatically populated with the URL next to **Click to use**; this is essential to generate the correct **Redirect URI**.
* Copy the **Redirect URI** displayed in this section. You will need to enter this in Google Cloud.

<div class="video-wrapper"><iframe width="560" height="315" src="https://www.youtube.com/embed/QvufIzUSNpg" title="Getting the Redirect URI" frameborder="0" allow="fullscreen"></iframe></div>
<div class="video-wrapper"><iframe width="560" height="315" src="https://www.youtube.com/embed/YOSa0wiS9Z0" title="Getting the Redirect URI" frameborder="0" allow="fullscreen"></iframe></div>

## Configure OAuth in Google Cloud Console

Expand Down Expand Up @@ -60,17 +60,17 @@ Examples of invalid URIs:
❌ `http://192.168.1.10/callback`
:::

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/creating-oauth-client-google-sso.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/google/google-sso-creating-oauth-client.jpg)
<center>Figure 1: Creating OAuth Client</center>

You can see a new client ID is created in the **APIs & Services** → **Credentials**, under **OAuth 2.0 Client IDs** section. To obtain Client ID and Client Secret, click on the name (devtron-sso in our case) of the **OAuth 2.0 Client IDs**

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/client-id-created-google-sso.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/google/google-sso-client-id-created.jpg)
<center>Figure 2: Client ID Created</center>

Copy the Client ID and Client Secret, as they will be required in Devtron’s SSO configuration.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/client-id-and-secret-google-sso.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/google/google-sso-client-id-and-secret.jpg)
<center>Figure 3: Get the Client ID and Client Secret</center>

For a detailed step-by-step guide, refer to Google’s official documentation: [Get Google API Client ID](https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid).
Expand All @@ -81,7 +81,7 @@ The next step is to configure Devtron to use these credentials for authenticatio

## Configuration

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/configuration-devtron-google-sso.jpg)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/google/google-sso-config.jpg)
<center>Figure 4: Configuring SSO in Devtron</center>

In the configuration,
Expand All @@ -107,15 +107,16 @@ To ensure users can log in:
* Go to **Global Configurations** → **Authorization** → **User Permissions**.
* Click **Add User**.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/config-user-permissions-google-sso.jpg)
<center>Figure 5: Configuring User Permissions</center>
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/google/google-sso-add-user.jpg)
<center>Figure 5: Adding User with required permissions</center>

* Enter their email (matching their Google account).
* Assign the required role.
* Click **Save** to complete the setup.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/adding-user-google-sso.jpg)
<center>Figure 6: Adding User with required permissions</center>

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/sso-login-services/google/google-sso-config-user.jpg)
<center>Figure 6: Configuring User Permissions</center>

Once saved, Devtron will use Google OAuth for authentication, allowing users to log in using their Google accounts.

Expand Down