Skip to content

Commit 224c2c0

Browse files
authored
Troubleshooting overview page, Activate Airgapped Enterprise license (#234)
1 parent 8d60fc9 commit 224c2c0

7 files changed

Lines changed: 89 additions & 18 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,10 @@ export default withMermaid(
307307
},
308308
{ text: "Activate Enterprise", link: "/self-hosting/manage/manage-licenses/activate-enterprise" },
309309
{ text: "Activate Airgapped", link: "/self-hosting/manage/manage-licenses/activate-airgapped" },
310+
{
311+
text: "Activate Airgapped Enterprise",
312+
link: "/self-hosting/manage/manage-licenses/activate-airgapped-enterprise",
313+
},
310314
],
311315
},
312316
{ text: "Backup and restore", link: "/self-hosting/manage/backup-restore" },
@@ -320,6 +324,7 @@ export default withMermaid(
320324
{
321325
text: "Troubleshoot",
322326
items: [
327+
{ text: "Overview", link: "/self-hosting/troubleshoot/overview" },
323328
{ text: "Installation Errors", link: "/self-hosting/troubleshoot/installation-errors" },
324329
{ text: "License Errors", link: "/self-hosting/troubleshoot/license-errors" },
325330
{ text: "CLI Errors", link: "/self-hosting/troubleshoot/cli-errors" },
33.4 KB
Loading
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Activate Airgapped Enterprise license
3+
description: Activate and configure your Plane Airgapped Edition Enterprise license. Offline license activation for air-gapped environments without internet access.
4+
keywords: plane airgapped license, offline activation, air-gapped deployment, plane license key, self-hosting
5+
---
6+
7+
# Activate Airgapped Edition Enterprise license
8+
9+
Once your air-gapped installation is running, you'll need to activate your workspace with the license file.
10+
11+
1. Login to the [Prime portal](https://prime.plane.so/licenses) with the same email address you used to purchase the paid plan.
12+
2. Go to [Manage licenses](https://prime.plane.so/licenses).
13+
3. Click **Download license** to download the license file for your Plane version.
14+
![Download license file](/images/activate-license/download-license.webp)
15+
4. Sign in to your Plane instance in [God Mode](/self-hosting/govern/instance-admin).
16+
5. Select **Billing** from the left pane.
17+
6. Upload the license file to activate your instance.
18+
![Upload license file](/images/activate-license/upload-airgapped-enterprise.webp)
19+
7. Click **Activate**.

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: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,21 @@ description: Choose the best deployment method for your infrastructure. Deploy P
44
keywords: plane deployment methods, docker compose, kubernetes, helm, podman, airgapped deployment, self-hosting
55
---
66

7-
# Deployment methods
7+
# Install Plane
88

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.
9+
Choose a deployment method based on your infrastructure and requirements.
1010

11-
## Container deployments
11+
## System requirements
12+
13+
- **CPU:** 2 cores (x64/AMD64 or AArch64/ARM64)
14+
- **RAM:** 4GB (8GB recommended for production)
15+
- **OS:** Ubuntu, Debian, CentOS, Amazon Linux 2 or 2023, macOS, Windows with WSL2
16+
17+
## Deployment methods
18+
19+
Plane supports a wide range of deployment options from simple single-container setups to enterprise-grade Kubernetes clusters.
20+
21+
### Container deployments
1222

1323
Core deployment methods for running Plane with containerized services:
1424

@@ -28,7 +38,7 @@ Core deployment methods for running Plane with containerized services:
2838
</Card>
2939
</CardGroup>
3040

31-
## Platform deployments
41+
### Platform deployments
3242

3343
Deploy Plane using specialized platforms and orchestration tools:
3444

@@ -50,7 +60,7 @@ Deploy Plane using specialized platforms and orchestration tools:
5060
</Card>
5161
</CardGroup>
5262

53-
## Airgapped deployments
63+
### Airgapped deployments
5464

5565
For environments without internet access or with strict security requirements:
5666

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: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Troubleshooting
3+
description: Diagnose and resolve issues with your self-hosted Plane instance.
4+
keywords: plane troubleshooting, self-hosted errors, docker logs, plane integration issues, plane debug
5+
---
6+
7+
# Troubleshooting
8+
9+
When something goes wrong, start by identifying which service is affected, then check the relevant logs.
10+
11+
## Identify the service
12+
13+
| Problem area | Service | Logs to check |
14+
| ------------------------------------------------------------ | ---------- | ------------------ |
15+
| API errors, data not saving, 500 errors | api | `plane-api` |
16+
| License activation or validation errors | monitor | `plane-monitor` |
17+
| GitHub, GitLab, Slack integrations, imports not working | silo | `plane-silo` |
18+
| SSL errors, 502/504 errors, routing issues | proxy | `plane-proxy` |
19+
| File uploads or attachments failing | minio | `plane-minio` |
20+
| Plane AI not working, AI chat errors | pi | `plane-pi` |
21+
| UI not loading, blank screens, page errors | web | `plane-web` |
22+
| Public pages or published views not working | space | `plane-space` |
23+
| Instance settings | admin | `plane-admin` |
24+
| Imports stuck, notifications delayed, file processing issues | worker | `plane-worker` |
25+
| Scheduled tasks or reminders not running | beat | `plane-beat` |
26+
| Upgrade failures, database schema errors | migrator | `plane-migrator` |
27+
| Real-time sync, live cursors, or presence not working | live | `plane-live` |
28+
| Intake Email not working | intake | `plane-intake` |
29+
| Search not returning results | opensearch | `plane-opensearch` |
30+
31+
See [View logs](/self-hosting/manage/view-logs) for commands to access logs in Docker deployments.
32+
33+
## Reporting issues to support
34+
35+
When [contacting support](https://docs.plane.so/support/get-help), include:
36+
37+
- **Container logs** for the affected service (see table above)
38+
- **Browser Network logs** (open DevTools → Network tab → reproduce the issue → export as HAR file)
39+
40+
This helps us diagnose the problem faster.
41+
42+
## Common issues
43+
44+
- [Installation errors](/self-hosting/troubleshoot/installation-errors)
45+
- [License errors](/self-hosting/troubleshoot/license-errors)
46+
- [CLI errors](/self-hosting/troubleshoot/cli-errors)
47+
- [Storage errors](/self-hosting/troubleshoot/storage-errors)

0 commit comments

Comments
 (0)