> ## Documentation Index
> Fetch the complete documentation index at: https://infisical.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub sync

> Learn how to configure a GitHub Sync for Infisical.

**Prerequisites:**

* Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
* Create a [GitHub Connection](https://infisical.com/docs/integrations/app-connections/github.md)
* Ensure your network security policies allow incoming requests from Infisical to this secret sync provider, if network restrictions apply.

## Secret types

A GitHub sync writes to one type of GitHub secret: Actions, Dependabot, or Codespaces. Each type needs its own permissions on the [GitHub Connection](https://infisical.com/docs/integrations/app-connections/github.md), and how you grant them depends on the connection's method:

> [tab] GitHub App (Recommended)
>
> Under **Permissions**, set the permissions for every [type of GitHub secret](https://infisical.com/docs/integrations/secret-syncs/github.md#secret-types) you plan to sync:
>
> > [accordion] Actions secrets
> >
> > * To sync to a repository, set the repository permission **Secrets** to Read and write
> > * To sync to a repository environment, also set the repository permission **Environments** to Read and write, and **Actions** to Read-only
> > * To sync to an organization, set the organization permission **Secrets** to Read and write
> >
> > ![integrations github app organization](https://infisical.com/docs/images/integrations/github/app/self-hosted-github-app-organization.png)
>
> > [accordion] Dependabot secrets
> >
> > * To sync to a repository, set the repository permission **Dependabot secrets** to Read and write
> > * To sync to an organization, set the organization permission **Organization dependabot secrets** to Read and write
> >
> > ![Dependabot secrets set to Read and write in the GitHub App's repository permissions](https://infisical.com/docs/images/app-connections/github/github-app-dependabot-secrets-permission.png)
>
> > [accordion] Codespaces secrets
> >
> > GitHub Enterprise Server doesn't include Codespaces, so you can't sync Codespaces secrets through a GitHub Enterprise Server connection.
> >
> > * To sync to a repository, set the repository permission **Codespaces secrets** to Read and write
> > * To sync to an organization, set the organization permission **Organization codespaces secrets** to Read and write
> >
> > ![Codespaces secrets set to Read and write in the GitHub App's repository permissions](https://infisical.com/docs/images/app-connections/github/github-app-codespaces-secrets-permission.png)
>
> > [!NOTE]
> >
> > If you add a permission to an existing GitHub App, an owner of each installation has to approve the new permission on GitHub before Infisical can use it.

> [tab] OAuth
>
> When you create an OAuth connection, Infisical requests two scopes from GitHub. Together they cover every secret type, so you don't need to set any permissions yourself:
>
> * `repo`: secrets in repositories and repository environments
> * `admin:org`: secrets in organizations
>
> GitHub Enterprise Server doesn't include Codespaces, so you can't sync Codespaces secrets through it.

> [tab] Personal Access Token
>
> If you use a classic token, select the `repo` and `admin:org` scopes, which cover every secret type.
>
> If you use a fine-grained token:
>
> Under **Permissions**, select **Add permissions** and add the permissions for every [type of GitHub secret](https://infisical.com/docs/integrations/secret-syncs/github.md#secret-types) you plan to sync:
>
> > [accordion] Actions secrets
> >
> > * To sync to a repository, set the repository permission **Secrets** to Read and write
> > * To sync to a repository environment, also set the repository permission **Environments** to Read and write, and **Actions** to Read-only
> > * To sync to an organization, set the organization permission **Secrets** to Read and write
> >
> > ![Secrets set to Read and write on a fine-grained personal access token](https://infisical.com/docs/images/app-connections/github/create-pat-form.png)
>
> > [accordion] Dependabot secrets
> >
> > * To sync to a repository, set the repository permission **Dependabot secrets** to Read and write
> > * To sync to an organization, set the organization permission **Organization dependabot secrets** to Read and write
> >
> > ![Dependabot secrets set to Read and write on a fine-grained personal access token](https://infisical.com/docs/images/app-connections/github/pat-dependabot-secrets-permission.png)
>
> > [accordion] Codespaces secrets
> >
> > GitHub Enterprise Server doesn't include Codespaces, so you can't sync Codespaces secrets through a GitHub Enterprise Server connection.
> >
> > * To sync to a repository, set the repository permission **Codespaces secrets** to Read and write
> > * To sync to an organization, set the organization permission **Organization codespaces secrets** to Read and write
> >
> > ![Codespaces secrets set to Read and write on a fine-grained personal access token](https://infisical.com/docs/images/app-connections/github/pat-codespaces-secrets-permission.png)

## Create a GitHub sync

> [tab] Infisical UI
>
> 1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Select the **Add Sync** button.
>
>    ![Secret Syncs Tab](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/general/secret-sync-tab.png)
>
> 2. Select the **GitHub** option.
>
>    ![Select GitHub](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/select-github-option.png)
>
> 3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
>
>    ![Configure Source](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/github-source.png)
>
>    * **Environment**: The project environment to retrieve secrets from.
>
>    * **Secret Path**: The folder path to retrieve secrets from.
>
> > [!TIP]
> >
> > If you need to sync secrets from multiple folder locations, check out [secret imports](https://infisical.com/docs/documentation/platform/secret-reference.md#secret-imports).
>
> 4. Configure the **Destination** to where secrets should be deployed, then select **Next**.
>
>    ![Configure Destination](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/github-destination.png)
>
>    * **GitHub Connection**: The GitHub Connection to authenticate with
>    * **Secret Type**: The [type of GitHub secret](#secret-types) to sync to (defaults to **Actions**)
>      * **Actions**: Secrets for GitHub Actions workflows
>      * **Dependabot**: Secrets for Dependabot
>      * **Codespaces**: Secrets for GitHub Codespaces
>    * **Scope**: The GitHub secret scope to sync secrets to
>      * **Organization**: Sync secrets to a specific organization
>      * **Repository**: Sync secrets to a specific repository
>      * **Repository Environment**: Sync secrets to a specific repository's environment (only for the **Actions** secret type)
>
>    The remaining fields are determined by the selected **Scope**:
>
>    > [accordion] Organization
>    >
>    > * **Organization**: The organization to deploy secrets to.
>    > * **Visibility**: Determines which organization repositories can access deployed secrets.
>    >   * **All Repositories**: All repositories of the organization. (Public repositories if not a Pro/Team account)
>    >   * **Private Repositories**: All private repositories of the organization. (Requires Pro/Team account)
>    >   * **Selected Repositories**: Only the selected Repositories.
>    > * **Selected Repositories**: The selected repositories if **Visibility** is set to **Selected Repositories**.
>
>    > [accordion] Repository
>    >
>    > * **Repository**: The repository to deploy secrets to.
>
>    > [accordion] Repository Environment
>    >
>    > * **Repository**: The repository to deploy secrets to.
>    > * **Environment**: The repository's environment to deploy secrets to.
>
> 5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
>
>    ![Configure Options](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/github-options.png)
>
>    * **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
>      * **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
>      > [!NOTE]
>      >
>      > GitHub does not support importing secrets.
>
>    * **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name and `{{environment}}` for the environment.
>
>    > [!NOTE]
>    >
>    > We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
>
>    * **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
>    * **Disable Secret Deletion**: If enabled, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
>
> 6. Configure the **Details** of your GitHub Sync, then click **Next**.
>
>    ![Configure Details](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/github-details.png)
>
>    * **Name**: The name of your sync. Must be slug-friendly.
>    * **Description**: An optional description for your sync.
>
> 7. Review your GitHub Sync configuration, then click **Create Sync**.
>
>    ![Confirm Configuration](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/github-review.png)
>
> 8. If enabled, your GitHub Sync will begin syncing your secrets to the destination endpoint.
>
>    ![Sync Secrets](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/github/github-created.png)

> [tab] API
>
> To create an **GitHub Sync**, make an API request to the [Create GitHub Sync](https://infisical.com/docs/api-reference/endpoints/secret-syncs/github/create.md) API endpoint.
>
> Set `secretType` in `destinationConfig` to `actions`, `dependabot`, or `codespaces`. If you leave `secretType` out, Infisical syncs to Actions secrets.
>
> ### Sample request
>
> ```bash Request theme={"dark"}
> curl    --request POST \
> --url https://app.infisical.com/api/v1/secret-syncs/github \
> --header 'Content-Type: application/json' \
> --data '{
>     "name": "my-github-sync",
>     "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>     "description": "an example sync",
>     "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>     "environment": "dev",
>     "secretPath": "/my-secrets",
>     "isEnabled": true,
>     "syncOptions": {
>         "initialSyncBehavior": "overwrite-destination"
>     },
>     "destinationConfig": {
>         "scope": "repository",
>         "secretType": "dependabot",
>         "owner": "my-github",
>         "repo": "my-repository"
>     }
> }'
> ```
>
> ### Sample response
>
> ```bash Response theme={"dark"}
> {
>     "secretSync": {
>         "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "name": "my-github-sync",
>         "description": "an example sync",
>         "isEnabled": true,
>         "version": 1,
>         "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "createdAt": "2023-11-07T05:31:56Z",
>         "updatedAt": "2023-11-07T05:31:56Z",
>         "syncStatus": "succeeded",
>         "lastSyncJobId": "123",
>         "lastSyncMessage": null,
>         "lastSyncedAt": "2023-11-07T05:31:56Z",
>         "importStatus": null,
>         "lastImportJobId": null,
>         "lastImportMessage": null,
>         "lastImportedAt": null,
>         "removeStatus": null,
>         "lastRemoveJobId": null,
>         "lastRemoveMessage": null,
>         "lastRemovedAt": null,
>         "syncOptions": {
>             "initialSyncBehavior": "overwrite-destination"
>         },
>         "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "connection": {
>             "app": "github",
>             "name": "my-github-connection",
>             "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
>         },
>         "environment": {
>             "slug": "dev",
>             "name": "Development",
>             "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
>         },
>         "folder": {
>             "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>             "path": "/my-secrets"
>         },
>         "destination": "github",
>         "destinationConfig": {
>             "scope": "repository",
>             "secretType": "dependabot",
>             "owner": "my-github",
>             "repo": "my-repository"
>         }
>     }
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.