Skip to content

Conversation

@akshat5302
Copy link
Member

@akshat5302 akshat5302 commented Jan 20, 2026

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

  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Updated airgapped deployment guides to use Docker Compose with private registry configuration instead of offline bundles.
    • Added OpenSearch as a recommended alternative service for airgapped environments.
    • Simplified installation and startup procedures with streamlined configuration steps.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Jan 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
developer-docs Error Error Jan 21, 2026 10:28am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Jan 20, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Airgapped Kubernetes Guide
self-hosting/methods/airgapped-edition-kubernetes.mdx
Adds OpenSearch as recommended alternative service in warning section; includes OpenSearch Docker image in infrastructure images list for airgapped pre-pull/transfer.
Airgapped Docker Compose Guide
self-hosting/methods/airgapped-edition.mdx
Comprehensive rewrite: replaces pre-packaged offline bundle narrative with private registry-based deployment model. Updates prerequisites to reference managed services alternatives (MinIO, Redis, PostgreSQL, RabbitMQ, OpenSearch). Revises installation flow from license/downloader acquisition to Docker image preparation, docker-compose.yml download, and private registry configuration. Introduces MACHINE_SIGNATURE generation and domain configuration steps. Simplifies startup to direct docker compose up command with standardized health checks. Restructures licensing activation flow numbering and updates UI label references.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A registry awaits, no bundles to unpack,
Docker Compose now leads us down the private track,
OpenSearch joins the fold, in Kubernetes it springs,
Pre-pulled images soar on airgapped wings! 🎪

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: enhancing airgapped edition documentation specifically for Docker Compose deployments, which aligns with the substantial rewrite converting from an offline bundle approach to a Docker Compose with private registry approach.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

…g Docker images, highlight important infrastructure images that require separate handling, and clarify configuration steps for services.
@akshat5302 akshat5302 changed the title Enhance airgapped edition documentation: update prerequisites, clarif… [DOCSW-552] Enhance airgapped edition documentation for docker compose deploymengts Jan 21, 2026
@akshat5302 akshat5302 changed the title [DOCSW-552] Enhance airgapped edition documentation for docker compose deploymengts [DOCSW-552] Enhance airgapped edition documentation for docker compose deployments Jan 21, 2026
@makeplane
Copy link

makeplane bot commented Jan 21, 2026

Linked to Plane Work Item(s)

This comment was auto-generated by Plane

@akshat5302 akshat5302 changed the base branch from master to preview January 21, 2026 10:24
…s for clarity, removing redundant contact information for license acquisition.
Copy link

@coderabbitai coderabbitai bot left a 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-alpine while Line 135 (unchanged, but relevant) uses valkey/valkey:7.2.11-alpine. The Docker Compose guide (airgapped-edition.mdx) consistently uses valkey/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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants