mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
docs: adds app-connection docs for github PAT
This commit is contained in:
BIN
docs/images/app-connections/github/create-pat-form.png
Normal file
BIN
docs/images/app-connections/github/create-pat-form.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 294 KiB |
BIN
docs/images/app-connections/github/create-pat-method.png
Normal file
BIN
docs/images/app-connections/github/create-pat-method.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 343 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 211 KiB |
BIN
docs/images/app-connections/github/pat-connection.png
Normal file
BIN
docs/images/app-connections/github/pat-connection.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 154 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 147 KiB |
@@ -3,7 +3,7 @@ title: "GitHub Connection"
|
||||
description: "Learn how to configure a GitHub Connection for Infisical."
|
||||
---
|
||||
|
||||
Infisical supports two methods for connecting to GitHub.
|
||||
Infisical supports three methods for connecting to GitHub.
|
||||
|
||||
<Tabs>
|
||||
<Tab title="GitHub App (Recommended)">
|
||||
@@ -178,5 +178,73 @@ Infisical supports two methods for connecting to GitHub.
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
<Tab title="Personal Access Token">
|
||||
Infisical will use a Personal Access Token to connect to GitHub.
|
||||
|
||||
<Accordion title="Self-Hosted Instance">
|
||||
Using the GitHub integration on a self-hosted instance of Infisical requires creating a Personal Access Token in GitHub.
|
||||
<Steps>
|
||||
<Step title="Create a Personal Access Token in GitHub">
|
||||
Navigate to your user Settings > Developer settings > Personal Access Tokens to create a new Personal Access Token.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Click **Generate new token** to create the token.
|
||||
</Step>
|
||||
<Step title="Fill in the Personal Access Token details">
|
||||
Fill in the Personal Access Token details:
|
||||
- **Token name:** A descriptive name for the token (e.g., "infisical-connection-token")
|
||||
- **Repository access:** Select the repositories you want to grant access to
|
||||
- Select `All repositories` or `Only selected repositories` to be able to manage the secrets in the selected repositories.
|
||||
- **Select scopes:** Add the following scopes:
|
||||
- Metadata: Read-only
|
||||
- Environments: Read and write
|
||||
|
||||

|
||||
|
||||
Click **Generate token** to create the token.
|
||||
</Step>
|
||||
<Step title="Copy the Personal Access Token">
|
||||
Copy the generated token immediately as it won't be shown again.
|
||||
|
||||

|
||||
|
||||
<Warning>
|
||||
Keep your Personal Access Token secure and do not share it. Anyone with access to this token can access your GitHub account and repositories.
|
||||
</Warning>
|
||||
</Step>
|
||||
</Steps>
|
||||
</Accordion>
|
||||
|
||||
## Setup GitHub Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** page in the desired project.
|
||||

|
||||
</Step>
|
||||
<Step title="Add Connection">
|
||||
Select the **GitHub Connection** option from the connection options modal.
|
||||

|
||||
</Step>
|
||||
<Step title="Authorize Connection">
|
||||
Select the **Personal Access Token** method and fill in the **Personal Access Token** field with your Personal Access Token.
|
||||
|
||||
You may optionally configure GitHub Enterprise options:
|
||||
- **Gateway:** The gateway connected to your private network
|
||||
- **Hostname:** The hostname at which to access your GitHub Enterprise instance
|
||||
|
||||
Click **Create Connection**.
|
||||
|
||||

|
||||
</Step>
|
||||
<Step title="Connection Created">
|
||||
Your **GitHub Connection** is now available for use.
|
||||

|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
|
||||
</Tabs>
|
||||
|
||||
Reference in New Issue
Block a user