Master Manual: Deployment and Management of Plane (Prime Edition)
Comprehensive technical guide for the deployment of Plane Commercial/Prime Edition on Linux, DNS configuration with Cloudflare, and administration via prime-cli.
🗺️ Deployment Roadmap
Sección titulada «🗺️ Mapa de Ruta del Despliegue»- Prerequisites and Environment Preparation
- Correct Installation of Docker Engine and Compose V2
- DNS and SSL Configuration (Cloudflare)
- Installation and Deployment of Plane
- Prime CLI Tool Reference Manual
- Common Troubleshooting
1. Prerequisites and Environment Preparation
Sección titulada «1. Requisitos Previos y Preparación del Entorno»To ensure a stable deployment free of conflicts on the main ports (80 and 443), it is required to initialize the instance on a clean server:
- Recommended Operating System: Ubuntu Server 20.04 LTS, 22.04 LTS, or 24.04 LTS.
- Minimum Recommended Resources: 4 GB of RAM and 2 vCPUs (it is suggested to use 8 GB of RAM for active production environments).
- Dedicated Domain: A DNS record pointing to the host's public IP (e.g.,
plane.portelcore.com).
2. Correct Installation of Docker Engine and Compose V2
Sección titulada «2. Instalación Correcta de Docker Engine y Compose V2»[!IMPORTANT] Direct use of
apt install docker.ioin base Ubuntu repositories is discouraged, as it installs obsolete packages incompatible with the Plane backend. Follow this standardized procedure to install the official engine.
2.1. Debugging Conflicting Versions (Cleanup)
Sección titulada «2.1. Depuración de Versiones Conflictivas (Limpieza)»sudo apt-get remove docker docker-engine docker.io containerd runc2.2. Official Docker Repository Configuration
Sección titulada «2.2. Configuración del Repositorio Oficial de Docker»Add the GPG keys from the official secure Docker repository:
# Instalar dependencias previassudo apt-get updatesudo apt-get install ca-certificates curl gnupg -y
# Crear el llavero seguro en el sistemasudo install -m 0755 -d /etc/apt/keyrings
# Descargar e importar la clave GPGcurl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpgsudo chmod a+r /etc/apt/keyrings/docker.gpg
# Añadir el repositorio a las fuentes estables de Aptecho \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null2.3. Engine and Compose Plugin Installation
Sección titulada «2.3. Instalación del Motor y Plugin Compose»sudo apt-get updatesudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y2.4. Validation of the Modernized Version
Sección titulada «2.4. Validación de la Versión Modernizada»Verify that the Docker Compose V2 orchestration command is correctly integrated:
docker compose version# Salida esperada: Docker Compose version v2.x.x3. DNS and SSL Configuration (Cloudflare)
Sección titulada «3. Configuración de DNS y SSL (Cloudflare)»To ensure the deployment works correctly under the --behind-proxy routing parameter, perform the configuration in your Cloudflare DNS administration panel:
- DNS Record (A): Create a
Aentry for your subdomain (plane) resolving to your server's public IP address. - Proxy Status: Ensure the orange cloud is active (Proxied).
- SSL/TLS Encryption: Set the encryption mode to Full or Full (Strict) in the Cloudflare panel.
4. Installation and Deployment of Plane
Sección titulada «4. Instalación y Puesta en Marcha de Plane»4.1. Creation of the Working Directory
Sección titulada «4.1. Creación del Directorio de Trabajo»mkdir plane-selfhost && cd plane-selfhostcurl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh -o setup.shchmod +x setup.sh4.2. Executing the Installer in Proxy Mode
Sección titulada «4.2. Ejecución del Instalador en Modo Proxy»This step is critical to skip local TLS certificate self-management in Plane and delegate SSL to our secure proxy:
sudo ./setup.sh --behind-proxy --domain="plane.portelcore.com"The script will download the base service images (valkey, postgres, minio, core backend, and frontend) and spin up the containers in the background.
5. Prime CLI Tool Reference Manual
Sección titulada «5. Manual de Referencia de la Herramienta Prime CLI»The Plane Prime edition is managed centrally via the prime-cli command-line interface, installed on /bin/prime-cli.
Execution syntax:
sudo prime-cli [comando]A. Stack Lifecycle Control
Sección titulada «A. Control del Ciclo de Vida del Stack»prime-cli start: Starts all containers defined in the stack. Useful if the host has been restarted.prime-cli stop: Gracefully stops the Plane containers. Must always be executed before host maintenance.prime-cli restart: Performs a full restart of the operational containers in case of slowdowns.
B. Advanced Configuration and Maintenance
Sección titulada «B. Configuración y Mantenimiento Avanzado»prime-cli configure: Opens an interactive console menu to manage environment variables such as SMTP, corporate S3/MinIO storage, and application secrets.prime-cli upgrade: Updates Plane to the latest available version from the official channel, performing database migrations. A full backup is recommended before execution.prime-cli repair: Resets and repairs corrupt dependencies or images if the application startup fails.prime-cli update-cli: Independently updates theprime-climanagement tool.
C. Backup Strategy
Sección titulada «C. Estrategia de Respaldos»prime-cli backup: Generates a compressed.tar.gzor.zipfile containing the local MySQL/Postgres database, task attachments, and the.envfile configuration. Stored by default in/opt/plane/backups.prime-cli restore: Overwrites the current state by loading a previous restore point.
D. Diagnostics and Monitoring
Sección titulada «D. Diagnóstico y Monitoreo»prime-cli monitor: Displays real-time log trace dumps for all services.prime-cli healthcheck: Performs internal health checks and reports the status of Redis/Valkey, Postgres, Backend, and frontend microservices.
6. Common Troubleshooting
Sección titulada «6. Resolución de Problemas Comunes»Error: “Permission Denied” in the Docker Terminal
Sección titulada «Error: “Permission Denied” en la Terminal de Docker»- Cause: The current console user lacks privileges over the local socket
/var/run/docker.sock. - Permanent Solution: Add your user to the Docker operating group:
Ventana de terminal sudo usermod -aG docker $USERnewgrp docker
Error: 502 Bad Gateway (Cloudflare Edge)
Sección titulada «Error: 502 Bad Gateway (Cloudflare Edge)»- Inspect the status of local containers:
sudo prime-cli healthcheck. - Verify that the Plane container's reverse proxy responds on the assigned internal HTTP port on the host.
- Ensure that network firewall directives (e.g. UFW) are not blocking internal communication.

