Skip to content

Commit 779b8ff

Browse files
committed
Troubleshooting overview page
1 parent 9f502fd commit 779b8ff

5 files changed

Lines changed: 53 additions & 18 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,7 @@ export default withMermaid(
320320
{
321321
text: "Troubleshoot",
322322
items: [
323+
{ text: "Overview", link: "/self-hosting/troubleshoot/overview" },
323324
{ text: "Installation Errors", link: "/self-hosting/troubleshoot/installation-errors" },
324325
{ text: "License Errors", link: "/self-hosting/troubleshoot/license-errors" },
325326
{ text: "CLI Errors", link: "/self-hosting/troubleshoot/cli-errors" },

docs/self-hosting/methods/docker-compose.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@ Plane Pro and Plane Business are enabled on this edition, so the Free plan on th
1818

1919
### Prerequisites
2020

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

2925
::: info
3026
Ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed.

docs/self-hosting/methods/overview.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,20 @@ title: Deployment methods
33
description: Choose the best deployment method for your infrastructure. Deploy Plane with Docker, Kubernetes, Podman, or in airgapped environments.
44
keywords: plane deployment methods, docker compose, kubernetes, helm, podman, airgapped deployment, self-hosting
55
---
6+
# Install Plane
7+
Choose a deployment method based on your infrastructure and requirements.
68

7-
# Deployment methods
9+
## System requirements
810

9-
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.
11+
- **CPU:** 2 cores (x64/AMD64 or AArch64/ARM64)
12+
- **RAM:** 4GB (8GB recommended for production)
13+
- **OS:** Ubuntu, Debian, CentOS, Amazon Linux 2 or 2023, macOS, Windows with WSL2
1014

11-
## Container deployments
15+
## Deployment methods
16+
17+
Plane supports a wide range of deployment options from simple single-container setups to enterprise-grade Kubernetes clusters.
18+
19+
### Container deployments
1220

1321
Core deployment methods for running Plane with containerized services:
1422

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

31-
## Platform deployments
39+
### Platform deployments
3240

3341
Deploy Plane using specialized platforms and orchestration tools:
3442

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

53-
## Airgapped deployments
61+
### Airgapped deployments
5462

5563
For environments without internet access or with strict security requirements:
5664

docs/self-hosting/overview.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,6 @@ Choose the deployment method that best fits your infrastructure and team size:
3737

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

40-
## System requirements
41-
42-
- **CPU:** 2 cores
43-
- **RAM:** 4GB (8GB recommended for production)
44-
- **OS:** Linux (Ubuntu 20.04+, Debian 10+, CentOS 8+), macOS, or Windows with WSL2
45-
4640
## Configuration and governance
4741

4842
Once deployed, configure your Plane instance to match your organization's needs:
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Troubleshooting
3+
description: Diagnose and resolve issues with your self-hosted Plane instance.
4+
---
5+
6+
# Troubleshooting
7+
8+
When something goes wrong, start by identifying which service is affected, then check the relevant logs.
9+
10+
## Identify the service
11+
12+
| Problem area | Service | Logs to check |
13+
|--------------|---------|---------------|
14+
| UI not loading, blank screens, page errors | web | `plane-web` |
15+
| Public pages or published views not working | space | `plane-space` |
16+
| Instance settings or billing issues | admin | `plane-admin` |
17+
| API errors, data not saving, 500 errors | api | `plane-api` |
18+
| Imports stuck, notifications delayed, file processing issues | worker | `plane-worker` |
19+
| Scheduled tasks or reminders not running | beat | `plane-beat` |
20+
| Upgrade failures, database schema errors | migrator | `plane-migrator` |
21+
| SSL errors, 502/504 errors, routing issues | proxy | `plane-proxy` |
22+
| Real-time sync, live cursors, or presence not working | live | `plane-live` |
23+
| License activation or validation errors | monitor | `plane-monitor` |
24+
| GitHub, GitLab, or Slack integration issues | silo | `plane-silo` |
25+
| Email-to-work-item not working | intake | `plane-intake` |
26+
| File uploads or attachments failing | minio | `plane-minio` |
27+
| Search not returning results | opensearch | `plane-opensearch` |
28+
29+
See [View logs](/self-hosting/manage/view-logs) for commands to access logs in Docker deployments.
30+
31+
## Common issues
32+
33+
- [Installation errors](/self-hosting/troubleshooting/installation-errors)
34+
- [License errors](/self-hosting/troubleshooting/license-errors)
35+
- [CLI errors](/self-hosting/troubleshooting/cli-errors)
36+
- [Storage errors](/self-hosting/troubleshooting/storage-errors)

0 commit comments

Comments
 (0)