# Github Integration


--------------------------------------------------------------------------------
title: "Introduction"
description: "Catalyst enables you to integrate your Git account to access your repositories and deploy projects from them to the remote console directly."
last_updated: "2026-03-18T07:41:08.553Z"
source: "https://docs.catalyst.zoho.com/en/devops/help/github-integration/introduction/"
service: "DevOps"
--------------------------------------------------------------------------------


# GitHub Integration

## Introduction

Github Integration is a Catalyst DevOps component that allows you to integrate your GitHub account with your Catalyst account and access your Git repositories in the Catalyst console. This integration allows you to deploy your Catalyst projects in GitHub directly from the Catalyst console. When you integrate your GitHub account with your Catalyst account, you can view your Git repositories and their URLs in the Catalyst console.

The files in your Git repository must be in the standard project directory structure. When you deploy the functions and the client packages present in the Git repository in Catalyst, they will be reflected in the _Functions_ and the _Hosting_ sections of the console. You can also synchronize the changes made in the GitHub repositories with your Catalyst console.

{{%note%}}{{%bold%}}Note:{{%/bold%}} 

1. This component is available to Catalyst users who were active before **July 2024** or have already integrated their GitHub repositories with Catalyst. If you are a new user, we strongly recommend you explore our new service, {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}}, an advanced version of the Git component. Catalyst Pipelines enables you to define the entire end-to-end build-to-deployment workflow using commands in a YAML file. To learn more, refer to the {{%link href=&#34;/en/pipelines/help/pipelines/introduction/&#34; %}}help documentation{{%/link%}}.

2. Please note that the Pipelines service is currently part of our early access program. If you haven&#39;t gained access yet, you can request it directly through {{%link href=&#34;https://forms.zohopublic.com/zohocorporation/form/CatalystbyZohoPartnerEarlyaccess/formperma/bc3yQ4vaPEMxmwRhkTvdKemwiM1ZY400Oj74EuRCImU&#34; %}}this form{{%/link%}}.{{%/note%}}

--------------------------------------------------------------------------------
title: "Key Features"
description: "Catalyst enables you to integrate your Git account to access your repositories and deploy projects from them to the remote console directly."
last_updated: "2026-03-18T07:41:08.553Z"
source: "https://docs.catalyst.zoho.com/en/devops/help/github-integration/key-features/"
service: "DevOps"
--------------------------------------------------------------------------------


# Key Features of GitHub Integration

* Work directly on GitHub and deploy the repositories to your Catalyst account
* Develop functions and client packages on GitHub and associate them with your Catalyst project
* No need to duplicate functions and client packages from GitHub in Catalyst
* Synchronize the changes made in GitHub with Catalyst at the click of a button

--------------------------------------------------------------------------------
title: "Implementation"
description: "Catalyst enables you to integrate your Git account to access your repositories and deploy projects from them to the remote console directly."
last_updated: "2026-03-18T07:41:08.553Z"
source: "https://docs.catalyst.zoho.com/en/devops/help/github-integration/implementation/"
service: "DevOps"
--------------------------------------------------------------------------------


# Implementation

### Integrating a GitHub Account with Catalyst

You can easily integrate and authenticate your GitHub account with Catalyst from the console.

To integrate a GitHub account with Catalyst:

1. Navigate to **Catalyst DevOps** and under **Repositories**, select **Git**. Click **Integrate GitHub**.


2. Click **Agree** after reading the terms of use and privacy policy statements. 


3. In the **GitHub Authentication** page, enter your Username or Email address and password. Click **Sign in**.


4. In the **Authorize Zoho Catalyst** popup, click **Authroize ZohoCorporation** for the permissions requested.


Once the authorization is complete, you will be redirected back to the Catalyst console. 

If the authentication is successful, your GitHub repositories will be displayed in the **GitHub Integration** page. 

You can also integrate your GitHub account with Catalyst from **Integrations** under **General Settings** in the same manner:

1. Navigate to the **Settings** icon on the top right corner of the Catalyst console. 


2. In the left menu, under **General Settings**, click on **Integrations**. Then, click on the **GitHub** tile.


3. Click **Add Account**. Follow the same steps as above to integrate your GitHub account with Catalyst.


The GitHub Integration page lists your Git repositories and displays the relevant details.


### Deploying a GitHub repository from Catalyst

As discussed in the introduction, before deploying a Git repository from Catalyst, you should make sure that the repository contains the resources in the standard project directory format. Ensure that the _catalyst.json_ file is present in the GitHub repository for a successful deployment.

To deploy a Git repository from Catalyst:

1. Navigate to **Catalyst DevOps** service in the left menu. Select **Git** under **Repositories**. 


{{%note%}}{{%bold%}}Note:{{%/bold%}} 

Click the {{%bold%}}Explore Now{{%/bold%}} button, as shown in the screenshot above, to try out {{%link href=&#34;/en/pipelines/&#34; %}}Catalyst Pipelines{{%/link%}} and seamlessly orchestrate your deployments. This component is currently available through our early access program, so if you haven’t gained access yet, please request it via {{%link href=&#34;https://forms.zohopublic.com/zohocorporation/form/CatalystbyZohoPartnerEarlyaccess/formperma/bc3yQ4vaPEMxmwRhkTvdKemwiM1ZY400Oj74EuRCImU&#34; %}}this form{{%/link%}}.{{%/note%}}

This integration enables you to link a particular repository in the version control system with the pipeline, and whenever any changes are pushed to the repository, the pipeline will get triggered automatically.

The repositories associated with your GitHub account will be automatically listed here along with the Repository URL and the default branch. 

2. Select the required repository and click **Deploy**. In the confirmation pop-up, again click **Deploy**.


3. Once the deployment process begins, you will see the progress of the deployment status in the GitHub Integration page. The progress status bar also displays the repository name and the repository URL.


When the deployment process is complete, you will receive a notification stating whether the deployment was successful or unsuccessful. If your deployment was successful, you will be able to see the status in the _Deployed repository_ status bar, along with the repository name and URL.

{{%note%}}{{%bold%}}Note:{{%/bold%}} While the deployment process of a repository is ongoing, you will not be able to deploy another repository simultaneously. You can deploy the next repository once the deployment process for the first repository is complete. You can click {{%bold%}}Refresh{{%/bold%}} if the deployement process is taking too long.{{%/note%}}

When a repository is deployed successfully, your Catalyst project will be updated in the following ways:

* The functions in the _Functions_ folder in your Git repository will be available in the _Functions_ page in the Catalyst console. To verify them, navigate to **Catalyst Serverless &gt; FAAS &gt; Functions**. You can view all the functions in the default branch of your repository in the _Functions_ page.

* The client package in the _Client_ folder in your Git repository will be automatically hosted in Catalyst. If it is a web app, you can view the hosted application in Catalyst by navigating to **Catalyst CloudScale &gt; Host &amp; Manage &gt; Web Client Hosting**. If it is a mobile app, you can view the hosted application in Catalyst by navigating to **Catalyst CloudScale &gt; Host &amp; Manage &gt; MDM**. Refer to the {{%link href=&#34;/en/cloud-scale/help/web-client-hosting/introduction&#34; %}}web client hosting{{%/link%}} and {{%link href=&#34;/en/cloud-scale/help/mobile-device-management/introduction&#34; %}}MDM{{%/link%}} help sections for detailed information.

{{%note%}}{{%bold%}}Note:{{%/bold%}} If the GitHub repository is not in the standard Project Directory structure, the deployment will be unsuccessful and the changes will not be reflected in {{%bold%}}Functions{{%/bold%}} or {{%bold%}}Web Client Hosting{{%/bold%}}. Please ensure that the default branch of the repository contains the files in the specified structure.{{%/note%}}

### Synchronizing changes in GitHub with Catalyst

Catalyst console allows you to easily synchronize the changes made in your deployed GitHub repository. When you update the files in the repository in GitHub, the changes will be reflected in Catalyst as well.

To synchronize the changes made in your deployed GitHub repository to Catalyst:

1. Navigate to **Repositories -&gt; Git**. 
2. In the _GitHub Integration_ page, click {{%bold%}}Sync{{%/bold%}} on the _Deployed Repository_ status bar.&lt;br /&gt; &lt;br /&gt;

The _Deployed Repository_ status bar will display the synchronization progress state. Once the synchronization process is complete, you will be able to view the latest updates to your repository in your Catalyst console.

### Revoking Access to GitHub from Catalyst

You can easily revoke access for GitHub to Catalyst and remove the GitHub integration for the account. You can also use this option to integrate a different GitHub account with Catalyst.

To revoke access to GitHub from Catalyst:

1. Navigate to **Settings &gt; General Settings &gt; Integrations &gt; GitHub**.


2. Click on the ellipsis icon and click **Revoke**. 


3. In the revoke confirmation pop-up, click **Revoke**. 


The access to the GitHub account will be revoked from Catalyst. Once the access is revoked, you will no longer be able to view your Git repositories in the GitHub Integration page.