Text of developer.hashicorp.com › vault › docs › sync › github as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Sync secrets from Vault to GitHub | Vault | HashiCorp Developer

HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream Vault Home Sync secrets from Vault to GitHub The GitHub Actions sync destination allows Vault to safely synchronize secrets as GitHub organization, repository, or environment secrets. This is a low footprint option that enables your applications to benefit from Vault-managed secrets without requiring them to connect directly with Vault.

This guide walks you through the configuration process. Prerequisites: Ability to read or create KVv2 secrets Ability to create GitHub fine-grained or personal tokens (or a GitHub application) with access to modify organization and/or repository secrets Ability to create sync destinations and associations on your Vault server Setup To get started with syncing Vault secrets to your GitHub, you will need a configured GitHub application or an access token that has write permission on the target sync location in GitHub for "Secrets".

The "Secrets" permissions in GitHub automatically includes read-only "Metadata" access. Pitfalls of using an access token Access tokens are tied to a user account and can be revoked at any time, causing disruptions to the sync process. GitHub applications are long-lived and do not expire. Using a GitHub application for authentication is preferred over using a personal access token. Repositories Use vault write to configure a repository sync destination with an access token: $ vault write sys/sync/destinations/gh/DESTINATION_NAME \ access_token="GITHUB_ACCESS_TOKEN" \ secrets_location="GITHUB_SECRETS_LOCATION" \ repository_owner="GITHUB_OWNER_NAME" \ repository_name="GITHUB_REPO_NAME" For example: $ vault write sys/sync/destinations/gh/hcrepo-sandbox \ access_token="github_pat_11ABC000000000000000000000DEF" \ secrets_location="repository" \ repository_owner="hashicorp" \ repository_name="hcrepo" Key Value --- ----- connection_details map[access_token:***** secrets_location:repository repository_owner:hashicorp repository_name:hcrepo] name hcrepo-sandbox type gh Environments Use vault write to configure an environment sync destination: $ vault write sys/sync/destinations/gh/DESTINATION_NAME \ access_token="GITHUB_ACCESS_TOKEN" \ secrets_location="GITHUB_SECRETS_LOCATION" \ repository_owner="GITHUB_OWNER_NAME" \ repository_name="GITHUB_REPO_NAME" \ environment_name="GITHUB_ENVIRONMENT_NAME" For example: $ vault write sys/sync/destinations/gh/hcrepo-sandbox \ access_token="github_pat_11ABC000000000000000000000DEF" \ secrets_location="repository" \ repository_owner="hashicorp" \ repository_name="hcrepo" \ environment_name="sandbox" Key Value --- ----- connection_details map[access_token:***** secrets_location:repository environment_name:sandbox repository_owner:hashicorp repository_name:hcrepo] name hcrepo-sandbox type gh Organizations Beta feature Beta functionality is stable but possibly incomplete and subject to change.

We strongly discourage using beta features in production deployments of Vault. Beta limitations: You cannot update visibility ( organization_visibility ) after creating a secrets sync destination. You cannot update the list of repositories with access to synced secrets ( selected_repository_names ) after creating a secrets sync destination. Sync secrets to GitHub organization to share those secrets across repositories in the organizations.

You choose to make secrets global to the organization, limited to private/internal repos, or limited to specifically named repositories. Refer to the Secrets sync API docs for detailed configuration information. Warning Organization secrets are not visible to private repositories for GitHub Free accounts . Use vault write to configure an organization sync destination: $ vault write sys/sync/destinations/gh/DESTINATION_NAME \ access_token="GITHUB_ACCESS_TOKEN" \ secrets_location="GITHUB_SECRETS_LOCATION" \ organization_name="ORGANIZATION_NAME" \ organization_visibility="ORGANIZATION_VISIBILITY" For example: $ vault write sys/sync/destinations/gh/hcrepo-sandbox \ access_token="github_pat_11ABC000000000000000000000DEF" \ secrets_location="organization" \ organization_name="hashicorp" \ organization_visibility="selected" \ selected_repository_names="hcrepo-1,hcrepo-2" Key Value --- ----- connection_details map[access_token:***** secrets_location:organization organization_name:hashicorp organization_visibility:all selected_repository_names:[hcrepo-1 hcrepo-2]] name hcrepo-sandbox type gh GitHub Enterprise In addition to the standard github.com destination parameters, you must provide your Enterprise server URL with enterprise_url to configure GitHub Enterprise Server (self-hosted GitHub) destinations.

For example, to configure repository secrets with GitHub Enterprise: $ vault write sys/sync/destinations/gh/DESTINATION_NAME \ enterprise_url="https://github.example.com" \ access_token="GITHUB_ACCESS_TOKEN" \ secrets_location="GITHUB_SECRETS_LOCATION" \ repository_owner="GITHUB_OWNER_NAME" \ repository_name="GITHUB_REPO_NAME" Usage If you do not already have a KVv2 secret to sync, mount a new KVv2 secrets engine. $ vault secrets enable -path=my-kv kv-v2 Output: Success!

Enabled the kv-v2 secrets engine at: my-kv/ Create secrets you wish to sync with a target GitHub repository for Actions. $ vault kv put -mount= 'my-kv' my-secret key1= 'val1' key2= 'val2' Output: ==== Secret Path ==== my-kv/data/my-secret ======= Metadata ======= Key Value --- ----- created_time <timestamp> custom_metadata <nil> deletion_time n/a destroyed false version 1 Create an association between the destination and a secret to synchronize. $ vault write sys/sync/destinations/gh/my-dest/associations/set \ mount='my-kv' \ secret_name='my-secret' Output: Key Value --- ----- associated_secrets map[kv_1234/my-secret:map[accessor:kv_1234 secret_name:my-secret sync_status:SYNCED updated_at:<timestamp>>]] store_name my-dest store_type gh Navigate to your GitHub repository settings to confirm your secret was successfully created.

Moving forward, any modification on the Vault secret will be propagated in near-real time to its GitHub secrets counterpart. Creating a new secret version in Vault will create a new version in GitHub. Deleting the secret or the association in Vault will delete the secret in GitHub as well. Security Note Vault syncs secrets differently depending on whether you have configured secret-key or secret-path granularity : secret-key granularity splits KVv2 secrets from Vault into key-value pairs and stores the pairs as distinct entries in GitHub.

For example, secrets.key1="val1" and secrets.key2="val2" . secret-path granularity stores secrets as a single JSON string that contains all the associated key-value pairs. For example, {"key1":"val1", "key2":"val2"} . Since GitHub limits secrets to single-value secrets, the sync granularity defaults to secret-key . If using the secret-path granularity, it is strongly advised to mask individual values for each sub-key to prevent the unintended disclosure of secrets in any GitHub Action outputs.

The following snippet illustrates how to mask each secret values: name : Mask synced secret values on : workflow_dispatch jobs : synced-secret-examples : runs-on : ubuntu-latest steps : - name : ✓ Mask synced secret values run : | for v in $(echo '${{ secrets.VAULT_KV_1234_MY_SECRET }}' | jq -r '.[]'); do echo "::add-mask::$v" done If the GitHub destination uses the default secret-key granularity, the values are masked by GitHub automatically.

GitHub application Instead of authenticating with a personal access token, you can choose to authenticate with a custom GitHub application . Start by following the GitHub instructions for installing a GitHub app . to install your GitHub application on a specified repository and note the assigned installation ID. Your installation ID is in the app URL You can find your assigned installation ID in the URL path parameter: https://github.com/settings/installations/<INSTALLATION_ID> Then add your GitHub applic

The rest of this page is on the live site.