doc: updated github action docs
Sheen Capadngan
|
After Width: | Height: | Size: 287 KiB |
|
After Width: | Height: | Size: 503 KiB |
|
After Width: | Height: | Size: 891 KiB |
|
After Width: | Height: | Size: 297 KiB |
|
After Width: | Height: | Size: 307 KiB |
|
After Width: | Height: | Size: 233 KiB |
|
After Width: | Height: | Size: 406 KiB |
|
After Width: | Height: | Size: 383 KiB |
|
After Width: | Height: | Size: 239 KiB |
|
After Width: | Height: | Size: 363 KiB |
|
After Width: | Height: | Size: 330 KiB |
|
After Width: | Height: | Size: 284 KiB |
|
After Width: | Height: | Size: 497 KiB |
|
After Width: | Height: | Size: 891 KiB |
@@ -10,6 +10,113 @@ description: "How to sync secrets from Infisical to GitHub Actions"
|
|||||||
|
|
||||||
Infisical lets you sync secrets to GitHub at the organization-level, repository-level, and repository environment-level.
|
Infisical lets you sync secrets to GitHub at the organization-level, repository-level, and repository environment-level.
|
||||||
|
|
||||||
|
## Connecting with Github App (Recommended)
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<Tab title="Usage">
|
||||||
|
<Steps>
|
||||||
|
<Step title="Authorize Github Infisical App">
|
||||||
|
Navigate to your project's integrations tab in Infisical and press on the GitHub tile.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Select Github App as the authentication method and click **Connect to Github**.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
You will then be redirected to the Github app installation page.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Install and authorize the Github application. This will redirect you back to the Infisical integration page.
|
||||||
|
|
||||||
|
</Step>
|
||||||
|
<Step title="Configure Infisical GitHub integration">
|
||||||
|
Select which Infisical environment secrets you want to sync to which GitHub organization, repository, or repository environment.
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<Tab title="Repository">
|
||||||
|
|
||||||
|
</Tab>
|
||||||
|
<Tab title="Organization">
|
||||||
|
|
||||||
|
|
||||||
|
When using the organization scope, your secrets will be saved in the top-level of your Github Organization.
|
||||||
|
|
||||||
|
You can choose the visibility, which defines which repositories can access the secrets. The options are:
|
||||||
|
- **All public repositories**: All public repositories in the organization can access the secrets.
|
||||||
|
- **All private repositories**: All private repositories in the organization can access the secrets.
|
||||||
|
- **Selected repositories**: Only the selected repositories can access the secrets. This gives a more fine-grained control over which repositories can access the secrets. You can select _both_ private and public repositories with this option.
|
||||||
|
</Tab>
|
||||||
|
<Tab title="Repository Environment">
|
||||||
|
|
||||||
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
Finally, press create integration to start syncing secrets to GitHub.
|
||||||
|
|
||||||
|
|
||||||
|
</Step>
|
||||||
|
</Steps>
|
||||||
|
|
||||||
|
</Tab>
|
||||||
|
<Tab title="Self-Hosted Setup">
|
||||||
|
Using the GitHub integration with app authentication on a self-hosted instance of Infisical requires configuring an application on GitHub
|
||||||
|
and registering your instance with it.
|
||||||
|
<Steps>
|
||||||
|
<Step title="Create an application on GitHub">
|
||||||
|
Navigate to the Github app settings [here](https://github.com/settings/apps). Click **New Github App**.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Give the application a name, a homepage URL (your self-hosted domain i.e. `https://your-domain.com`), and a callback URL (i.e. `https://your-domain.com/integrations/github/oauth2/callback`).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Disable webhook by unchecking the Active checkbox.
|
||||||
|
|
||||||
|
|
||||||
|
Set the repository permissions as follows: Metadata: Read-only, Secrets: Read and write.
|
||||||
|
|
||||||
|
|
||||||
|
Similarly, set the organization permissions as follows: Secrets: Read and write.
|
||||||
|
|
||||||
|
|
||||||
|
Create the Github application.
|
||||||
|
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
If you have a GitHub organization, you can create an application under it
|
||||||
|
in your organization Settings > Developer settings > Github Apps > New Github App.
|
||||||
|
</Note>
|
||||||
|
</Step>
|
||||||
|
<Step title="Add your application credentials to Infisical">
|
||||||
|
Generate a new **Client Secret** for your GitHub application.
|
||||||
|
|
||||||
|
|
||||||
|
Generate a new **Private Key** for your Github application.
|
||||||
|
|
||||||
|
|
||||||
|
Obtain the necessary Github application credentials. This would be the application slug, client ID, app ID, client secret, and private key.
|
||||||
|
|
||||||
|
|
||||||
|
Back in your Infisical instance, add the five new environment variables for the credentials of your GitHub application:
|
||||||
|
|
||||||
|
- `CLIENT_ID_GITHUB_APP`: The **Client ID** of your GitHub application.
|
||||||
|
- `CLIENT_SECRET_GITHUB_APP`: The **Client Secret** of your GitHub application.
|
||||||
|
- `CLIENT_SLUG_GITHUB_APP`: The **Slug** of your Github application. This is the one found in the URL.
|
||||||
|
- `CLIENT_APP_ID_GITHUB_APP`: The **App ID** of your Github application.
|
||||||
|
- `CLIENT_PRIVATE_KEY_GITHUB_APP`: The **Private Key** of your Github application.
|
||||||
|
|
||||||
|
Once added, restart your Infisical instance and use the GitHub integration via app authentication.
|
||||||
|
</Step>
|
||||||
|
</Steps>
|
||||||
|
|
||||||
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
## Connecting with Github OAuth
|
||||||
|
|
||||||
Prerequisites:
|
Prerequisites:
|
||||||
|
|
||||||
- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
|
- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
|
||||||
@@ -19,12 +126,13 @@ Prerequisites:
|
|||||||
<Tab title="Usage">
|
<Tab title="Usage">
|
||||||
<Steps>
|
<Steps>
|
||||||
<Step title="Authorize Infisical for GitHub">
|
<Step title="Authorize Infisical for GitHub">
|
||||||
Navigate to your project's integrations tab in Infisical.
|
Navigate to your project's integrations tab in Infisical and press on the Github tile.
|
||||||
|
|
||||||
|
|
||||||
|
Select OAuth as the authentication method and click **Connect to Github**.
|
||||||
|
|
||||||
Press on the GitHub tile and grant Infisical access to your GitHub account (repo privileges only).
|
|
||||||
|
|
||||||
|
Grant Infisical access to your GitHub account (organization and repo privileges).
|
||||||
|
|
||||||
|
|
||||||
</Step>
|
</Step>
|
||||||
|
|||||||