Skip to content

fix(developer-docs): correct airgapped infrastructure service names to match compose - #504

Merged
danciaclara merged 1 commit into
masterfrom
fix/airgapped-infra-service-names
Aug 21, 2026
Merged

fix(developer-docs): correct airgapped infrastructure service names to match compose#504
danciaclara merged 1 commit into
masterfrom
fix/airgapped-infra-service-names

Conversation

@sriramveeraghanta

@sriramveeraghanta sriramveeraghanta commented Aug 21, 2026

Copy link
Copy Markdown
Member

Ports makeplane/developer-docs#317 into this monorepo (apps/developer-docs).

Description

In self-hosting/methods/airgapped-edition.md:

  • Rename the infrastructure services in the local-setup YAML example so they match the actual service names in docker-compose-airgapped.yml: redisplane-redis, postgresplane-db, rabbitmqplane-mq, minioplane-minio.
  • Add pi-db-init, which reuses the postgres image.
  • Add export SITE_ADDRESS=https://plane.yourcompany.com to the environment variable block.

The resulting file is byte-identical to the merged version in makeplane/developer-docs.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)

Note

Out of scope for this PR: airgapped-edition-kubernetes.md still uses redis / postgres / rabbitmq / minio, but those are Helm values keys (they carry local_setup: / external_rabbitmq_url:), not compose service names — likely correct as-is.

https://claude.ai/code/session_0127W5LkKePrb8vVG9FFdFgG

Summary by CodeRabbit

  • Documentation
    • Updated the airgapped Docker deployment guide with the SITE_ADDRESS configuration.
    • Revised infrastructure service names in the Docker Compose example.
    • Added the database initialization service to the deployment configuration.

Rename redis→plane-redis, postgres→plane-db, rabbitmq→plane-mq,
minio→plane-minio in the local infrastructure YAML example so they match
the actual service names in docker-compose-airgapped.yml. Also add
pi-db-init which reuses the postgres image, and SITE_ADDRESS to the
environment variable block.

Ports makeplane/developer-docs#317 to this monorepo.

Claude-Session: https://claude.ai/code/session_0127W5LkKePrb8vVG9FFdFgG
@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview Aug 21, 2026 7:27am
docs Ready Ready Preview Aug 21, 2026 7:27am

Request Review

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f73213f9-6e45-4679-9fd3-c866a99b9ffc

📥 Commits

Reviewing files that changed from the base of the PR and between 6ea3aa0 and a0e2dc3.

📒 Files selected for processing (1)
  • apps/developer-docs/docs/self-hosting/methods/airgapped-edition.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The airgapped Docker deployment guide adds a SITE_ADDRESS environment variable and updates the infrastructure service names. It also adds the pi-db-init PostgreSQL service to the Docker Compose example.

Changes

Airgapped deployment configuration

Layer / File(s) Summary
Deployment configuration examples
apps/developer-docs/docs/self-hosting/methods/airgapped-edition.md
The environment variable example adds SITE_ADDRESS. The Docker Compose example renames infrastructure services and adds pi-db-init with the postgres:15.7-alpine image.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to a0e2d

This documentation-only change corrects airgapped service names and environment guidance without changing product behavior; no actionable merge-blocking risk remains.

Suggested reviewers: vihar

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: correcting airgapped infrastructure service names in the developer documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/airgapped-infra-service-names

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.

@danciaclara
danciaclara merged commit e0a1282 into master Aug 21, 2026
6 checks passed
@danciaclara
danciaclara deleted the fix/airgapped-infra-service-names branch August 21, 2026 07:56
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.

2 participants