[SILO-607] debug and add configuration mismatch for SILO_BASE_URL in troubleshooting section #156
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Linked to Plane Work Item(s) This comment was auto-generated by Plane |
WalkthroughAdds a Troubleshooting section to the GitHub integration documentation ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolself-hosting/govern/integrations/github.mdx[uncategorized] ~298-~298: The official name of this software platform is spelled with a capital “H”. (GITHUB) [uncategorized] ~298-~298: The official name of this software platform is spelled with a capital “H”. (GITHUB) [grammar] ~300-~300: There might be a mistake here. (QB_NEW_EN) [uncategorized] ~303-~303: The official name of this software platform is spelled with a capital “H”. (GITHUB) [uncategorized] ~307-~307: The official name of this software platform is spelled with a capital “H”. (GITHUB) Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
self-hosting/govern/integrations/github.mdx (2)
265-287: Use MDX admonitions instead of inline-styled divs for error calloutsInline CSS boxes won’t adapt to light/dark themes and are inconsistent with the rest of the page (which already uses ). Prefer admonitions for all three error snippets here for consistency and accessibility.
Example:
:::danger Failed to create GitHub connection: Invalid keyData :::Repeat similarly for “Invalid request callback URL” and “Application secret value not found…”.
269-281: Tighten wording and fix list-attached code block formatting
- Grammar: “follow the steps below:” (not “follow the below steps.”)
- Properly attach fenced code blocks to list items (indent consistently).
- Optional: add macOS-compatible base64 note.
-This error usually occurs when the private key is not correctly generated. To fix this, follow the below steps. +This error usually occurs when the private key is invalid or incorrectly formatted. To fix it, follow the steps below: 1. Generate a new private key. -2. Convert the private key to base64. - ```bash - cat private_key.pem | base64 -w 0 - ``` +2. Convert the private key to base64: + ```bash + # Linux (GNU coreutils) + base64 -w 0 private_key.pem + # macOS + base64 < private_key.pem | tr -d '\n' + ``` 3. Add the private key to the `.env` file. - ```bash - GITHUB_PRIVATE_KEY=<private_key> - ``` + ```bash + GITHUB_PRIVATE_KEY=<private_key> + ``` 4. Save the file and restart the instance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
self-hosting/govern/integrations/github.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
self-hosting/govern/integrations/github.mdx
[uncategorized] ~300-~300: The official name of this software platform is spelled with a capital “H”.
Context: ... follow the below steps. 1. Delete the plane_app_details_github key from redis cache. ```del plane_app...
(GITHUB)
[uncategorized] ~300-~300: The official name of this software platform is spelled with a capital “H”.
Context: ...p_details_githubkey from redis cache. ```del plane_app_details_github```. 2. Set theSILO_BASE_URL` in env w...
(GITHUB)
[grammar] ~302-~302: There might be a mistake here.
Context: ...crets` to reset the application secrets. 4. Try to connect again to the organization...
(QB_NEW_EN)
[uncategorized] ~305-~305: The official name of this software platform is spelled with a capital “H”.
Context: ...the organization account to Plane. ### Github integration suddenly stopped working af...
(GITHUB)
[uncategorized] ~309-~309: The official name of this software platform is spelled with a capital “H”.
Context: ...organization account to Plane. Check in Github App Settings > Optional Features
(GITHUB)
🔇 Additional comments (2)
self-hosting/govern/integrations/github.mdx (2)
294-304: Clarify steps for the “Application secret value not found” error
- Delete the
plane_app_details_githubkey from Redis:redis-cli DEL plane_app_details_github- Set
SILO_BASE_URLin the API server environment (use your self-hosted Plane base URL, including scheme, no trailing slash), then restart the API server:export SILO_BASE_URL=https://<your-domain>- From the API server shell/container, reset the application secrets:
python manage.py reset_marketplace_app_secrets- Reconnect your GitHub organization to Plane.
Please verify:
- The management command
reset_marketplace_app_secretsexists in the codebase.- Whether
SILO_BASE_URLmust also be set in other services (e.g., worker/web containers).
305-309: Fix GitHub capitalization and update setting nameGitHub integration suddenly stopped working after a while
This can occur when User-to-server token expiration is enabled for your GitHub App. To fix:
- Disable the “User-to-server token expiration” option under GitHub App Settings > Optional features, then reconnect your organization account in Plane.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
self-hosting/govern/integrations/github.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
self-hosting/govern/integrations/github.mdx
[uncategorized] ~301-~301: The official name of this software platform is spelled with a capital “H”.
Context: ... follow the below steps. 1. Delete the plane_app_details_github key from redis cache. ```del plane_app...
(GITHUB)
[uncategorized] ~301-~301: The official name of this software platform is spelled with a capital “H”.
Context: ...p_details_githubkey from redis cache. ```del plane_app_details_github```. 2. Set theSILO_BASE_URL` in env w...
(GITHUB)
[grammar] ~303-~303: There might be a mistake here.
Context: ...crets` to reset the application secrets. 4. Try to connect again to the organization...
(QB_NEW_EN)
[uncategorized] ~306-~306: The official name of this software platform is spelled with a capital “H”.
Context: ...the organization account to Plane. ### Github integration suddenly stopped working af...
(GITHUB)
[uncategorized] ~310-~310: The official name of this software platform is spelled with a capital “H”.
Context: ...organization account to Plane. Check in Github App Settings > Optional Features
(GITHUB)
| 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://<your-domain>``` | ||
| 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. |
There was a problem hiding this comment.
Document persistence for SILO_BASE_URL is incorrect
Exporting SILO_BASE_URL only updates the current shell; the API service (especially in Docker/systemd setups) won’t see the change after restart. Instruct readers to update the actual environment configuration file/source that the service loads.
-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>```
+2. Update the `SILO_BASE_URL` in the environment configuration that your API server reads (for example, the `.env` file used by docker-compose) so it points to your Plane self-hosted URL, then restart the API server.
+ ```bash
+ SILO_BASE_URL=https://<your-domain>
+ ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~301-~301: The official name of this software platform is spelled with a capital “H”.
Context: ... follow the below steps. 1. Delete the plane_app_details_github key from redis cache. ```del plane_app...
(GITHUB)
[uncategorized] ~301-~301: The official name of this software platform is spelled with a capital “H”.
Context: ...p_details_githubkey from redis cache. ```del plane_app_details_github```. 2. Set theSILO_BASE_URL` in env w...
(GITHUB)
[grammar] ~303-~303: There might be a mistake here.
Context: ...crets` to reset the application secrets. 4. Try to connect again to the organization...
(QB_NEW_EN)
| ### 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 |
There was a problem hiding this comment.
Use the official “GitHub” casing
Brand guidelines require capitalizing the “H” in “GitHub” (heading and sentence here).
Based on LanguageTool hints.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~306-~306: The official name of this software platform is spelled with a capital “H”.
Context: ...the organization account to Plane. ### Github integration suddenly stopped working af...
(GITHUB)
[uncategorized] ~310-~310: The official name of this software platform is spelled with a capital “H”.
Context: ...organization account to Plane. Check in Github App Settings > Optional Features
(GITHUB)
🤖 Prompt for AI Agents
In self-hosting/govern/integrations/github.mdx around lines 306 to 310, the
heading and sentence use the incorrect casing "Github"; update both occurrences
to the official brand casing "GitHub" (capitalize the G and H, keep rest
lowercase) so the heading and the sentence read "GitHub" and "GitHub App
Settings" respectively; apply the same correction wherever the product name
appears in this section to match brand guidelines.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit