Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ export default withMermaid(
{
text: "Troubleshoot",
items: [
{ text: "Overview", link: "/self-hosting/troubleshoot/overview" },
{ text: "Installation Errors", link: "/self-hosting/troubleshoot/installation-errors" },
{ text: "License Errors", link: "/self-hosting/troubleshoot/license-errors" },
{ text: "CLI Errors", link: "/self-hosting/troubleshoot/cli-errors" },
Expand Down
10 changes: 3 additions & 7 deletions docs/self-hosting/methods/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,9 @@ Plane Pro and Plane Business are enabled on this edition, so the Free plan on th

### Prerequisites

- A virtual or on-prem machine with at least 2 vCPUs and 4 GB RAM (8 GB RAM recommended)
- `x64` AKA `AMD 64` or `AArch 64` AKA `ARM 64` CPUs
- Supported operating systems:
- Ubuntu
- Debian
- CentOS
- Amazon Linux 2 or Linux 2023
- **CPU:** 2 cores (x64/AMD64 or AArch64/ARM64)
- **RAM:** 4GB (8GB recommended for production)
- **OS:** Ubuntu, Debian, CentOS, Amazon Linux 2 or 2023, macOS, Windows with WSL2

::: info
Ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed.
Expand Down
18 changes: 13 additions & 5 deletions docs/self-hosting/methods/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,20 @@ title: Deployment methods
description: Choose the best deployment method for your infrastructure. Deploy Plane with Docker, Kubernetes, Podman, or in airgapped environments.
keywords: plane deployment methods, docker compose, kubernetes, helm, podman, airgapped deployment, self-hosting
---
# Install Plane
Choose a deployment method based on your infrastructure and requirements.

# Deployment methods
## System requirements

Choose the deployment method that best fits your infrastructure, team size, and security requirements. Plane supports a wide range of deployment options from simple single-container setups to enterprise-grade Kubernetes clusters.
- **CPU:** 2 cores (x64/AMD64 or AArch64/ARM64)
- **RAM:** 4GB (8GB recommended for production)
- **OS:** Ubuntu, Debian, CentOS, Amazon Linux 2 or 2023, macOS, Windows with WSL2

## Container deployments
## Deployment methods

Plane supports a wide range of deployment options from simple single-container setups to enterprise-grade Kubernetes clusters.

### Container deployments

Core deployment methods for running Plane with containerized services:

Expand All @@ -28,7 +36,7 @@ Core deployment methods for running Plane with containerized services:
</Card>
</CardGroup>

## Platform deployments
### Platform deployments

Deploy Plane using specialized platforms and orchestration tools:

Expand All @@ -50,7 +58,7 @@ Deploy Plane using specialized platforms and orchestration tools:
</Card>
</CardGroup>

## Airgapped deployments
### Airgapped deployments

For environments without internet access or with strict security requirements:

Expand Down
6 changes: 0 additions & 6 deletions docs/self-hosting/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,6 @@ Choose the deployment method that best fits your infrastructure and team size:

[Other deployment methods](/self-hosting/methods/overview)

## System requirements

- **CPU:** 2 cores
- **RAM:** 4GB (8GB recommended for production)
- **OS:** Linux (Ubuntu 20.04+, Debian 10+, CentOS 8+), macOS, or Windows with WSL2

## Configuration and governance

Once deployed, configure your Plane instance to match your organization's needs:
Expand Down
36 changes: 36 additions & 0 deletions docs/self-hosting/troubleshoot/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Troubleshooting
description: Diagnose and resolve issues with your self-hosted Plane instance.
---
Comment thread
coderabbitai[bot] marked this conversation as resolved.

# Troubleshooting

When something goes wrong, start by identifying which service is affected, then check the relevant logs.

## Identify the service

| Problem area | Service | Logs to check |
|--------------|---------|---------------|
| UI not loading, blank screens, page errors | web | `plane-web` |
| Public pages or published views not working | space | `plane-space` |
| Instance settings or billing issues | admin | `plane-admin` |
| API errors, data not saving, 500 errors | api | `plane-api` |
| Imports stuck, notifications delayed, file processing issues | worker | `plane-worker` |
| Scheduled tasks or reminders not running | beat | `plane-beat` |
| Upgrade failures, database schema errors | migrator | `plane-migrator` |
| SSL errors, 502/504 errors, routing issues | proxy | `plane-proxy` |
| Real-time sync, live cursors, or presence not working | live | `plane-live` |
| License activation or validation errors | monitor | `plane-monitor` |
| GitHub, GitLab, or Slack integration issues | silo | `plane-silo` |
| Email-to-work-item not working | intake | `plane-intake` |
| File uploads or attachments failing | minio | `plane-minio` |
| Search not returning results | opensearch | `plane-opensearch` |

See [View logs](/self-hosting/manage/view-logs) for commands to access logs in Docker deployments.

## Common issues

- [Installation errors](/self-hosting/troubleshooting/installation-errors)
- [License errors](/self-hosting/troubleshooting/license-errors)
- [CLI errors](/self-hosting/troubleshooting/cli-errors)
- [Storage errors](/self-hosting/troubleshooting/storage-errors)
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
Loading