docs: update airgapped edition instructions for docker-compose and environment variables#253
docs: update airgapped edition instructions for docker-compose and environment variables#253danciaclara merged 2 commits intomasterfrom
Conversation
…vironment variables
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughUpdated the airgapped installation docs to download airgapped-specific artifacts: retrieve Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/methods/airgapped-edition.md`:
- 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.
- Around line 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).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 33df2b1c-b67a-4ed0-9a33-03ec3d2b810f
📒 Files selected for processing (1)
docs/self-hosting/methods/airgapped-edition.md
| @@ -55,10 +55,10 @@ Consider these alternatives: | |||
|
|
|||
| ```bash | |||
| # Download docker-compose.yml | |||
There was a problem hiding this comment.
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.
| # 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-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 |
There was a problem hiding this comment.
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 -dAlso 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).
…es for docker-compose and environment variables
2 participants
Description
This pull request updates the airgapped installation instructions in the documentation to ensure users download the correct Docker Compose and environment variable files for airgapped deployments.
Documentation improvements:
docs/self-hosting/methods/airgapped-edition.mdto instruct users to downloaddocker-compose-airgapped.ymlandvariables-airgapped.envinstead of the standard files.Type of Change
Summary by CodeRabbit