You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A self-hosted GitHub instance deployed on your own infrastructure
20
20
21
21
:::tip
22
-
GitHub Cloud has its own integration page in Plane's settings. GitHub Enterprise Cloud (GHE.com) and GitHub Enterprise Server share the same page — a toggle at the top of the configuration form switches between the two.
22
+
GitHub Cloud has its own integration page in Plane's settings. GitHub Enterprise Cloud (GHE.com) and GitHub Enterprise Server share the same page - a toggle at the top of the configuration form switches between the two.
23
23
:::
24
24
25
25
## What the integration does
@@ -61,7 +61,7 @@ Link your GitHub organization to your Plane workspace to start syncing repositor
61
61
> [!CAUTION] Plane self-hosted instances
62
62
> If you're running a self-hosted instance of Plane, you'll need to first create and configure a GitHub App to get GitHub integration working. Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-cloud#create-github-app) first before diving into the steps on this page.
1. Go to **Settings → Integrations → GitHub** in your Plane workspace.
67
67
2. Click **Connect**.
@@ -74,12 +74,14 @@ The integration page shows the connected organization name and avatar. Plane has
74
74
75
75
== GitHub Enterprise Cloud {#ghe-cloud}
76
76
77
+
GitHub Enterprise Cloud (GHE.com) organizations have a dedicated subdomain (`<your-org>.ghe.com`). This is a distinct setup from GitHub Cloud - you create your own GitHub App on your GHE.com organization and provide Plane with its credentials.
78
+
77
79
> [!CAUTION] Plane Cloud and self-hosted instances
78
-
> This integration is currently only available on Plane Cloud. Support for the Commercial Edition is coming soon.
80
+
> Before you can integrate with GitHub Enterprise Cloud, you must first create and configure a GitHub App. This is required for both Plane Cloud and self-hosted users.
79
81
>
80
-
> Before you can integrate with GitHub Enterprise Cloud (GHE.com) , you must first create and configure a GitHub App in your GitHub Enterprise Server instance. This is required for both Plane Cloud and self-hosted users. Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise-cloud#create-github-app) first before diving into the steps on this page.
82
+
> Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise#create-github-app) first before diving into the steps on this section.
1. Go to **Settings → Integrations → GitHub Enterprise** in your Plane workspace.
85
87
2. Click **Connect**.
@@ -90,7 +92,7 @@ The integration page shows the connected organization name and avatar. Plane has
90
92
The numeric identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **App ID**.
91
93
92
94
**App slug**
93
-
The URL-safe name assigned to your app, visible in the app's GitHub URL. Find it in the URL when viewing your app settings — the segment after `/apps/`
95
+
The URL-safe name assigned to your app, visible in the app's GitHub URL. Find it in the URL when viewing your app settings - the segment after `/apps/`
94
96
Example: `my-plane-app`
95
97
96
98
**Enterprise slug**
@@ -104,10 +106,10 @@ The integration page shows the connected organization name and avatar. Plane has
104
106
The OAuth client identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **Client ID**.
105
107
106
108
**Client secret**
107
-
The OAuth client secret generated from your GHE.com GitHub App settings. It is shown only once when generated — use the value you copied at that time.
109
+
The OAuth client secret generated from your GHE.com GitHub App settings. It is shown only once when generated - use the value you copied at that time.
108
110
109
111
**Webhook secret**
110
-
The secret string you set when creating the GitHub App on GHE.com. Must match exactly what is configured on the app — Plane uses it to verify incoming webhook signatures.
112
+
The secret string you set when creating the GitHub App on GHE.com. Must match exactly what is configured on the app - Plane uses it to verify incoming webhook signatures.
111
113
112
114
**Private key**
113
115
The base64-encoded contents of the `.pem` private key file you downloaded from your GHE.com GitHub App settings. To encode it, run `base64 -i your-key.pem` and paste the full output.
@@ -124,7 +126,7 @@ Plane stores these credentials tied to your workspace and uses them to authentic
124
126
>
125
127
> Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise#create-github-app) first before diving into the steps on this section.
1. Go to **Settings → Integrations → GitHub Enterprise Server** in your Plane workspace.
130
132
2. Click **Connect**.
@@ -145,10 +147,10 @@ Plane stores these credentials tied to your workspace and uses them to authentic
145
147
The OAuth client identifier for your GitHub App. Find it on your GHES GitHub App settings page under **Client ID**.
146
148
147
149
**Client Secret**
148
-
The OAuth client secret generated from your GHES GitHub App settings. It is shown only once when generated — use the value you copied at that time.
150
+
The OAuth client secret generated from your GHES GitHub App settings. It is shown only once when generated - use the value you copied at that time.
149
151
150
152
**Webhook Secret**
151
-
The secret string you set when creating the GitHub App on GHES. Must match exactly what is configured on the app — Plane uses it to verify incoming webhook signatures.
153
+
The secret string you set when creating the GitHub App on GHES. Must match exactly what is configured on the app - Plane uses it to verify incoming webhook signatures.
152
154
153
155
**Private Key**
154
156
The contents of the `.pem` private key file you downloaded from your GHES GitHub App settings. Paste the full PEM content including the `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` lines.
@@ -170,7 +172,7 @@ When this connection is enabled, comments made in Plane will appear in GitHub un
170
172
171
173
Workspace admins can connect their personal GitHub accounts from the GitHub configuration page.
172
174
173
-

175
+

174
176
175
177
1. In the **Connect personal account** section under **Integrations**, click **Connect**.
176
178
2. Review the required permissions GitHub requests and authorize.
@@ -183,7 +185,7 @@ Only one Workspace Admin can connect their GitHub account via Workspace Settings
183
185
All other workspace members can connect their personal GitHub accounts from the **Connections** page in
184
186
Workspace settings.
185
187
186
-

188
+

187
189
188
190
1. Go to [Workspace Settings](/core-concepts/workspaces/overview#access-workspace-settings).
189
191
2. Select the **Connections** tab in the sidebar.
@@ -236,32 +238,18 @@ After configuring project work item sync, you can link existing GitHub issues in
236
238
#### GitHub → Plane
237
239
238
240
1. In your GitHub repository, add the `Plane` label to any issue you want to sync.
0 commit comments