Ir al contenido

Manual Mestre: Desdobramento e Gestão do Plane (Edição Prime)

Guia técnica integral para o desdobramento do Plane Commercial/Prime Edition no Linux, configuração DNS com Cloudflare e administração via prime-cli.

0lecturas

  1. Requisitos Prévios e Preparação do Ambiente
  2. Instalação Correta do Docker Engine e Compose V2
  3. Configuração de DNS e SSL (Cloudflare)
  4. Instalação e Lançamento do Plane
  5. Manual de Referência da Ferramenta Prime CLI
  6. Resolución de Problemas Comunes

Para garantizar un despliegue estable y libre de conflictos en los puertos principales (80 y 443), se requiere inicializar la instancia en un servidor limpio:

  • Sistema Operativo Recomendado: Ubuntu Server 20.04 LTS, 22.04 LTS o 24.04 LTS.
  • Recursos Mínimos Recomendados: 4 GB de memoria RAM y 2 vCPUs (se sugieren 8 GB de RAM para entornos de producción activa).
  • Dominio Dedicado: Un registro DNS apuntando a la IP pública del host (ej. plane.portelcore.com).

2. Instalação Correta do Docker Engine e Compose V2

Sección titulada «2. Instalación Correcta de Docker Engine y Compose V2»

[!IMPORTANT]\r\nDesaconselha-se o uso direto de apt install docker.io em repositórios básicos do Ubuntu, pois instala pacotes obsoletos e incompatíveis com o backend do Plane. Siga este procedimento padronizado para instalar o motor oficial.

2.1. Depuração de Versões Conflitantes (Limpeza)

Sección titulada «2.1. Depuración de Versiones Conflictivas (Limpieza)»
Ventana de terminal
sudo apt-get remove docker docker-engine docker.io containerd runc

2.2. Configuração do Repositório Oficial do Docker

Sección titulada «2.2. Configuración del Repositorio Oficial de Docker»

Adicione as chaves GPG do repositório oficial seguro do Docker:

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

Verifique se o comando de orquestração do Docker Compose V2 está corretamente integrado:

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

Para que el despliegue funcione correctamente bajo el parámetro de enrutamiento --behind-proxy, realiza la configuración en tu panel de administración DNS de Cloudflare:

  1. Registro DNS (A): Crea una entrada A para tu subdominio (plane) resolviendo hacia la dirección IP pública de tu servidor.
  2. Estado del Proxy: Asegura que la nube naranja esté activa (Proxied).
  3. Encriptación SSL/TLS: Configura el modo de cifrado en Full o Full (Strict) en el panel de Cloudflare.

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

Este passo é crítico para omitir a autogestão de certificados TLS locais no Plane e delegar o SSL ao nosso proxy seguro:

Ventana de terminal
sudo ./setup.sh --behind-proxy --domain="plane.portelcore.com"

O script fará o download das imagens dos serviços base (valkey, postgres, minio, core backend e frontend) e iniciará os contêineres em segundo plano.


La edición Plane Prime se administra centralizadamente mediante la interfaz de línea de comandos prime-cli, instalada en /bin/prime-cli.

Sintaxe de execução:

Ventana de terminal
sudo prime-cli [comando]
  • prime-cli start: Arranca todos los contenedores definidos en el stack. Útil si el host se ha reiniciado.
  • prime-cli stop: Detiene ordenadamente los contenedores de Plane. Debe ejecutarse siempre antes de mantenimientos del host.
  • prime-cli restart: Aplica un reinicio completo a los contenedores operativos ante ralentizaciones.
  • É um comando para configurar o ambiente de desenvolvimento:
  • prime-cli upgrade: Actualiza Plane a la última versión disponible del canal oficial, ejecutando migraciones de base de datos. Se sugiere realizar un respaldo completo antes de su ejecución.
  • prime-cli repair: Restablece y repara dependencias o imágenes corruptas si el inicio de la aplicación falla.
  • prime-cli update-cli: Actualiza de manera independiente la herramienta de gestión prime-cli.
  • prime-cli backup: Genera un archivo comprimido .tar.gz o .zip con la base de datos MySQL/Postgres local, archivos adjuntos de tareas y la configuración del archivo .env. Almacenado por defecto en /opt/plane/backups.
  • prime-cli restore: Sobrescribe el estado actual cargando un punto de restauración previo.
  • prime-cli monitor: Mostra o registro de logs em tempo real de todos os serviços.
  • prime-cli healthcheck: Realiza verificações internas e relata o estado de Redis/Valkey, Postgres, Backend e os microserviços frontend.

  • Causa: O usuário de console atual carece de privilégios sobre o socket local /var/run/docker.sock.
  • Solución Permanente: Añade tu usuario al grupo operativo de Docker:
    Ventana de terminal
    sudo usermod -aG docker $USER
    newgrp docker
  1. Inspeccione o estado dos contenedores locais: sudo prime-cli healthcheck.
  2. Verifique se o proxy reverso do contêiner do Plane responde na porta HTTP interna atribuída no host.
  3. Certifique-se de que as diretivas do firewall de rede (ex. UFW) não estejam bloqueando a comunicação interna.