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
This guide walks you through setting up a GitHub App to enable GitHub integration for your Plane workspace on a self-hosted instance. Since self-hosted environments don’t come pre-configured for GitHub, you’ll need to set up the necessary authentication, permissions, and webhooks to ensure smooth integration.
6. Retrieve the following details from the **General** tab:
200
+
- App ID
201
+
- Client ID
202
+
- Client secret
203
+
- GitHub App name
204
+
- Private key
205
+
206
+
7. Before adding the Private key as an environment variable, you’ll need to convert it to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command to convert the key to base64:
207
+
208
+
```bash
209
+
cat private_key.pem | base64 -w 0
210
+
```
211
+
212
+
8. Add these environment variables with the values to your Plane instance's `.env` file.
213
+
214
+
```bash
215
+
GITHUB_CLIENT_ID=<client_id>
216
+
GITHUB_CLIENT_SECRET=<client_secret>
217
+
GITHUB_APP_NAME=<app_name>
218
+
GITHUB_APP_ID=<app_id>
219
+
GITHUB_PRIVATE_KEY=<private_key>
220
+
```
221
+
222
+
9. Save the file and restart the instance.
223
+
224
+
10. Once you've completed the instance configuration, [activate the GitHub integration in Plane](https://docs.plane.so/integrations/github).
225
+
226
+
</Tab>
227
+
228
+
<Tabtitle="GitHub Enterprise Server">
229
+
103
230
1. Go back to **Settings \> Developer Settings \> GitHub Apps**.
104
231
105
232
2. Click **Edit** on the GitHub you created.
@@ -116,26 +243,16 @@ To configure GitHub integration, you'll need to create a GitHub App within your
116
243
117
244
6. Retrieve the following details from the **General** tab:
118
245
- App ID
246
+
- App Slug (You can find this in browser url)
119
247
- Client ID
120
248
- Client secret
121
-
- GitHub App name
122
249
- Private key
123
250
124
-
7.Before adding the Private key as an environment variable, you’ll need to convert it to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command to convert the key to base64:
251
+
7.Convert the Private key to convert it to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command to convert the key to base64:
125
252
```bash
126
253
cat private_key.pem | base64 -w 0
127
254
```
128
255
129
-
8. Add these environment variables with the values to your Plane instance's `.env` file.
130
-
131
-
```bash
132
-
GITHUB_CLIENT_ID=<client_id>
133
-
GITHUB_CLIENT_SECRET=<client_secret>
134
-
GITHUB_APP_NAME=<app_name>
135
-
GITHUB_APP_ID=<app_id>
136
-
GITHUB_PRIVATE_KEY=<private_key>
137
-
```
138
-
139
-
9. Save the file and restart the instance.
140
-
141
-
10. Once you've completed the instance configuration, [activate the GitHub integration in Plane](https://docs.plane.so/integrations/github).
256
+
8. Once you've created the app, [activate the GitHub Enterprise integration in Plane](https://docs.plane.so/integrations/github#connect-github-enterprise-organization).
0 commit comments