Skip to content

Commit adde579

Browse files
committed
Added GitLab configuration
1 parent 16dd33f commit adde579

File tree

5 files changed

+63
-1
lines changed

5 files changed

+63
-1
lines changed
124 KB
Loading
63 KB
Loading
84.2 KB
Loading

mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@
9494
"group": "Integrations",
9595
"pages": [
9696
"self-hosting/govern/integrations/github",
97-
"self-hosting/govern/integrations/slack"
97+
"self-hosting/govern/integrations/slack",
98+
"self-hosting/govern/integrations/gitlab"
9899
]
99100
},
100101
"self-hosting/govern/reverse-proxy",
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title : Configure GitLab Application for Plane integration
3+
sidebarTitle: GitLab
4+
---
5+
6+
This guide walks you through setting up a GitLab application to enable GitLab integration for your Plane workspace on a self-hosted instance. Since self-hosted environments don’t come pre-configured for GitLab, you’ll need to create an application, configure authentication, and set the necessary permissions to ensure seamless integration.
7+
8+
In this guide, you’ll:
9+
10+
1. [Create and configure a GitLab Application](/self-hosting/govern/integrations/gitlab#create-a-gitlab-application)
11+
2. [Configure your Plane instance](/self-hosting/govern/integrations/gitlab#configure-plane-instance)
12+
13+
## Create GitLab Application
14+
15+
1. On the left sidebar in GitLab, select your avatar.
16+
17+
2. Select **Preferences**.
18+
19+
3. Navigate to the **Applications** tab.
20+
21+
4. Click on **Add new application** to begin the setup.
22+
![Add GitLab application](/images/integrations/gitlab/add-gitlab-application.webp)
23+
24+
5. Provide a **Name** for your application.
25+
26+
6. Enter the following **Redirect URI**, replacing [YOUR_DOMAIN] with your actual domain:
27+
```bash
28+
https://[YOUR_DOMAIN]/silo/api/gitlab/auth/callback
29+
```
30+
7. You can choose to check or leave the **Confidential** box unchecked—both options work for Plane.
31+
32+
![Add app details](/images/integrations/gitlab/add-app-details.webp)
33+
34+
8. Set permissions by selecting the required **Scopes**. The table below explains each scope:
35+
36+
|Permission|Explanation|
37+
|----------|-----------|
38+
|`api`|Grants full read/write access to the API, including all groups, projects, container registry, dependency proxy, and package registry. Required for API requests.|
39+
|`read_api`|Allows read-only access to all groups, projects, container registry, and package registry.|
40+
|`read_user`|Grants read-only access to user profiles via the /user API endpoint, including username, public email, and full name. Also provides access to /users endpoints.|
41+
|`read_repository`|Enables read-only access to repositories in private projects via Git-over-HTTP or the Repository Files API.|
42+
|`write_repository`|Allows read/write access to repositories on private projects via Git-over-HTTP (not through the API).|
43+
|`profile`|Grants read-only access to the user's profile data using OpenID Connect.|
44+
|`email`|Provides read-only access to the user's primary email address using OpenID Connect.|
45+
46+
9. Click **Save Application** to finalize the setup.
47+
48+
## Configure Plane instance
49+
50+
1. Copy the **Application ID** and **Secret** from the newly created application.
51+
![Copy credentials](/images/integrations/gitlab/copy-credentials.webp)
52+
53+
2. Add these environment variables with the values to your Plane instance's `.env` file.
54+
55+
```bash
56+
GITLAB_CLIENT_ID=<application_id>
57+
GITLAB_CLIENT_SECRET=<secret>
58+
```
59+
3. Save the file and restart the instance.
60+
61+
4. Once you've completed the instance configuration, [activate the GitLab integration in Plane](https://docs.plane.so/integrations/gitlab).

0 commit comments

Comments
 (0)