From 62280364c5879635f2073a694f174a4ba1257f70 Mon Sep 17 00:00:00 2001 From: akshat5302 Date: Fri, 30 Jan 2026 18:33:05 +0530 Subject: [PATCH 1/3] Update Podman Quadlets installation instructions and add configuration details for external services --- self-hosting/methods/podman-quadlets.mdx | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/self-hosting/methods/podman-quadlets.mdx b/self-hosting/methods/podman-quadlets.mdx index 1e03b203..d35646a4 100644 --- a/self-hosting/methods/podman-quadlets.mdx +++ b/self-hosting/methods/podman-quadlets.mdx @@ -36,9 +36,9 @@ Before we start, make sure you've got these covered: 5. Download and extract Podman Quadlets. ```bash - curl -fsSL https://prime.plane.so/releases//podman-quadlets.tar.gz -o podman-quadlets.tar.gz - tar -xzf podman-quadlets.tar.gz - cd podman-quadlets + mkdir podman-quadlets + curl -fsSL https://prime.plane.so/releases/v2.3.1/podman-quadlets.tar.gz -o podman-quadlets.tar.gz + tar -xvzf podman-quadlets.tar.gz -C podman-quadlets ``` The directory contains an `install.sh` script that will handle the installation and configuration. @@ -63,6 +63,22 @@ The installation script sets up Plane and configures all required services. You Systemd configurations are installed in `~/.config/containers/systemd/` +## Configure external services (optional) + +If you use external services for database, Redis, RabbitMQ, OpenSearch, or object storage (MinIO/S3), edit `plane.env` in your Plane installation directory (e.g. `/opt/plane` or your custom path from `--base-dir`) before starting services. + +- **Database** — In the **DB SETTINGS** section, set `DATABASE_URL` or individual variables (`PGHOST`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_PORT`). See [Configure external database and storage](/self-hosting/govern/database-and-storage). + +- **Redis** — In the **REDIS SETTINGS** section, set `REDIS_URL` or `REDIS_HOST` and `REDIS_PORT`. See [Configure external database and storage](/self-hosting/govern/database-and-storage). + +- **RabbitMQ** — Set `AMQP_URL` (e.g. `amqp://username:password@your-rabbitmq-host:5672/vhost`). See [Environment variables](/self-hosting/govern/environment-variables). + +- **OpenSearch** — Set `OPENSEARCH_ENABLED=1`, `OPENSEARCH_URL`, and optionally `OPENSEARCH_USERNAME` and `OPENSEARCH_PASSWORD`. See [Configure OpenSearch for advanced search](/self-hosting/govern/advanced-search). + +- **MinIO / S3** — In the **DATA STORE SETTINGS** section, set `USE_MINIO=0` for external S3, then set `AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_S3_ENDPOINT_URL`, and `AWS_S3_BUCKET_NAME`. See [Configure external database and storage](/self-hosting/govern/database-and-storage). + +After editing `plane.env`, start or restart services as described in [Start Plane](#start-plane) so the changes take effect. + ## Start Plane From e5bab7259c61119999b3ed5fea34cbab03508a39 Mon Sep 17 00:00:00 2001 From: akshat5302 Date: Fri, 30 Jan 2026 18:42:27 +0530 Subject: [PATCH 2/3] Refine Podman Quadlets documentation by removing redundant links in external services configuration section --- self-hosting/methods/podman-quadlets.mdx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/self-hosting/methods/podman-quadlets.mdx b/self-hosting/methods/podman-quadlets.mdx index d35646a4..d153d95b 100644 --- a/self-hosting/methods/podman-quadlets.mdx +++ b/self-hosting/methods/podman-quadlets.mdx @@ -66,16 +66,17 @@ Systemd configurations are installed in `~/.config/containers/systemd/` ## Configure external services (optional) If you use external services for database, Redis, RabbitMQ, OpenSearch, or object storage (MinIO/S3), edit `plane.env` in your Plane installation directory (e.g. `/opt/plane` or your custom path from `--base-dir`) before starting services. +See [Environment variables](/self-hosting/govern/environment-variables) for more details. -- **Database** — In the **DB SETTINGS** section, set `DATABASE_URL` or individual variables (`PGHOST`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_PORT`). See [Configure external database and storage](/self-hosting/govern/database-and-storage). +- **Database** — In the **DB SETTINGS** section, set `DATABASE_URL` or individual variables (`PGHOST`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_PORT`). -- **Redis** — In the **REDIS SETTINGS** section, set `REDIS_URL` or `REDIS_HOST` and `REDIS_PORT`. See [Configure external database and storage](/self-hosting/govern/database-and-storage). +- **Redis** — In the **REDIS SETTINGS** section, set `REDIS_URL` or `REDIS_HOST` and `REDIS_PORT`. -- **RabbitMQ** — Set `AMQP_URL` (e.g. `amqp://username:password@your-rabbitmq-host:5672/vhost`). See [Environment variables](/self-hosting/govern/environment-variables). +- **RabbitMQ** — Set `AMQP_URL` (e.g. `amqp://username:password@your-rabbitmq-host:5672/vhost`). - **OpenSearch** — Set `OPENSEARCH_ENABLED=1`, `OPENSEARCH_URL`, and optionally `OPENSEARCH_USERNAME` and `OPENSEARCH_PASSWORD`. See [Configure OpenSearch for advanced search](/self-hosting/govern/advanced-search). -- **MinIO / S3** — In the **DATA STORE SETTINGS** section, set `USE_MINIO=0` for external S3, then set `AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_S3_ENDPOINT_URL`, and `AWS_S3_BUCKET_NAME`. See [Configure external database and storage](/self-hosting/govern/database-and-storage). +- **MinIO / S3** — In the **DATA STORE SETTINGS** section, set `USE_MINIO=0` for external S3, then set `AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_S3_ENDPOINT_URL`, and `AWS_S3_BUCKET_NAME`. After editing `plane.env`, start or restart services as described in [Start Plane](#start-plane) so the changes take effect. From f63ac27c18afb79c78c9b36222cb3653adc661d2 Mon Sep 17 00:00:00 2001 From: akshat5302 Date: Fri, 30 Jan 2026 18:47:53 +0530 Subject: [PATCH 3/3] Update title for external services configuration documentation to improve clarity --- docs/self-hosting/govern/database-and-storage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/self-hosting/govern/database-and-storage.md b/docs/self-hosting/govern/database-and-storage.md index f7e196d4..37d7a0d3 100644 --- a/docs/self-hosting/govern/database-and-storage.md +++ b/docs/self-hosting/govern/database-and-storage.md @@ -1,11 +1,11 @@ --- -title: Configure externalservices +title: Configure external services description: Configure external database and storage for Plane. Setup PostgreSQL, Redis, and S3-compatible storage services. keywords: plane, self-hosting, deployment, plane installation, configuration, administration --- -# Configure externalservices +# Configure external services The Prime CLI lets you easily configure your Commercial Edition instance, providing options to customize the PostgreSQL database, Redis, external storage, and other advanced settings.