Merge branch 'master' of github.com:makeplane/developer-docs into update-cookie-consent

Author: danciaclara

docs/.vitepress/config.mts

@@ -307,6 +307,10 @@ export default withMermaid(
                   },
                   { text: "Activate Enterprise", link: "/self-hosting/manage/manage-licenses/activate-enterprise" },
                   { text: "Activate Airgapped", link: "/self-hosting/manage/manage-licenses/activate-airgapped" },
+                  {
+                    text: "Activate Airgapped Enterprise",
+                    link: "/self-hosting/manage/manage-licenses/activate-airgapped-enterprise",
+                  },
                 ],
               },
               { text: "Backup and restore", link: "/self-hosting/manage/backup-restore" },
@@ -320,6 +324,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" },

docs/public/images/activate-license/upload-airgapped-enterprise.webp

@@ -179,53 +179,53 @@ This is where you'll make all configuration changes. Remember to restart the ins
 
 To start Plane AI services, set each replica count to `1`:
 
-| Variable               | Description                        | Required |
-| ---------------------- | ---------------------------------- | -------- |
-| `PI_API_REPLICAS`      | Plane AI API replica count         | Yes      |
-| `PI_BEAT_REPLICAS`     | Plane AI Beat Worker replica count | Yes      |
-| `PI_WORKER_REPLICAS`   | Plane AI Worker replica count      | Yes      |
-| `PI_MIGRATOR_REPLICAS` | Plane AI Migrator replica count    | Yes      |
+| Variable                 | Description                        | Required |
+| ------------------------ | ---------------------------------- | -------- |
+| **PI_API_REPLICAS**      | Plane AI API replica count         | Yes      |
+| **PI_BEAT_REPLICAS**     | Plane AI Beat Worker replica count | Yes      |
+| **PI_WORKER_REPLICAS**   | Plane AI Worker replica count      | Yes      |
+| **PI_MIGRATOR_REPLICAS** | Plane AI Migrator replica count    | Yes      |
 
 #### LLM provider API keys
 
 Plane AI supports multiple LLM providers. Configure one or more by adding their API keys.
 
-| Variable                 | Description                                                     | Required |
-| ------------------------ | --------------------------------------------------------------- | -------- |
-| `OPENAI_API_KEY`         | API key for OpenAI models                                       | Optional |
-| `CLAUDE_API_KEY`         | API key for Anthropic models                                    | Optional |
-| `GROQ_API_KEY`           | API key for speech-to-text features                             | Optional |
-| `CUSTOM_LLM_ENABLED`     | Set to `true` to use a custom LLM with an OpenAI-compatible API | Optional |
-| `CUSTOM_LLM_MODEL_KEY`   | Identifier key for the custom model                             | Optional |
-| `CUSTOM_LLM_BASE_URL`    | Base URL of the custom model's OpenAI-compatible endpoint       | Optional |
-| `CUSTOM_LLM_API_KEY`     | API key for the custom endpoint                                 | Optional |
-| `CUSTOM_LLM_NAME`        | Display name for the custom model                               | Optional |
-| `CUSTOM_LLM_DESCRIPTION` | Description of the custom model                                 | Optional |
-| `CUSTOM_LLM_MAX_TOKENS`  | Maximum token limit for the custom model                        | Optional |
+| Variable                   | Description                                                     | Required |
+| -------------------------- | --------------------------------------------------------------- | -------- |
+| **OPENAI_API_KEY**         | API key for OpenAI models                                       | Optional |
+| **CLAUDE_API_KEY**         | API key for Anthropic models                                    | Optional |
+| **GROQ_API_KEY**           | API key for speech-to-text features                             | Optional |
+| **CUSTOM_LLM_ENABLED**     | Set to `true` to use a custom LLM with an OpenAI-compatible API | Optional |
+| **CUSTOM_LLM_MODEL_KEY**   | Identifier key for the custom model                             | Optional |
+| **CUSTOM_LLM_BASE_URL**    | Base URL of the custom model's OpenAI-compatible endpoint       | Optional |
+| **CUSTOM_LLM_API_KEY**     | API key for the custom endpoint                                 | Optional |
+| **CUSTOM_LLM_NAME**        | Display name for the custom model                               | Optional |
+| **CUSTOM_LLM_DESCRIPTION** | Description of the custom model                                 | Optional |
+| **CUSTOM_LLM_MAX_TOKENS**  | Maximum token limit for the custom model                        | Optional |
 
 #### Provider base URLs
 
 Use these when routing requests through self-hosted gateways, proxies, or compatible third-party endpoints.
 
