Skip to content

Commit 4e6c10c

Browse files
authored
Merge pull request #199 from makeplane/add-external-service-podman-doc
Update Podman Quadlets installation instructions and add configuration details for external services
2 parents 2209d4b + f63ac27 commit 4e6c10c

2 files changed

Lines changed: 22 additions & 5 deletions

File tree

docs/self-hosting/govern/database-and-storage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Configure externalservices
2+
title: Configure external services
33
description: Configure external database and storage for Plane. Setup PostgreSQL, Redis, and S3-compatible storage services.
44
keywords: plane, self-hosting, deployment, plane installation, configuration, administration
55
---
66

77

8-
# Configure externalservices <Badge type="info" text="Commercial Edition" />
8+
# Configure external services <Badge type="info" text="Commercial Edition" />
99

1010
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.
1111

docs/self-hosting/methods/podman-quadlets.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Before we start, make sure you've got these covered:
3939

4040
5. Download and extract Podman Quadlets.
4141
```bash
42-
curl -fsSL https://prime.plane.so/releases/<plane-version>/podman-quadlets.tar.gz -o podman-quadlets.tar.gz
43-
tar -xzf podman-quadlets.tar.gz
44-
cd podman-quadlets
42+
mkdir podman-quadlets
43+
curl -fsSL https://prime.plane.so/releases/v2.3.1/podman-quadlets.tar.gz -o podman-quadlets.tar.gz
44+
tar -xvzf podman-quadlets.tar.gz -C podman-quadlets
4545
```
4646

4747
The directory contains an `install.sh` script that will handle the installation and configuration.
@@ -67,6 +67,23 @@ This installs Plane in `/opt/plane`, which is a standard system location.
6767
Systemd configurations are installed in `~/.config/containers/systemd/`
6868
:::
6969

70+
## Configure external services (optional)
71+
72+
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.
73+
See [Environment variables](/self-hosting/govern/environment-variables) for more details.
74+
75+
- **Database** — In the **DB SETTINGS** section, set `DATABASE_URL` or individual variables (`PGHOST`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_PORT`).
76+
77+
- **Redis** — In the **REDIS SETTINGS** section, set `REDIS_URL` or `REDIS_HOST` and `REDIS_PORT`.
78+
79+
- **RabbitMQ** — Set `AMQP_URL` (e.g. `amqp://username:password@your-rabbitmq-host:5672/vhost`).
80+
81+
- **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).
82+
83+
- **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`.
84+
85+
After editing `plane.env`, start or restart services as described in [Start Plane](#start-plane) so the changes take effect.
86+
7087
## Start Plane
7188

7289
::: warning

0 commit comments

Comments
 (0)