Change custom domain on Commercial Edition #177
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughExpands the Plane custom domain guide for self-hosting: clarifies Prime CLI applicability, adds a downtime warning, provides commands to check and update domain-related environment variables, details restarting Prime services, and extends Community Edition guidance for .env updates, DNS A records, and reverse proxy configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @self-hosting/govern/custom-domain.mdx:
- Around line 55-63: Under the "Restart Plane services" section, remove the
leading four-space indentation from the paragraph and fenced code block so the
header, the explanatory line ("Apply your configuration changes by restarting
Plane:"), the code fence (```bash), the command (sudo prime-cli restart), and
the following sentence ("This process typically takes a few minutes...") are all
flush with the left margin; ensure the code block uses a proper fenced block
(```bash ... ```) with no extra spaces before the backticks or the command.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
self-hosting/govern/custom-domain.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (4)
self-hosting/govern/custom-domain.mdx (4)
6-16: LGTM!The introduction clearly explains the use case, and the warnings about Prime CLI requirements and downtime planning are well-placed and helpful for users.
17-34: LGTM!Clear instructions for identifying variables that need updating. The example output helps users understand what to expect.
35-53: LGTM!Clear step-by-step instructions with proper formatting notes for CORS configuration.
64-112: No changes detected in this section.The Community Edition accordion content appears to be existing documentation shown for context. No review comments needed for unchanged content.
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
self-hosting/govern/custom-domain.mdx (1)
88-88: Ambiguous cross-references need clarification.The phrases "follow the steps here" and "follow these steps" don't clearly indicate which sections to follow. Consider referencing the section names explicitly.
📝 Suggested fix
-If you are hosting Plane on a public IP, then follow the steps here. However, if you are hosting Plane on an internal IP then follow these steps. +If you are hosting Plane on a public IP, follow the **Set DNS A record** section below. If you are hosting Plane on an internal IP, follow the **Configure reverse proxy** section instead.
🤖 Fix all issues with AI agents
In @self-hosting/govern/custom-domain.mdx:
- Around line 57-64: The "Restart Plane services" section has extra 4-space
indentation that causes inconsistent MDX rendering; remove the leading spaces so
the paragraph and fenced code block are left-aligned with the section header,
replacing the indented "sudo prime-cli restart" and surrounding triple backticks
with an unindented code fence (```bash ... ```), and unindent the following
sentence so it reads as a normal paragraph under the header; locate the "Restart
Plane services" heading and the indented command "sudo prime-cli restart" to
apply this change.
🧹 Nitpick comments (1)
self-hosting/govern/custom-domain.mdx (1)
23-25: Consider quoting the placeholder or adding clarification.The angle brackets in
<old_domain>might confuse users or cause shell interpretation issues. Consider using quotes or adding an example showing the actual substitution.📝 Suggested improvement
```bash -cat /opt/plane/plane.env | grep <old_domain> +cat /opt/plane/plane.env | grep "old_domain"
+Replace
old_domainwith your actual current domain (e.g.,grep "example.com").</details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5304bdb3feee9d2a9e8de6e6a3589d2830e64f51 and 9f4aa50b5ad2c38df999409e7c74f4e7e8b2b19d. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `self-hosting/govern/custom-domain.mdx` </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)</summary> * GitHub Check: Cursor Bugbot </details> <details> <summary>🔇 Additional comments (3)</summary><blockquote> <details> <summary>self-hosting/govern/custom-domain.mdx (3)</summary><blockquote> `6-17`: **Well-structured introduction with appropriate warnings.** The clarification about Prime CLI being Docker-only and the downtime warning are helpful additions that set proper expectations for users before they begin the process. --- `37-55`: **Clear instructions for updating environment variables.** The configuration requirements note about protocol usage and CORS formatting is helpful for avoiding common mistakes. --- `90-112`: **DNS and reverse proxy guidance is clear and comprehensive.** The instructions appropriately cover both public IP (DNS A record) and internal IP (reverse proxy) scenarios with enough detail to guide users while acknowledging that specific implementations vary. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Enhances the custom domain docs with explicit steps to change domains post-install for Commercial Edition and clarifies configuration for Community Edition.
grep <old_domain>in/opt/plane/plane.env), editDOMAIN_NAME,SITE_ADDRESS,WEB_URL, andCORS_ALLOWED_ORIGINS, then restart viaprime-cli restart.env(WEB_URL,CORS_ALLOWED_ORIGINS) and configure DNS A record (public IP) or reverse proxy/CNAME (internal IP)Written by Cursor Bugbot for commit d2e611f. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.