Skip to content

Commit d3a57bb

Browse files
authored
Merge pull request #153 from makeplane/gitlab-self-managed
GitLab self-managed configuration
2 parents 2d0ba93 + b3269da commit d3a57bb

File tree

2 files changed

+88
-10
lines changed

2 files changed

+88
-10
lines changed

self-hosting/govern/integrations/github.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,13 @@ To configure GitHub integration, you'll need to create a GitHub App within your
7474

7575
1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.
7676

77-
2. Click **New GitHub App**.
77+
2. Click **New GitHub App**.
7878
![Create GitHub App](/images/integrations/github/create-github-app.webp)
7979

80-
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
80+
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
8181
![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp)
8282

83-
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
83+
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
8484

8585
**For Plane cloud instance**
8686

@@ -99,7 +99,7 @@ To configure GitHub integration, you'll need to create a GitHub App within your
9999
These URLs allow Plane to verify and enable workspace connection with the Github App.
100100
![Add Callback URL](/images/integrations/github/add-callback-url.webp)
101101

102-
5. In the **Post installation** section, add the below **Setup URL**.
102+
5. In the **Post installation** section, add the below **Setup URL**.
103103

104104
**For Plane cloud instance**
105105
```bash
@@ -114,9 +114,9 @@ To configure GitHub integration, you'll need to create a GitHub App within your
114114
Redirects users to this URL after GitHub app installation.
115115
![Add setup URL](/images/integrations/github/add-setup-url.webp)
116116

117-
6. Turn on **Redirect on update**.
117+
6. Turn on **Redirect on update**.
118118

119-
7. In the **Webhook** section, add the below **Webhook URL**.
119+
7. In the **Webhook** section, add the below **Webhook URL**.
120120

121121
**For Plane cloud instance**
122122
```bash

self-hosting/govern/integrations/gitlab.mdx

Lines changed: 82 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,29 @@ sidebarTitle: GitLab
55

66
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.
77

8+
This guide covers configuration for both:
9+
10+
- **[GitLab.com](/self-hosting/govern/integrations/gitlab?edition=gitlab-cloud#create-gitlab-application)**
11+
The standard cloud-hosted GitLab service
12+
13+
- **[GitLab Self-managed](/self-hosting/govern/integrations/gitlab?edition=gitlab-self-managed#create-gitlab-application)**
14+
Self-hosted GitLab instances for organizations with specific compliance or security requirements
15+
816
In this guide, you’ll:
917

10-
1. [Create and configure a GitLab Application](/self-hosting/govern/integrations/gitlab#create-a-gitlab-application)
18+
1. [Create and configure a GitLab Application](/self-hosting/govern/integrations/gitlab#create-gitlab-application)
1119
2. [Configure your Plane instance](/self-hosting/govern/integrations/gitlab#configure-plane-instance)
1220

21+
<Warning>
22+
**Activate GitLab integration**
23+
24+
After creating and configuring the GitLab application and configuring the instance as detailed on this page, you'll need to [setup the GitLab integration](https://docs.plane.so/integrations/gitlab) within Plane.
25+
</Warning>
26+
1327
## Create GitLab Application
1428

29+
<Tabs>
30+
<Tab title="GitLab Cloud">
1531
1. On the left sidebar in GitLab, select your avatar.
1632

1733
2. Select **Preferences** tab.
@@ -27,7 +43,7 @@ In this guide, you’ll:
2743
```bash
2844
https://[YOUR_DOMAIN]/silo/api/gitlab/auth/callback
2945
```
30-
7. You can choose to check or leave the **Confidential** box unchecked—both options work for Plane.
46+
7. Check the **Confidential** box.
3147

3248
![Add app details](/images/integrations/gitlab/add-app-details.webp)
3349

@@ -39,14 +55,65 @@ In this guide, you’ll:
3955
|`read_api`|Allows read-only access to all groups, projects, container registry, and package registry.|
4056
|`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.|
4157
|`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).|
4358
|`profile`|Grants read-only access to the user's profile data using OpenID Connect.|
4459
|`email`|Provides read-only access to the user's primary email address using OpenID Connect.|
4560

4661
9. Click **Save Application** to finalize the setup.
62+
</Tab>
63+
64+
<Tab title="GitLab Self-managed">
65+
1. Log in to your GitLab instance.
66+
2. Click on your profile icon in the top-right corner.
67+
3. From the dropdown menu that appears, select **Edit profile**.
68+
4. Look for and select the **Applications** option within this menu.
69+
70+
![GitLab Applications](https://media.docs.plane.so/integrations/gitlab/gitlab-applications.webp#center)
71+
72+
5. On the Applications page, click **Add new application** to begin configuring your OAuth application.
73+
74+
Fill in the application details with the following configuration:
75+
76+
- **Name**
77+
Enter a descriptive name for your application (e.g., `Plane Local Dev` or `Plane Integration`).
78+
79+
- **Redirect URI**
80+
The redirect URI depends on your Plane deployment:
81+
82+
**For Plane Cloud:**
83+
```
84+
https://silo.plane.so/api/oauth/gitlab-enterprise/auth/callback
85+
```
86+
87+
**For Plane Self-Hosted:**
88+
```
89+
https://<your-domain>/silo/api/oauth/gitlab-enterprise/auth/callback
90+
```
91+
92+
Replace `<your-domain>` with your actual Plane instance domain.
93+
94+
- **Confidential**
95+
Keep the **Confidential** checkbox enabled. This ensures the application uses a client secret for secure authentication.
96+
97+
- **Scopes**
98+
Select the following scopes to grant Plane the necessary permissions:
99+
100+
- **api** - Grants complete read/write access to the API, including all groups and projects
101+
- **read_api** - Grants read access to the API, including all groups and projects
102+
- **read_user** - Grants read-only access to your profile information
103+
- **read_repository** - Grants read-only access to repositories on private projects
104+
- **profile** - Grants read-only access to the user's profile data using OpenID Connect
105+
- **email** - Grants read-only access to the user's primary email address using OpenID Connect
106+
107+
6. Click **Save application** to create the OAuth application.
108+
</Tab>
109+
</Tabs>
110+
47111

48112
## Configure Plane instance
49113

114+
<Tabs>
115+
<Tab title="GitLab Cloud">
116+
50117
1. Copy the **Application ID** and **Secret** from the newly created application.
51118
![Copy credentials](/images/integrations/gitlab/copy-credentials.webp)
52119

@@ -58,4 +125,15 @@ In this guide, you’ll:
58125
```
59126
3. Save the file and restart the instance.
60127

61-
4. Once you've completed the instance configuration, [activate the GitLab integration in Plane](https://docs.plane.so/integrations/gitlab).
128+
4. Once you've completed the instance configuration, [activate the GitLab integration in Plane](https://docs.plane.so/integrations/gitlab?edition=gitlab-cloud).
129+
130+
</Tab>
131+
132+
<Tab title="GitLab Self-managed">
133+
134+
1. Copy the **Application ID** and **Secret** from the newly created application.
135+
![Copy credentials](/images/integrations/gitlab/copy-credentials.webp)
136+
137+
2. Once you've created the application, [activate the GitLab Self-managed integration in Plane](https://docs.plane.so/integrations/gitlab?edition=gitlab-self-managed).
138+
</Tab>
139+
</Tabs>

0 commit comments

Comments
 (0)