Configure SSL #172
Configure SSL #172
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThese changes introduce documentation for configuring SSL/TLS certificates in Plane Commercial Edition Docker deployments. A new guide is added covering prerequisites, environment variable setup, DNS-based validation, configuration steps, and verification procedures. A corresponding navigation entry is added to the documentation structure. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 0
🧹 Nitpick comments (2)
self-hosting/govern/configure-ssl.mdx (2)
89-98: LGTM!Basic verification steps are provided and appropriate for most users.
For enhanced verification, you could optionally add a command to check certificate details:
# Check certificate details including expiry openssl s_client -connect plane.yourcompany.com:443 -servername plane.yourcompany.com < /dev/null 2>/dev/null | openssl x509 -noout -dates -issuer
6-6: Consider documenting certificate renewal behavior.The guide mentions that Plane handles certificate provisioning and renewal automatically, but doesn't explain when or how renewal occurs. Consider adding a brief note about:
- Automatic renewal timing (e.g., certificates renew 30 days before expiry)
- Whether any user action is required
- How to check renewal logs if needed
This would help users understand the full lifecycle and reduce support questions about certificate expiry.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
mint.json(1 hunks)self-hosting/govern/configure-ssl.mdx(1 hunks)
⏰ 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 (7)
mint.json (1)
118-118: LGTM!The navigation entry is properly positioned within the Configure group and follows the correct format.
self-hosting/govern/configure-ssl.mdx (6)
1-12: LGTM!The introduction clearly defines the scope and provides appropriate guidance for users with external reverse proxies.
14-24: LGTM!Prerequisites are clearly listed with an appropriate DNS warning. The requirement for ports 80 and 443 is mentioned, though later the guide notes DNS validation as an alternative when port 80 is blocked.
26-55: LGTM!The configuration variables are clearly explained with good examples distinguishing between SITE_ADDRESS (no protocol) and WEB_URL (with protocol).
74-87: LGTM!The restart process is clearly explained with appropriate timing expectations. The step-by-step breakdown helps users understand what's happening during the SSL setup.
101-103: LGTM!The limitation is clearly stated. Users needing custom certificates are already directed to use external reverse proxies in the introduction.
63-68: Regarding plaintext credentials: This is documentation using a placeholder example. Per project conventions, keeping examples simple with concrete placeholder values improves readability for users learning the API configuration.Verify the CERT_ACME_DNS format: The format
CERT_ACME_DNS=acme_dns cloudflare <cloudflare-api-token>should be confirmed against Plane's actual implementation. Standard acme.sh typically uses provider-specific environment variables (e.g.,CF_Token,CF_Keyfor Cloudflare). Confirm this is the correct format for Plane's DNS provider configuration or update the documentation accordingly.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Adds a new self-hosting SSL/TLS setup guide and links it in the docs navigation.
self-hosting/govern/configure-ssl.mdxdetailing Let's Encrypt-based SSL setup, required env vars (CERT_EMAIL,SITE_ADDRESS,WEB_URL), optional DNS validation (CERT_ACME_DNS), restart viaprime-cli, and verification steps.self-hosting/govern/configure-ssltomint.jsonunder Configure.Written by Cursor Bugbot for commit 050a5d4. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.