Skip to content

docs: add containers mapping to community environment variables - #304

Open
boul2gom wants to merge 1 commit into
makeplane:masterfrom
boul2gom:env-variables
Open

docs: add containers mapping to community environment variables#304
boul2gom wants to merge 1 commit into
makeplane:masterfrom
boul2gom:env-variables

Conversation

@boul2gom

@boul2gom boul2gom commented Jul 29, 2026

Copy link
Copy Markdown

Description

📚 Added a 'Containers' column to all Community Edition environment variable tables, differentiated between initialization vars (e.g., plane-db) and fallback vars

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Updated the self-hosting environment variables reference with a new Containers column.
    • Clarified which Docker containers use each environment variable.
    • Refined descriptions and defaults for selected settings, including web URL, debug mode, database, RabbitMQ, and secret key configuration.

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

@boul2gom is attempting to deploy a commit to the Marketing at Plane Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The Community Edition environment variable reference now includes a Containers column identifying Docker consumers for variables across general, scaling, API, database, Redis, RabbitMQ, storage, and security settings.

Changes

Environment variable reference

Layer / File(s) Summary
Table schema and runtime settings
docs/self-hosting/govern/environment-variables.md
General, scaling, and API settings now list consuming containers and update related row descriptions and defaults.
Service configuration mappings
docs/self-hosting/govern/environment-variables.md
Database, Redis, RabbitMQ, MinIO/S3, and security settings now identify consuming or initializing containers, with related default and description updates.

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

Suggested reviewers: akhil-vamshi-konam

🚥 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 describes the documentation update adding container mappings to community environment variables.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 💡 1
🛠️ Fix failing CI checks 💡
  • Fix failing CI checks
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/self-hosting/govern/environment-variables.md`:
- Line 422: Update the SECRET_KEY description in the environment variables table
to replace “Should be a long, random string” with “It should be a long, random
string,” leaving the rest of the row unchanged.
🪄 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 Plus

Run ID: 5c6c1efa-624b-4fa9-9237-5689f562b81c

📥 Commits

Reviewing files that changed from the base of the PR and between e5dc631 and 63a6146.

📒 Files selected for processing (1)
  • docs/self-hosting/govern/environment-variables.md

Comment thread docs/self-hosting/govern/environment-variables.md
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.

1 participant