Skip to content
Merged
10 changes: 7 additions & 3 deletions docs/self-hosting/govern/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,6 @@ This is where you'll make all configuration changes. Remember to restart the ins
| **POSTGRES_PORT** | TCP port your PostgreSQL server is listening on. | 5432 |
| **PGDATA** | Directory path where PostgreSQL data is stored. Only relevant if you're managing PostgreSQL within the same container/system. | /var/lib/postgresql/data |
| **DATABASE_URL** | Full connection string for PostgreSQL. If provided, this takes precedence over individual connection parameters. Format: `postgresql://username:password@host:port/dbname` | |
| **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 |
| **PLANE_PI_DATABASE_URL** | Connection string for the Plane Intelligence database. A separate database used by the PI service. | postgresql://plane:plane@plane-db/plane_pi |

### Redis settings

Expand Down Expand Up @@ -171,7 +169,6 @@ This is where you'll make all configuration changes. Remember to restart the ins
| **OPENSEARCH_USERNAME** | Authentication username | admin |
| **OPENSEARCH_PASSWORD** | Authentication password | your-secure-password |
| **OPENSEARCH_INDEX_PREFIX** | Prefix for all index names (useful for multi-tenant setups) | (empty) |
| **OPENSEARCH_ML_MODEL_ID** | OpenSearch ML model ID used for embedding-based search features | (empty) |

### Plane AI

Expand All @@ -186,6 +183,13 @@ To start Plane AI services, set each replica count to `1`:
| **PI_WORKER_REPLICAS** | Plane AI Worker replica count | Yes |
| **PI_MIGRATOR_REPLICAS** | Plane AI Migrator replica count | Yes |

#### Database settings

| Variable | Description | Default Value |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| **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 |
| **PLANE_PI_DATABASE_URL** | Connection string for the Plane Intelligence database. A separate database used by the PI service. | postgresql://plane:plane@plane-db/plane_pi |

#### LLM provider API keys

Plane AI supports multiple LLM providers. Configure one or more by adding their API keys.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,7 @@ airgapped:
| 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. |
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
| env.pi_envs.internal_secret | tyfvfqvBJAgpm9bzvf3r4urJer0Ehfdubk | | Internal secret used by Plane AI for OAuth and internal APIs. |
| env.pi_envs.plane_api_host | "" | | Override for the Plane API host URL used by Plane AI. Defaults to the license domain. |
| env.pi_envs.cors_allowed_origins | "" | | CORS allowed origins for Plane AI API. Defaults to the license domain. |
Expand Down
1 change: 1 addition & 0 deletions docs/self-hosting/methods/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,7 @@ airgapped:
| 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. |
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
| env.pi_envs.internal_secret | tyfvfqvBJAgpm9bzvf3r4urJer0Ehfdubk | | Internal secret used by Plane AI for OAuth and internal APIs. |
| env.pi_envs.plane_api_host | "" | | Override for the Plane API host URL used by Plane AI. Defaults to the license domain. |
| env.pi_envs.cors_allowed_origins | "" | | CORS allowed origins for Plane AI API. Defaults to the license domain. |
Expand Down
Loading