Skip to content

Update Plane AI documentation with deployment instructions #226

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

Merged
danciaclara merged 4 commits into from
Mar 2, 2026
Merged

Update Plane AI documentation with deployment instructions #226

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c047db
Update Plane AI documentation with deployment instructions for Docker…
akshat5302 Mar 2, 2026
8d96131
Enhance Plane AI documentation by adding deployment instructions for …
akshat5302 Mar 2, 2026
366de23
review fixes
danciaclara Mar 2, 2026
8096665
formatting fixes
danciaclara Mar 2, 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
22 changes: 22 additions & 0 deletions docs/self-hosting/govern/plane-ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ Embedding models power semantic search. Plane AI supports:

## Enable Plane AI services

:::tip
For other deployment methods such as Coolify, Portainer, Docker Swarm, and Podman Quadlets, use the same [environment variables](/self-hosting/govern/environment-variables#plane-ai) defined for Docker Compose Setup.
:::

:::tabs key:deployment-method

== Docker Compose {#docker-compose}

Open the `/opt/plane/plane.env` file in your preferred editor and set the replica count for Plane AI services to `1`:

```bash
Expand All @@ -69,6 +77,20 @@ PI_WORKER_REPLICAS=1
PI_MIGRATOR_REPLICAS=1
```

== Kubernetes {#kubernetes}

Open your `values.yaml` file and enable the Plane AI service by setting `services.pi.enabled` to `true`:

```yaml
services:
pi:
enabled: true
```

This activates the PI API, worker, beat-worker, and migrator workloads. Replica counts and resource limits for each workload can be configured through the [Plane AI values block](/self-hosting/methods/kubernetes#plane-ai-pi-deployment) in your `values.yaml`.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 2, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix the Kubernetes anchor link target.

Line 90 points to #plane-ai-pi-deployment, but the documented section heading is Plane AI deployment, so this anchor is likely broken. Please update it to the actual heading slug to avoid a dead internal link.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/self-hosting/govern/plane-ai.md` at line 90, Update the broken anchor in
the link target referenced by "[Plane AI values block]" by replacing the
incorrect fragment "#plane-ai-pi-deployment" with the correct heading slug
"#plane-ai-deployment" so the internal link in the sentence that mentions
activating PI API, worker, beat-worker, and migrator points to the actual "Plane
AI deployment" section.


:::

## Configure an LLM provider

Configure at least one LLM provider. Add the relevant variables to `/opt/plane/plane.env`.
Expand Down
10 changes: 5 additions & 5 deletions docs/self-hosting/methods/download-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ curl "https://prime.plane.so/api/v2/setup/?version=<version>&airgapped=<true|fal

| Parameter | Required | Default | Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `version` | Yes | — | Release tag (e.g., `v2.3.4`) |
| `version` | Yes | — | Release tag (e.g., `v2.4.04`) |
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 2, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Fix version example typo in version parameter.

Line 23 shows v2.4.04, while the rest of the page uses v2.4.0. This can lead to 404s when users copy the parameter example.

Suggested fix 
-| `version`   | Yes      | —       | Release tag (e.g., `v2.4.04`)                                                 |
+| `version`   | Yes      | —       | Release tag (e.g., `v2.4.0`)                                                  |
📝 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
| `version` | Yes | — | Release tag (e.g., `v2.4.04`) |
| `version` | Yes | — | Release tag (e.g., `v2.4.0`) |
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/self-hosting/methods/download-config.md` at line 23, Update the example
value for the `version` parameter in the markdown table row that currently shows
`v2.4.04` to the correct tag `v2.4.0` so it matches the rest of the page and
prevents 404s when users copy the example; modify the table cell containing
`version` accordingly.

| `airgapped` | No | `false` | Set to `true` for airgapped compose files |
| `platform` | No | `amd64` | Target architecture: `amd64` or `arm64`. Only applies when `airgapped=true`. |

Expand All @@ -41,25 +41,25 @@ curl "https://prime.plane.so/api/v2/setup/?version=<version>&airgapped=<true|fal
**Standard setup**

```bash
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" -o plane.zip
curl "https://prime.plane.so/api/v2/setup/?version=v2.4.0" -o plane.zip
unzip plane.zip
```

**Airgapped setup (AMD64)**

```bash
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true" -o plane.zip
curl "https://prime.plane.so/api/v2/setup/?version=v2.4.0&airgapped=true" -o plane.zip
unzip plane.zip
```

**Airgapped setup (ARM64)**

```bash
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true&platform=arm64" -o plane.zip
curl "https://prime.plane.so/api/v2/setup/?version=v2.4.0&airgapped=true&platform=arm64" -o plane.zip
unzip plane.zip
```

Replace `v2.3.4` with the version you need. See the [releases page](https://plane.so/changelog?category=self-hosted) for available versions.
Replace `v2.4.0` with the version you need. See the [releases page](https://plane.so/changelog?category=self-hosted) for available versions.

### Error responses

Expand Down
Loading
Loading