[DOCSW-552] Enhance airgapped edition documentation for docker compose deployments

[akshat5302]

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
  • Reworked airgapped guides to a Docker Compose + private-registry workflow, removing packaged offline bundle steps and streamlining prerequisites, startup, health checks, log troubleshooting, and infra-image pre-pull guidance.
  • Simplified license activation references to a dedicated activation link; added OpenSearch as a recommended alternative.
• New Features
  • Added a new "Activate Airgapped Edition" license documentation page.

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

[vercel]

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

Project	Deployment	Review	Updated (UTC)
developer-docs	Error		Jan 21, 2026 4:37pm

[coderabbitai]

📝 Walkthrough

Walkthrough

Reworks airgapped deployment docs: Kubernetes guide rebranded to Plane Commercial and adds OpenSearch; Docker Compose guide shifts from offline bundle to private-registry image workflow; adds a new airgapped license activation page and updates site navigation.

Changes

Cohort / File(s)	Summary
Airgapped Kubernetes Guide self-hosting/methods/airgapped-edition-kubernetes.mdx	Rebrands to Plane Commercial; adds OpenSearch as recommended alternative; adds OpenSearch Docker image to infra images list; replaces detailed license activation steps with a single activation link; points additional configuration to Kubernetes docs.
Airgapped Docker Compose Guide self-hosting/methods/airgapped-edition.mdx	Major rewrite: replaces offline bundle flow with private-registry / Docker Compose workflow; updates prerequisites, image preparation, MACHINE_SIGNATURE and domain/URL guidance, docker-compose.yml references to private registry via APP_RELEASE_VERSION, simplified docker compose up startup, standardized API healthcheck text, and relocates license activation to a link.
License activation page (new) self-hosting/manage/manage-licenses/activate-airgapped.mdx	Adds a new MDX page describing step-by-step workspace license activation for Airgapped Edition via uploaded license file in Workspace Settings → Billing & plans.
Site manifest / navigation mint.json	Inserts self-hosting/manage/manage-licenses/activate-airgapped into the Manage licenses pages list immediately after activate-enterprise.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I hopped through text and swapped a dusty tar,
For registries that hum beneath the Docker star.
OpenSearch now dances, licenses upload with glee,
Airgapped and tidy — a rabbit's doc jubilee!

🚥 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 summarizes the main change: enhancing airgapped edition documentation with a focus on Docker Compose deployments, which aligns with the substantial updates across multiple documentation files.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[makeplane]

Linked to Plane Work Item(s)

• [DOCSW-552] Update Airgapped Docker instructions

This comment was auto-generated by Plane

[coderabbitai]

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

[coderabbitai]

Actionable comments posted: 2

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)

54-65: Valkey version inconsistency.

Line 57 lists valkey:7.2.5-alpine but line 135 shows valkey/valkey:7.2.11-alpine. Additionally, the Docker guide (airgapped-edition.mdx) consistently uses 7.2.11-alpine. Consider aligning these versions.

📝 Suggested fix

     **Important**  
     This process will NOT download or clone these infrastructure images:
-    - `valkey:7.2.5-alpine`
+    - `valkey/valkey:7.2.11-alpine`
     - `postgres:15.7-alpine`

🤖 Fix all issues with AI agents

In `@self-hosting/manage/manage-licenses/activate-airgapped.mdx`:
- Line 18: The sentence in activate-airgapped.mdx contains an orphaned reference
"check the logs using the commands above" that doesn't exist on this page;
update the copy by either removing that clause or replacing it with a link to
the appropriate troubleshooting/log viewing docs (e.g., a "See troubleshooting"
link), and ensure the phrase is adjusted so the page reads correctly (refer to
the exact sentence containing "check the logs using the commands above" for the
edit).
- Around line 8-16: The ordered list in activate-airgapped.mdx has a missing
step number (it jumps from "4." to "6."); update the numbering so steps read 1–8
sequentially by changing the "6. Select **Billing and plans**" entry to "5.
Select **Billing and plans**" (and ensure subsequent steps remain correctly
numbered), locating the items by their text such as "Click **Download
license**", "Navigate to the [Workspace Settings]", "Select **Billing and
plans**", and "Click the **Activate this workspace**" to verify order.

🧹 Nitpick comments (2)

self-hosting/methods/airgapped-edition.mdx (2)

39-50: Consider consistency in image version pinning.

The infrastructure images list mixes pinned versions (e.g., valkey:7.2.11-alpine, opensearchproject/opensearch:3.3.2) with floating tags (minio/minio:latest, minio/mc:latest). For airgapped environments where reproducibility is critical, consider pinning all image versions.

---

104-118: OpenSearch missing from infrastructure services example.

The infrastructure images note (line 47) lists opensearchproject/opensearch:3.3.2 as requiring separate handling, but the infrastructure services YAML example doesn't include an OpenSearch service configuration. Consider adding it for completeness if users can run OpenSearch locally.

📝 Suggested addition

       minio:
         image: minio/minio:latest
+      
+      opensearch:
+        image: opensearchproject/opensearch:3.3.2