-
Notifications
You must be signed in to change notification settings - Fork 7
[DOCSW-552] Enhance airgapped edition documentation for docker compose deployments #182
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: preview
Are you sure you want to change the base?
Conversation
* Fixes from support threads * minor fixes
Merge changes to master branch
Update master branch with changes
docs: restructure API docs and update Work Item terminology (#163)
feat: add options field docs in create property API
Merge to master branch
chore: update MCP server docs with latest http transport changes
…y Docker image preparation, and add OpenSearch as an alternative service. Streamline installation steps and improve environment variable configuration instructions.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation updates for airgapped deployments: adds OpenSearch as a recommended alternative to the Kubernetes guide and significantly restructures the Docker Compose guide to shift from pre-packaged offline bundle model to a private registry-based deployment approach with pre-configured Docker images. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
…g Docker images, highlight important infrastructure images that require separate handling, and clarify configuration steps for services.
|
Linked to Plane Work Item(s) This comment was auto-generated by Plane |
…into chore-update-airgapped-docker
…s for clarity, removing redundant contact information for license acquisition.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
self-hosting/methods/airgapped-edition-kubernetes.mdx (1)
56-62: Inconsistent Valkey image reference.Line 57 references
valkey:7.2.5-alpinewhile Line 135 (unchanged, but relevant) usesvalkey/valkey:7.2.11-alpine. The Docker Compose guide (airgapped-edition.mdx) consistently usesvalkey/valkey:7.2.11-alpine. This discrepancy could confuse users preparing their airgapped environment.Suggested fix
- `valkey:7.2.5-alpine` + - `valkey/valkey:7.2.11-alpine`
🧹 Nitpick comments (1)
self-hosting/methods/airgapped-edition.mdx (1)
52-62: Consider adding version placeholder clarification.The
<plane-version>placeholder in the download URLs should be explicitly called out, with guidance on where users can find available versions. The Kubernetes guide references Artifact Hub for version information.Suggested addition
2. **Download Docker Compose configuration** Download the Docker Compose configuration files from the official release. + Replace `<plane-version>` with your target version (e.g., `1.6.4`). Check for the latest version at [Prime releases](https://prime.plane.so/releases). ```bash # Download docker-compose.yml
Description
This pull request updates the documentation for deploying Plane in airgapped environments, with a focus on clarifying prerequisites, improving instructions for Docker-based deployments, and ensuring OpenSearch is included among recommended infrastructure alternatives. The changes streamline the setup process, emphasize the use of managed services for reliability, and enhance clarity for users preparing and running airgapped installations.
Type of Change
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.