Skip to content

Update Podman Quadlets installation instructions and add configuration details for external services #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akshat5302 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update Podman Quadlets installation instructions and add configuration details for external services #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6228036
Update Podman Quadlets installation instructions and add configuratio…
akshat5302 Jan 30, 2026
e5bab72
Refine Podman Quadlets documentation by removing redundant links in e…
akshat5302 Jan 30, 2026
ba4d06c
Merge branch 'master' of https://github.com/makeplane/developer-docs …
akshat5302 Jan 30, 2026
f63ac27
Update title for external services configuration documentation to imp…
akshat5302 Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/self-hosting/govern/database-and-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <Badge type="info" text="Commercial Edition" />
# Configure external services <Badge type="info" text="Commercial Edition" />

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.

Expand Down
23 changes: 20 additions & 3 deletions docs/self-hosting/methods/podman-quadlets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,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/<plane-version>/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.
Comment on lines +42 to 47
Copy link

@coderabbitai coderabbitai bot Jan 30, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Missing cd instruction before running install.sh.

After extraction, the install.sh script resides inside the podman-quadlets/ directory, but the subsequent installation commands (lines 52 and 58) reference ./install.sh without instructing users to change into that directory first. Users will encounter a "No such file or directory" error.

📝 Proposed fix 
     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
+    cd podman-quadlets
     ```

     The directory contains an `install.sh` script that will handle the installation and configuration.
📝 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
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.
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
cd podman-quadlets
🤖 Prompt for AI Agents 
In `@self-hosting/methods/podman-quadlets.mdx` around lines 39 - 44, The install
instructions miss changing into the extracted podman-quadlets directory before
invoking the install script; update the docs to run a directory change into
"podman-quadlets" (e.g., add a step to cd into podman-quadlets) prior to
executing ./install.sh so the referenced install.sh file can be found and the
subsequent commands that run ./install.sh (the commands around the current
./install.sh references) work as intended.

Expand All @@ -67,6 +67,23 @@ This installs Plane in `/opt/plane`, which is a standard system location.
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`).

- **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`).

- **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`.

After editing `plane.env`, start or restart services as described in [Start Plane](#start-plane) so the changes take effect.

## Start Plane

::: warning
Expand Down