-| Variable          | Description                                | Default   |
-| ----------------- | ------------------------------------------ | --------- |
-| `OPENAI_BASE_URL` | Custom base URL for OpenAI-compatible APIs | OpenAI    |
-| `CLAUDE_BASE_URL` | Custom base URL for Claude-compatible APIs | Anthropic |
-| `COHERE_BASE_URL` | Custom base URL for Cohere APIs            | Cohere    |
-| `GROQ_BASE_URL`   | Custom base URL for Groq APIs              | Groq      |
+| Variable            | Description                                | Default   |
+| ------------------- | ------------------------------------------ | --------- |
+| **OPENAI_BASE_URL** | Custom base URL for OpenAI-compatible APIs | OpenAI    |
+| **CLAUDE_BASE_URL** | Custom base URL for Claude-compatible APIs | Anthropic |
+| **COHERE_BASE_URL** | Custom base URL for Cohere APIs            | Cohere    |
+| **GROQ_BASE_URL**   | Custom base URL for Groq APIs              | Groq      |
 
 #### Embedding model configuration
 
 These settings are required for semantic search and Plane AI Chat. Configure one of the following options.
 
-| Variable                   | Description                                                                                                                                                              | Required    |
-| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
-| `EMBEDDING_MODEL_ID`       | ID of an existing embedding model deployed in OpenSearch (works with both self-hosted and AWS OpenSearch)                                                                | Conditional |
-| `EMBEDDING_MODEL`          | Embedding model to automatically deploy (e.g., `cohere/embed-v4.0`, `openai/text-embedding-3-small`, `bedrock/amazon.titan-embed-text-v1`). Self-hosted OpenSearch only. | Conditional |
-| `COHERE_API_KEY`           | API key for Cohere embedding models                                                                                                                                      | Conditional |
-| `BR_AWS_ACCESS_KEY_ID`     | AWS access key ID for Bedrock Titan embedding                                                                                                                            | Conditional |
-| `BR_AWS_SECRET_ACCESS_KEY` | AWS secret access key for Bedrock Titan embedding                                                                                                                        | Conditional |
-| `BR_AWS_REGION`            | AWS region for Bedrock Titan embedding                                                                                                                                   | Conditional |
+| Variable                     | Description                                                                                                                                                              | Required    |
+| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
+| **EMBEDDING_MODEL_ID**       | ID of an existing embedding model deployed in OpenSearch (works with both self-hosted and AWS OpenSearch)                                                                | Conditional |
+| **EMBEDDING_MODEL**          | Embedding model to automatically deploy (e.g., `cohere/embed-v4.0`, `openai/text-embedding-3-small`, `bedrock/amazon.titan-embed-text-v1`). Self-hosted OpenSearch only. | Conditional |
+| **COHERE_API_KEY**           | API key for Cohere embedding models                                                                                                                                      | Conditional |
+| **BR_AWS_ACCESS_KEY_ID**     | AWS access key ID for Bedrock Titan embedding                                                                                                                            | Conditional |
+| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret access key for Bedrock Titan embedding                                                                                                                        | Conditional |
+| **BR_AWS_REGION**            | AWS region for Bedrock Titan embedding                                                                                                                                   | Conditional |
 
 For setup instructions, supported models, and IAM permissions, see [Enable Plane AI](/self-hosting/govern/plane-ai).
 

docs/self-hosting/govern/environment-variables.md

