From e693855f2c5f99ccac3f3ee55edcaa1c85625c72 Mon Sep 17 00:00:00 2001 From: Saurabhkmr98 Date: Thu, 16 Oct 2025 17:35:25 +0530 Subject: [PATCH 1/3] draft for github troubleshoot self hosted --- self-hosting/govern/integrations/github.mdx | 51 +++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/self-hosting/govern/integrations/github.mdx b/self-hosting/govern/integrations/github.mdx index ecc90e1..3619fc1 100644 --- a/self-hosting/govern/integrations/github.mdx +++ b/self-hosting/govern/integrations/github.mdx @@ -256,3 +256,54 @@ To configure GitHub integration, you'll need to create a GitHub App within your 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). + + +## Troubleshooting + +### Error: Invalid private key + +
+ Failed to create GitHub connection: Invalid keyData +
+ +This error usually occurs when the private key is not correctly generated. To fix this, follow the below steps. + +1. Generate a new private key. +2. Convert the private key to base64. + ```bash + cat private_key.pem | base64 -w 0 + ``` +3. Add the private key to the `.env` file. + ```bash + GITHUB_PRIVATE_KEY= + ``` +4. Save the file and restart the instance. + +### Unable to connect GitHub organization account or personal account + +
+ Error: Invalid request callback URL. +
+ +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. + +1. Check if the callback URL is correctly configured. +2. Check if your GitHub App is marked public. + + +
+ Error: Application secret value not found for key: x-github-id +
+ +This error usually occurs when the application secret is not correctly configured. To fix this, follow the below steps. + +1. Delete the `plane_app_details_github` key from redis cache. ```del plane_app_details_github```. +2. Set the `SILO_BASE_URL` in env with plane self hosted url and restart the api server. ```export SILO_BASE_URL=https://``` +3. Run this command in api server shell `python manage.py reset_marketplace_app_secrets` to reset the application secrets. +4. Try to connect again to the organization account to Plane. + +### Github integration suddenly stopped working after a while + +This error usually occurs when the GitHub integration is not correctly configured. To fix this, follow the below steps. + +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 \ No newline at end of file From dd60617f5d4e80cc0bd5794e639b867cd8400f51 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 16 Oct 2025 17:47:15 +0530 Subject: [PATCH 2/3] changed error block --- self-hosting/govern/integrations/github.mdx | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/self-hosting/govern/integrations/github.mdx b/self-hosting/govern/integrations/github.mdx index 3619fc1..ecca89e 100644 --- a/self-hosting/govern/integrations/github.mdx +++ b/self-hosting/govern/integrations/github.mdx @@ -260,10 +260,10 @@ To configure GitHub integration, you'll need to create a GitHub App within your ## Troubleshooting -### Error: Invalid private key +### Invalid private key -
- Failed to create GitHub connection: Invalid keyData +
+ Error: Failed to create GitHub connection: Invalid keyData
This error usually occurs when the private key is not correctly generated. To fix this, follow the below steps. @@ -281,8 +281,8 @@ This error usually occurs when the private key is not correctly generated. To fi ### Unable to connect GitHub organization account or personal account -
- Error: Invalid request callback URL. +
+ Error: Invalid request callback URL.
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. @@ -290,9 +290,10 @@ This error usually occurs when the callback URL is not correctly configured or t 1. Check if the callback URL is correctly configured. 2. Check if your GitHub App is marked public. +### Application secret value not found -
- Error: Application secret value not found for key: x-github-id +
+ Error: Application secret value not found for key: x-github-id
This error usually occurs when the application secret is not correctly configured. To fix this, follow the below steps. From d350657e5b8dd282a035764fecfd31a2d2adca3e Mon Sep 17 00:00:00 2001 From: Saurabhkmr98 Date: Thu, 16 Oct 2025 18:08:18 +0530 Subject: [PATCH 3/3] update scopes for github app --- self-hosting/govern/integrations/github.mdx | 3 --- 1 file changed, 3 deletions(-) diff --git a/self-hosting/govern/integrations/github.mdx b/self-hosting/govern/integrations/github.mdx index ecca89e..7b47c0f 100644 --- a/self-hosting/govern/integrations/github.mdx +++ b/self-hosting/govern/integrations/github.mdx @@ -144,10 +144,7 @@ To configure GitHub integration, you'll need to create a GitHub App within your |Permission           |Access level    |Purpose| |---------|---------------------|-----------| - |Commit statuses|Read-only|Allows the GitHub app to read and update commit statuses, indicating whether a commit has passed checks (e.g., CI/CD pipelines).| - |Contents|Read and write|Grants access to read and modify repository contents, including reading files, creating commits, and updating files.| |Issues|Read and write|Enables reading, creating, updating, closing, and commenting on issues within the repository.| - |Merge queues|Read-only|Allows interaction with merge queues to manage the order of pull request merges.| |Metadata|Read-only|Provides read-only access to repository metadata, such as its name, description, and visibility.| |Pull requests|Read and write|Allows reading, creating, updating, merging, and commenting on pull requests.|