Ir al contenido

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.

0views

  1. Prerequisites and Environment Preparation
  2. Correct Installation of Docker Engine and Compose V2
  3. DNS and SSL Configuration (Cloudflare)
  4. Installation and Deployment of Plane
  5. Prime CLI Tool Reference Manual
  6. Common Troubleshooting

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.io in base Ubuntu repositories is discouraged, as it installs obsolete packages incompatible with the Plane backend. Follow this standardized procedure to install the official engine.

Ventana de terminal
sudo apt-get remove docker docker-engine docker.io containerd runc

Add the GPG keys from the official secure Docker repository:

Ventana de terminal
# Instalar dependencias previas
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg -y
# Crear el llavero seguro en el sistema
sudo install -m 0755 -d /etc/apt/keyrings
# Descargar e importar la clave GPG
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
# Añadir el repositorio a las fuentes estables de Apt
echo \
"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/null
Ventana de terminal
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y

Verify that the Docker Compose V2 orchestration command is correctly integrated:

Ventana de terminal
docker compose version
# Salida esperada: Docker Compose version v2.x.x

To ensure the deployment works correctly under the --behind-proxy routing parameter, perform the configuration in your Cloudflare DNS administration panel:

  1. DNS Record (A): Create a A entry for your subdomain (plane) resolving to your server's public IP address.
  2. Proxy Status: Ensure the orange cloud is active (Proxied).
  3. SSL/TLS Encryption: Set the encryption mode to Full or Full (Strict) in the Cloudflare panel.

Ventana de terminal
mkdir plane-selfhost && cd plane-selfhost
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh -o setup.sh
chmod +x setup.sh

This step is critical to skip local TLS certificate self-management in Plane and delegate SSL to our secure proxy:

Ventana de terminal
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.


The Plane Prime edition is managed centrally via the prime-cli command-line interface, installed on /bin/prime-cli.

Execution syntax:

Ventana de terminal
sudo prime-cli [comando]
  • 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.
  • 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 the prime-cli management tool.
  • prime-cli backup: Generates a compressed .tar.gz or .zip file containing the local MySQL/Postgres database, task attachments, and the .env file configuration. Stored by default in /opt/plane/backups.
  • prime-cli restore: Overwrites the current state by loading a previous restore point.
  • 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.

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 $USER
    newgrp docker
  1. Inspect the status of local containers: sudo prime-cli healthcheck.
  2. Verify that the Plane container's reverse proxy responds on the assigned internal HTTP port on the host.
  3. Ensure that network firewall directives (e.g. UFW) are not blocking internal communication.