Git Repository access

When you first sign into the Qovery Console, you need to provide your Git provider account credentials. This allows you to later take advantage of a Single Sign-On process through your Git provider. However, by default, Qovery is then allowed to access all the resources stored on your Git provider account.

For better control, as a Github user, you can install the Qovery Github App, and define which Github repositories Qovery can access.

You can only link one Github Organization to your Qovery Organization through the Qovery Github App. Also, once the Qovery Github App is installed, all the members of your Qovery Organization will only have access to the repositories linked to your Qovery Github App.

Installing the Qovery Github App

If you have already one or more applications running on your Qovery Organization, please make sure to give the Qovery Github App access to their repositories. If a repository is missing, you might experience a loss of functionalities for those applications (update, auto-deploy, preview environments, etc.).

To install the Qovery Github App:

1. Open your Qovery Console and access your organization settings:

   

2. In the Organization settings menu, click Git Repository Access:

   

3. To start the installation process click Install:

   A new window opens in your browser so you can install the Qovery Github App on your Github account.

4. Click the Github account on which you want to install the Qovery Github App:

   

5. Click Only select repositories and, in the dropdown menu, define which Github repositories you want to give Qovery access to:

   

   You need to give Qovery access to any Github repository linked to an existing Qovery application. Failure to do so will result in the loss of some functionalities (update, auto-deploy, preview environments, etc.).

6. To confirm, click Install & Authorize:

   

   You are redirected to your Qovery Console, where the list of authorized Github repositories is updated.

   You can update or revoke access to one or multiple Github repositories at any time. To do so, in the Git Repository Access section, click Manage Permission below your Git provider account, and repeat the selection process on the Github website. Please note that the repositories must belong to the same Github organization, we do not support yet a multi-github organization setup

How was it? Did this tutorial work?  Yes  No

Managing the Github permissions

To add or remove access to one of your repositories:

1. Open your Qovery Console and access your organization settings:

   

2. In the Organization settings menu, click Git Permission:

   

3. Next to your Git provider account, click Manage permission:

   

4. Click the Github account on which you want to manage the Qovery Github App access:

   

5. Add or remove the repositories you want to give Qovery access to:

   

   Rremoving access to a Github repository linked to an existing Qovery application will result in the loss of some functionalities for that application (update, auto-deploy, preview environments, etc.).

How was it? Did this tutorial work?  Yes  No

Uninstalling the Qovery Github App

Uninstalling the Qovery Github App will result in a loss of some functionalities for all your applications (update, auto-deploy, preview environments, etc.).

To uninstall the Qovery Github App:

1. Open your Qovery Console and access your organization settings:

   

2. In the Organization settings menu, click Git Permission:

   

3. Next to your Git provider account, click Disconnect:

   

   The list of authorized Github repositories is updated, meaning Qovery now has access to all of your Github repositories again.

4. From your browser, access your Github account and open your Settings:

   

5. In the navigation menu, click Applications:

   

6. At the bottom of the page, click Uninstall:

   

   A confirmation pop-up window opens.

7. Click OK:

   The Qovery Github App is uninstalled.

How was it? Did this tutorial work?  Yes  No