@@ -0,0 +1,19 @@
+---
+title: Activate Airgapped Enterprise license
+description: Activate and configure your Plane Airgapped Edition Enterprise license. Offline license activation for air-gapped environments without internet access.
+keywords: plane airgapped license, offline activation, air-gapped deployment, plane license key, self-hosting
+---
+
+# Activate Airgapped Edition Enterprise license
+
+Once your air-gapped installation is running, you'll need to activate your workspace with the license file.
+
+1. Login to the [Prime portal](https://prime.plane.so/licenses) with the same email address you used to purchase the paid plan.
+2. Go to [Manage licenses](https://prime.plane.so/licenses).
+3. Click **Download license** to download the license file for your Plane version.
+   ![Download license file](/images/activate-license/download-license.webp)
+4. Sign in to your Plane instance in [God Mode](/self-hosting/govern/instance-admin).
+5. Select **Billing** from the left pane.
+6. Upload the license file to activate your instance.
+   ![Upload license file](/images/activate-license/upload-airgapped-enterprise.webp)
+7. Click **Activate**.

docs/self-hosting/manage/manage-licenses/activate-airgapped-enterprise.md

@@ -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.

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

@@ -4,11 +4,21 @@ description: Choose the best deployment method for your infrastructure. Deploy P
 keywords: plane deployment methods, docker compose, kubernetes, helm, podman, airgapped deployment, self-hosting
 ---
 
-# Deployment methods
+# Install Plane
 
-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.
+Choose a deployment method based on your infrastructure and requirements.
 
-## Container deployments
+## System requirements
+
+- **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
+
+## 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:
 
@@ -28,7 +38,7 @@ Core deployment methods for running Plane with containerized services:
   </Card>
 </CardGroup>
 
-## Platform deployments
+### Platform deployments
 
 Deploy Plane using specialized platforms and orchestration tools:
 
@@ -50,7 +60,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:
 

docs/self-hosting/methods/overview.md

@@ -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:

docs/self-hosting/overview.md

@@ -0,0 +1,47 @@
+---
+title: Troubleshooting
+description: Diagnose and resolve issues with your self-hosted Plane instance.
+keywords: plane troubleshooting, self-hosted errors, docker logs, plane integration issues, plane debug
+---
+
+# 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      |
+| ------------------------------------------------------------ | ---------- | ------------------ |
+| API errors, data not saving, 500 errors                      | api        | `plane-api`        |
+| License activation or validation errors                      | monitor    | `plane-monitor`    |
+| GitHub, GitLab, Slack integrations, imports not working      | silo       | `plane-silo`       |
+| SSL errors, 502/504 errors, routing issues                   | proxy      | `plane-proxy`      |
+| File uploads or attachments failing                          | minio      | `plane-minio`      |
+| Plane AI not working, AI chat errors                         | pi         | `plane-pi`         |
+| UI not loading, blank screens, page errors                   | web        | `plane-web`        |
+| Public pages or published views not working                  | space      | `plane-space`      |
+| Instance settings                                            | admin      | `plane-admin`      |
+| 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`   |
+| Real-time sync, live cursors, or presence not working        | live       | `plane-live`       |
+| Intake Email not working                                     | intake     | `plane-intake`     |
+| Search not returning results                                 | opensearch | `plane-opensearch` |
+
+See [View logs](/self-hosting/manage/view-logs) for commands to access logs in Docker deployments.
+
+## Reporting issues to support
+
+When [contacting support](https://docs.plane.so/support/get-help), include:
+
+- **Container logs** for the affected service (see table above)
+- **Browser Network logs** (open DevTools → Network tab → reproduce the issue → export as HAR file)
+
+This helps us diagnose the problem faster.
+
+## Common issues
+
+- [Installation errors](/self-hosting/troubleshoot/installation-errors)
+- [License errors](/self-hosting/troubleshoot/license-errors)
+- [CLI errors](/self-hosting/troubleshoot/cli-errors)
+- [Storage errors](/self-hosting/troubleshoot/storage-errors)