Skip to content

Commit e693855

Browse files
committed
draft for github troubleshoot self hosted
1 parent 452afc6 commit e693855

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

self-hosting/govern/integrations/github.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,3 +256,54 @@ To configure GitHub integration, you'll need to create a GitHub App within your
256256
8. Once you've created the app, [activate the GitHub Enterprise integration in Plane](https://docs.plane.so/integrations/github?edition=github-enterprise#connect-github-organization).
257257
</Tab>
258258
</Tabs>
259+
260+
261+
## Troubleshooting
262+
263+
### Error: Invalid private key
264+
265+
<div style={{color:"#ffffff", backgroundColor:"#333333", padding:"10px", borderRadius:"5px"}}>
266+
Failed to create GitHub connection: Invalid keyData
267+
</div>
268+
269+
This error usually occurs when the private key is not correctly generated. To fix this, follow the below steps.
270+
271+
1. Generate a new private key.
272+
2. Convert the private key to base64.
273+
```bash
274+
cat private_key.pem | base64 -w 0
275+
```
276+
3. Add the private key to the `.env` file.
277+
```bash
278+
GITHUB_PRIVATE_KEY=<private_key>
279+
```
280+
4. Save the file and restart the instance.
281+
282+
### Unable to connect GitHub organization account or personal account
283+
284+
<div style={{color:"#ffffff", backgroundColor:"#333333", padding:"10px", borderRadius:"5px"}}>
285+
Error: Invalid request callback URL.
286+
</div>
287+
288+
This error usually occurs when the callback URL is not correctly configured or the GitHub App is not marked public. To fix this, follow the below steps.
289+
290+
1. Check if the callback URL is correctly configured.
291+
2. Check if your GitHub App is marked public.
292+
293+
294+
<div style={{color:"#ffffff", backgroundColor:"#333333", padding:"10px", borderRadius:"5px"}}>
295+
Error: Application secret value not found for key: x-github-id
296+
</div>
297+
298+
This error usually occurs when the application secret is not correctly configured. To fix this, follow the below steps.
299+
300+
1. Delete the `plane_app_details_github` key from redis cache. ```del plane_app_details_github```.
301+
2. Set the `SILO_BASE_URL` in env with plane self hosted url and restart the api server. ```export SILO_BASE_URL=https://<your-domain>```
302+
3. Run this command in api server shell `python manage.py reset_marketplace_app_secrets` to reset the application secrets.
303+
4. Try to connect again to the organization account to Plane.
304+
305+
### Github integration suddenly stopped working after a while
306+
307+
This error usually occurs when the GitHub integration is not correctly configured. To fix this, follow the below steps.
308+
309+
1. Make sure you've `opted out` of Server Token expiration and reconnect once again to the organization account to Plane. Check in Github App Settings > Optional Features

0 commit comments

Comments
 (0)