mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
feat(secret-sync): Add gitlab secret sync
This commit is contained in:
carlosmonastyrski
176
docs/integrations/app-connections/gitlab.mdx
Normal file
176
docs/integrations/app-connections/gitlab.mdx
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
title: "GitLab App Connection"
|
||||
description: "Learn how to configure a GitLab App Connection for Infisical using OAuth or Access Token methods."
|
||||
---
|
||||
|
||||
Infisical supports two methods for connecting to GitLab: **OAuth** and **Access Token**. Choose the method that best fits your setup and security requirements.
|
||||
|
||||
<Tabs>
|
||||
<Tab title="OAuth Method">
|
||||
The OAuth method provides secure authentication through GitLab's OAuth flow.
|
||||
|
||||
<Accordion title="Self-Hosted Instance Setup">
|
||||
Using the GitLab App Connection with OAuth on a self-hosted instance of Infisical requires configuring an OAuth application in GitLab and registering your instance with it.
|
||||
|
||||
**Prerequisites:**
|
||||
- A GitLab account with existing projects
|
||||
- Self-hosted Infisical instance
|
||||
|
||||
<Steps>
|
||||
<Step title="Create an OAuth application in GitLab">
|
||||
Navigate to your user Settings > Applications to create a new GitLab application.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/gitlab/oauth2/callback`.
|
||||
|
||||
|
||||
|
||||
|
||||
<Tip>
|
||||
The domain you defined in the Redirect URI should be equivalent to the `SITE_URL` configured in your Infisical instance.
|
||||
</Tip>
|
||||
|
||||
<Note>
|
||||
If you have a GitLab group, you can create an OAuth application under it in your group Settings > Applications.
|
||||
</Note>
|
||||
</Step>
|
||||
<Step title="Add your GitLab OAuth application credentials to Infisical">
|
||||
Obtain the **Application ID** and **Secret** for your GitLab OAuth application.
|
||||
|
||||
|
||||
|
||||
Back in your Infisical instance, add two new environment variables for the credentials of your GitLab OAuth application:
|
||||
|
||||
- `CLIENT_ID_GITLAB`: The **Application ID** of your GitLab OAuth application.
|
||||
- `CLIENT_SECRET_GITLAB`: The **Secret** of your GitLab OAuth application.
|
||||
|
||||
Once added, restart your Infisical instance and use the GitLab App Connection.
|
||||
</Step>
|
||||
</Steps>
|
||||
</Accordion>
|
||||
|
||||
## Setup GitLab OAuth Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page.
|
||||
|
||||
</Step>
|
||||
<Step title="Add Connection">
|
||||
Select the **GitLab App Connection** option from the connection options modal.
|
||||
|
||||
</Step>
|
||||
<Step title="Choose OAuth Method">
|
||||
Select the **OAuth** method and click **Connect to GitLab**.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Grant Access">
|
||||
You will be redirected to GitLab to grant Infisical access to your GitLab account. Once granted, you will be redirected back to Infisical's App Connections page.
|
||||
|
||||
</Step>
|
||||
<Step title="Connection Created">
|
||||
Your **GitLab App Connection** is now available for use.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
</Tab>
|
||||
|
||||
<Tab title="Access Token Method">
|
||||
The Access Token method uses a GitLab access token for authentication, providing a straightforward setup process.
|
||||
|
||||
## Generate GitLab Access Token
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Personal Access Token">
|
||||
Personal access tokens provide access to your GitLab account and all projects you have access to.
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to Access Tokens">
|
||||
Log in to your GitLab account and navigate to User Settings > Access tokens. Click **Add new token** to create a new personal access token.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Configure Token">
|
||||
Fill in the token details:
|
||||
- **Token name**: A descriptive name for the token (e.g., "connection-token")
|
||||
- **Expiration date**: Set an appropriate expiration date
|
||||
- **Select scopes**: Choose the **api** scope for full API access
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Copy Token">
|
||||
Copy the generated token immediately as it won't be shown again.
|
||||
|
||||
|
||||
|
||||
<Warning>
|
||||
Keep your access token secure and do not share it. Anyone with access to this token can access your GitLab account and projects.
|
||||
</Warning>
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
|
||||
<Tab title="Project Access Token">
|
||||
Project access tokens provide access to a specific GitLab project, offering more granular control.
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to Project Settings">
|
||||
Go to your GitLab project and navigate to Settings > Access Tokens. Click **Add new token** to create a new project access token.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Configure Token">
|
||||
Fill in the token details:
|
||||
- **Token name**: A descriptive name for the token
|
||||
- **Expiration date**: Set an appropriate expiration date
|
||||
- **Select role**: Choose **Owner** or higher role
|
||||
- **Select scopes**: Choose the **api** scope for API access
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Copy Token">
|
||||
Copy the generated token immediately as it won't be shown again.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Setup GitLab Access Token Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page.
|
||||
|
||||
</Step>
|
||||
<Step title="Add Connection">
|
||||
Select the **GitLab App Connection** option from the connection options modal.
|
||||
|
||||
</Step>
|
||||
<Step title="Configure Access Token">
|
||||
Select the **Access Token** method and paste your GitLab access token in the provided field.
|
||||
|
||||
|
||||
|
||||
Click **Connect** to establish the connection.
|
||||
</Step>
|
||||
<Step title="Connection Created">
|
||||
Your **GitLab App Connection** is now available for use.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Info>
|
||||
Access Token connections require manual token rotation when your GitLab access token expires or is regenerated. Monitor your connection status and update the token as needed.
|
||||
</Info>
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
Reference in New Issue
Block a user