docs: reorganize database settings for Plane AI and update environment variable documentation#241
Merged
danciaclara merged 8 commits intomasterfrom Mar 13, 2026
Merged
Conversation
…t variable documentation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughMoved Plane AI database settings out of the general Database section into a new Plane AI Database subsection, added PLANE_PI_DATABASE_URL, and introduced a follower PostgreSQL URI (FOLLOWER_POSTGRES_URI / env.pi_envs.follower_postgres_uri) for Plane AI Kubernetes deployments as a read-replica connection string. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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)
📝 Coding Plan
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 |
…nment variables documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 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/govern/environment-variables.md`:
- Around line 176-181: The new "#### Database settings" table block is not
Prettier-formatted; run Prettier (or your project's formatting script) on the
Markdown file to fix spacing/alignment issues and ensure the table under the
"#### Database settings" header and rows for FOLLOWER_POSTGRES_URI and
PLANE_PI_DATABASE_URL conform to the repo's Markdown formatting rules so CI
passes.
- Around line 178-181: The table's FOLLOWER_POSTGRES_URI description is
ambiguous next to PLANE_PI_DATABASE_URL; update its Description to explicitly
state that FOLLOWER_POSTGRES_URI is a read-replica of the primary Plane app
database and mirrors the main DATABASE_URL (not the PLANE_PI_DATABASE_URL). Edit
the row for FOLLOWER_POSTGRES_URI so the Description reads something like:
"Connection string for a PostgreSQL read replica of the primary Plane app
database (same value as DATABASE_URL) — used for read-heavy operations to reduce
load on the primary database," leaving PLANE_PI_DATABASE_URL unchanged.
In `@docs/self-hosting/methods/install-methods-commercial/kubernetes.md`:
- Line 458: The docs add env.pi_envs.follower_postgres_uri but do not document
its secret-backed name in the pi_api_env_existingSecret table; add a new row
alongside the PLANE_PI_DATABASE_URL entry mapping FOLLOWER_POSTGRES_URI to the
same secret-backed path convention (e.g., the external secret key used for the
follower DB connection string) so external-secrets users can supply
follower_postgres_uri via a secret rather than values.yaml; update the
pi_api_env_existingSecret table to include FOLLOWER_POSTGRES_URI with a clear
description and example secret key to match PLANE_PI_DATABASE_URL.
- Line 458: The new Markdown table row for env.pi_envs.follower_postgres_uri is
misformatted for Prettier; run Prettier (or your repo's formatting command) on
docs/self-hosting/methods/install-methods-commercial/kubernetes.md to reflow the
table so the pipe alignment and spacing match the surrounding table rows,
ensuring the row text "env.pi_envs.follower_postgres_uri | Same as Plane
DATABASE_URL | No | Connection string for a Plane PostgreSQL DB read replica.
Used for read-heavy operations to reduce load on the primary database." is
properly padded and wrapped to pass the repo Prettier check.
In `@docs/self-hosting/methods/kubernetes.md`:
- Line 456: Add documentation for the external-secret mapping for the Plane
read-replica by adding an entry to the pi_api_env_existingSecret table that
corresponds to env.pi_envs.follower_postgres_uri; specify the values.yaml key
(env.pi_envs.follower_postgres_uri) and show the expected external-secret
path/secret name and secret key users must set (the secret name used by
external-secrets and the key containing the replica DATABASE_URL), and ensure
the text explains this is the connection string for the Plane PostgreSQL read
replica used for read-heavy operations.
- Line 456: The Markdown table row for env.pi_envs.follower_postgres_uri is
hand-aligned and contains extra spacing/trailing whitespace causing Prettier
failures; fix it by rewriting that single row as a minimal pipe-separated entry
(no manual column alignment or trailing spaces) e.g. "|
env.pi_envs.follower_postgres_uri | Same as Plane DATABASE_URL | No | Connection
string for a Plane PostgreSQL DB read replica. Used for read-heavy operations to
reduce load on the primary database. |", ensure the line stays under 120 chars,
then run the project's Prettier (with the repo config: 120 char width, 2-space
indent, semicolons, double quotes) to reformat and commit.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 437ffd5f-3762-4ddb-a407-dd16049dc61a
📒 Files selected for processing (3)
docs/self-hosting/govern/environment-variables.mddocs/self-hosting/methods/install-methods-commercial/kubernetes.mddocs/self-hosting/methods/kubernetes.md
docs/self-hosting/methods/install-methods-commercial/kubernetes.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/self-hosting/govern/environment-variables.md (2)
188-191:⚠️ Potential issue | 🟡 MinorRun Prettier on this new table block before merge.
CI is already failing on formatting, and this subsection is part of the modified Markdown table content. Please reformat the table so the file passes the style check. As per coding guidelines,
**/*.{ts,tsx,js,jsx,vue,json,md,mts}: "Prettier formatting checks must pass in CI, with 120 character line width, 2-space indent, semicolons, double quotes, and ES5 trailing commas".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/govern/environment-variables.md` around lines 188 - 191, The new Markdown table block containing the FOLLOWER_POSTGRES_URI and PLANE_PI_DATABASE_URL rows is not Prettier-formatted; run the project's Prettier with the repo config (120 char line width, 2-space indent, double quotes, semicolons/ES5 trailing commas) against the modified Markdown and reformat the table so column alignment and wrapping conform to Prettier, then stage and commit the updated file so CI formatting checks pass.
190-190:⚠️ Potential issue | 🟡 MinorClarify that
FOLLOWER_POSTGRES_URIpoints to the main Plane app database replica.Line 190 still reads generically next to
PLANE_PI_DATABASE_URL, so it's easy to interpret this as a replica of the PI database. Make the description explicit that this is the read replica for the primary Plane app database /DATABASE_URL.Suggested wording
-| **FOLLOWER_POSTGRES_URI** | Connection string for a PostgreSQL read replica. Used for read-heavy operations to reduce load on the primary database. | Same as DATABASE_URL | +| **FOLLOWER_POSTGRES_URI** | Connection string for a PostgreSQL read replica of the primary Plane app database. Same as `DATABASE_URL`; used for read-heavy operations to reduce load on the primary database. | Same as DATABASE_URL |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/govern/environment-variables.md` at line 190, The doc entry for FOLLOWER_POSTGRES_URI is ambiguous; update its description to explicitly state that FOLLOWER_POSTGRES_URI is the connection string for the PostgreSQL read-replica of the primary Plane application database (the same database referenced by DATABASE_URL), not a replica of PLANE_PI_DATABASE_URL; change the table cell text for FOLLOWER_POSTGRES_URI to something like “Connection string for the PostgreSQL read-replica of the primary Plane app database (used for read-heavy operations to reduce load on DATABASE_URL)” and, if present, disambiguate any neighboring PLANE_PI_DATABASE_URL text to avoid implying the follower is for the PI DB.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/self-hosting/govern/environment-variables.md`:
- Around line 188-191: The new Markdown table block containing the
FOLLOWER_POSTGRES_URI and PLANE_PI_DATABASE_URL rows is not Prettier-formatted;
run the project's Prettier with the repo config (120 char line width, 2-space
indent, double quotes, semicolons/ES5 trailing commas) against the modified
Markdown and reformat the table so column alignment and wrapping conform to
Prettier, then stage and commit the updated file so CI formatting checks pass.
- Line 190: The doc entry for FOLLOWER_POSTGRES_URI is ambiguous; update its
description to explicitly state that FOLLOWER_POSTGRES_URI is the connection
string for the PostgreSQL read-replica of the primary Plane application database
(the same database referenced by DATABASE_URL), not a replica of
PLANE_PI_DATABASE_URL; change the table cell text for FOLLOWER_POSTGRES_URI to
something like “Connection string for the PostgreSQL read-replica of the primary
Plane app database (used for read-heavy operations to reduce load on
DATABASE_URL)” and, if present, disambiguate any neighboring
PLANE_PI_DATABASE_URL text to avoid implying the follower is for the PI DB.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 033bc469-30f6-4dd4-8b45-ad78b1084fb2
📒 Files selected for processing (1)
docs/self-hosting/govern/environment-variables.md
…n for PostgreSQL read replicas
…ment variables documentation
…loyment documentation
danciaclara
approved these changes
Mar 13, 2026
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/install-methods-commercial/kubernetes.md`:
- Line 462: Update the default wording for env.pi_envs.follower_postgres_uri in
the Kubernetes docs table from "Same as Plane DATABASE_URL" to exactly "Same as
DATABASE_URL" so it matches the authoritative reference in
docs/self-hosting/govern/environment-variables.md; locate the table row
containing env.pi_envs.follower_postgres_uri and replace the default cell text
accordingly.
In `@docs/self-hosting/methods/kubernetes.md`:
- Line 459: The requirement note currently references the wrong Helm key; update
the text that mentions `postgres.local_setup=false` to use the correct
namespaced key `services.postgres.local_setup=false` (and, if applicable
elsewhere in the same sentence, ensure any Plane AI toggle references the
matching namespaced key such as `services.plane_ai.enabled`) so the line for
`env.pg_pi_db_remote_url` accurately directs users to the `services.*` Helm keys
used in this document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 3f77cde8-6b74-45b8-a3e4-1790cc4a4251
📒 Files selected for processing (3)
docs/self-hosting/govern/environment-variables.mddocs/self-hosting/methods/install-methods-commercial/kubernetes.mddocs/self-hosting/methods/kubernetes.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/self-hosting/govern/environment-variables.md
| | services.pi.annotations | {} | | Custom annotations to add to the Plane AI API deployment. | | ||
| | env.pg_pi_db_name | plane_pi | | PostgreSQL database name used by Plane AI when `postgres.local_setup=true`. | | ||
| | env.pg_pi_db_remote_url | "" | | PostgreSQL connection URL for Plane AI when using a remote database. Required when `postgres.local_setup=false` and Plane AI is enabled. | | ||
| | env.pi_envs.follower_postgres_uri | Same as Plane DATABASE_URL | No | Connection string for a Plane PostgreSQL DB read replica. Used for read-heavy operations to reduce load on the primary database. | |
There was a problem hiding this comment.
Inconsistent default value wording with authoritative docs.
Line 462 states the default as "Same as Plane DATABASE_URL", but the authoritative reference documentation at docs/self-hosting/govern/environment-variables.md shows this as "Same as DATABASE_URL" (without the word "Plane"). This inconsistency could confuse users.
For consistency across documentation, please update the default value to match the reference:
-| env.pi_envs.follower_postgres_uri | Same as Plane DATABASE_URL | No | Connection string for a Plane PostgreSQL DB read replica. Used for read-heavy operations to reduce load on the primary database. |
+| env.pi_envs.follower_postgres_uri | Same as DATABASE_URL | No | Connection string for a Plane PostgreSQL DB read replica. Used for read-heavy operations to reduce load on the primary database. |📝 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
| | env.pi_envs.follower_postgres_uri | Same as Plane DATABASE_URL | No | Connection string for a Plane PostgreSQL DB read replica. Used for read-heavy operations to reduce load on the primary database. | | |
| | env.pi_envs.follower_postgres_uri | Same as DATABASE_URL | No | Connection string for a Plane PostgreSQL DB read replica. Used for read-heavy operations to reduce load on the primary database. | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/methods/install-methods-commercial/kubernetes.md` at line
462, Update the default wording for env.pi_envs.follower_postgres_uri in the
Kubernetes docs table from "Same as Plane DATABASE_URL" to exactly "Same as
DATABASE_URL" so it matches the authoritative reference in
docs/self-hosting/govern/environment-variables.md; locate the table row
containing env.pi_envs.follower_postgres_uri and replace the default cell text
accordingly.
| | services.pi.labels | {} | | Custom labels to add to the Plane AI API deployment. | | ||
| | services.pi.annotations | {} | | Custom annotations to add to the Plane AI API deployment. | | ||
| | env.pg_pi_db_name | plane_pi | | PostgreSQL database name used by Plane AI when `postgres.local_setup=true`. | | ||
| | env.pg_pi_db_remote_url | "" | | PostgreSQL connection URL for Plane AI when using a remote database. Required when `postgres.local_setup=false` and Plane AI is enabled. | |
There was a problem hiding this comment.
Use the correct Helm key namespace in the requirement note.
Line 459 references postgres.local_setup=false, but this doc’s settings use services.postgres.local_setup. This can mislead users into setting the wrong key.
Suggested fix
-| env.pg_pi_db_remote_url | "" | | PostgreSQL connection URL for Plane AI when using a remote database. Required when `postgres.local_setup=false` and Plane AI is enabled. |
+| env.pg_pi_db_remote_url | "" | | PostgreSQL connection URL for Plane AI when using a remote database. Required when `services.postgres.local_setup=false` and Plane AI is enabled. |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/methods/kubernetes.md` at line 459, The requirement note
currently references the wrong Helm key; update the text that mentions
`postgres.local_setup=false` to use the correct namespaced key
`services.postgres.local_setup=false` (and, if applicable elsewhere in the same
sentence, ensure any Plane AI toggle references the matching namespaced key such
as `services.plane_ai.enabled`) so the line for `env.pg_pi_db_remote_url`
accurately directs users to the `services.*` Helm keys used in this document.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates documentation to clarify and reorganize how the Plane AI service handles database configuration, particularly regarding the use of a PostgreSQL read replica. The changes improve the visibility and explanation of relevant environment variables for both general environment setup and Kubernetes installation methods.
Type of Change
Summary by CodeRabbit