Skip to content

docs: update airgapped edition instructions for docker-compose and environment variables #253

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.

Sign up for GitHub

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

Merged
danciaclara merged 2 commits into from
Mar 30, 2026
Merged

docs: update airgapped edition instructions for docker-compose and environment variables #253

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0af658
docs: update airgapped edition instructions for docker-compose and en…
akshat5302 Mar 30, 2026
ee3b8f2
docs: update airgapped edition instructions to use consistent filenam…
akshat5302 Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/self-hosting/methods/airgapped-edition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ Consider these alternatives:

```bash
# Download docker-compose.yml
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Update the inline comment to match the downloaded file name.

Line 57 says # Download docker-compose.yml, but the command downloads docker-compose-airgapped.yml.

Suggested doc fix 
-   # Download docker-compose.yml
+   # Download docker-compose-airgapped.yml
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Download docker-compose.yml
# Download docker-compose-airgapped.yml
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/self-hosting/methods/airgapped-edition.md` at line 57, Update the inline
header text that currently reads "# Download docker-compose.yml" to match the
file being downloaded (change it to "# Download docker-compose-airgapped.yml")
so the comment reflects the actual command and filename used in the docs.

curl -fsSL https://prime.plane.so/releases/<plane-version>/docker-compose.yml -o docker-compose.yml
curl -fsSL https://prime.plane.so/releases/<plane-version>/docker-compose-airgapped.yml -o docker-compose-airgapped.yml

# Download environment template
curl -fsSL https://prime.plane.so/releases/<plane-version>/variables.env -o plane.env
curl -fsSL https://prime.plane.so/releases/<plane-version>/variables-airgapped.env -o plane-airgapped.env
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Use one consistent airgapped file set across all steps.

The flow currently downloads docker-compose-airgapped.yml and plane-airgapped.env, but later tells users to edit/use plane.env, update docker-compose.yml, and start without -f docker-compose-airgapped.yml. This will cause failed or incorrect deployments.

Suggested doc fix 
-   Edit the `plane.env` file to configure your deployment:
+   Edit the `plane-airgapped.env` file to configure your deployment:

-   **Update image references** in `docker-compose.yml` to point to your private registry:
+   **Update image references** in `docker-compose-airgapped.yml` to point to your private registry:

-   docker compose --env-file plane.env up -d
+   docker compose -f docker-compose-airgapped.yml --env-file plane-airgapped.env up -d

Also applies to: 66-66, 78-78, 126-126

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/self-hosting/methods/airgapped-edition.md` around lines 58 - 61, The
docs mix two different file sets (docker-compose-airgapped.yml /
plane-airgapped.env vs plane.env / docker-compose.yml) which breaks the
airgapped flow; update all references so the same airgapped filenames are used
throughout: when downloading use docker-compose-airgapped.yml and
plane-airgapped.env, instruct users to edit plane-airgapped.env (not plane.env),
update docker-compose-airgapped.yml (not docker-compose.yml), and start the
stack with docker compose -f docker-compose-airgapped.yml up -d (or include -f
docker-compose-airgapped.yml wherever the non-airgapped compose file is
currently referenced).

```

3. **Configure environment variables**
Expand Down
Loading