Ir al contenido

Masterhandleiding: Implementatie en Beheer van Plane (Prime Editie)

Uitgebreide technische gids voor de implementatie van Plane Commercial/Prime Edition op Linux, DNS-configuratie met Cloudflare en beheer via prime-cli.

0lecturas

  1. Vereisten en Omgevingsvoorbereiding
  2. Correcte Installatie van Docker Engine en Compose V2
  3. DNS- en SSL-configuratie (Cloudflare)
  4. Installatie en Inbedrijfstelling van Plane
  5. Referentiehandleiding voor de Prime CLI-tool
  6. Veelvoorkomende Problemen Oplossen

Om een stabiele implementatie te garanderen zonder conflicten op de hoofdpoorten (80 en 443), moet de instantie op een schone server worden geïnitialiseerd:

  • Aanbevolen Besturingssysteem: Ubuntu Server 20.04 LTS, 22.04 LTS of 24.04 LTS.
  • Aanbevolen Minimale Resources: 4 GB RAM en 2 vCPU's (8 GB RAM wordt aanbevolen voor actieve productieomgevingen).
  • Dedicated Domein: Een DNS-record dat verwijst naar het publieke IP-adres van de host (bijv. plane.portelcore.com).

2. Correcte installatie van Docker Engine en Compose V2

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

[!IMPORTANT] Het gebruik van apt install docker.io in basisrepositories van Ubuntu wordt afgeraden, omdat het verouderde pakketten installeert die niet compatibel zijn met de backend van Plane. Volg deze gestandaardiseerde procedure om de officiële engine te installeren.

2.1. Foutopsporing van conflicterende versies (Opschonen)

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. Configuratie van de officiële Docker-repository

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

Voeg de GPG-sleutels van de veilige officiële Docker-repository toe:

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

2.3. Installatie van de Engine en Compose-plug-in

Sección titulada «2.3. Instalación del Motor y Plugin Compose»
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

2.4. Validatie van de gemoderniseerde versie

Sección titulada «2.4. Validación de la Versión Modernizada»

Controleer of de orkestratie-opdracht van Docker Compose V2 correct is geïntegreerd:

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

Om de uitrol correct te laten werken onder de routingparameter --behind-proxy, voer de configuratie uit in je Cloudflare DNS-beheerpaneel:

  1. DNS-record (A): Maak een A-vermelding aan voor je subdomein (plane) die verwijst naar het publieke IP-adres van je server.
  2. Proxy-status: Zorg ervoor dat de oranje wolk actief is (Proxied).
  3. SSL/TLS-encryptie: Configureer de versleutelingsmodus op Full of Full (Strict) in het Cloudflare-paneel.

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

4.2. Uitvoeren van het installatieprogramma in Proxy-modus

Sección titulada «4.2. Ejecución del Instalador en Modo Proxy»

Deze stap is cruciaal om het zelfbeheer van lokale TLS-certificaten in Plane over te slaan en de SSL te delegeren aan onze veilige proxy:

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

Het script downloadt de images van de basisdiensten (valkey, postgres, minio, core backend en frontend) en start de containers op de achtergrond.


De Plane Prime-editie wordt centraal beheerd via de command-line interface prime-cli, geïnstalleerd op /bin/prime-cli.

Uitvoeringssyntaxis:

Ventana de terminal
sudo prime-cli [comando]

A. Beheer van de levenscyclus van de stack

Sección titulada «A. Control del Ciclo de Vida del Stack»
  • prime-cli start: Start alle containers die in de stack zijn gedefinieerd. Handig als de host is herstart.
  • prime-cli stop: Stopt de Plane-containers op een ordelijke wijze. Moet altijd worden uitgevoerd vóór hostonderhoud.
  • prime-cli restart: Voert een volledige herstart uit van de actieve containers bij vertragingen.
  • prime-cli configure: Opent een interactief consolemenu om omgevingsvariabelen te beheren zoals SMTP, zakelijke S3/MinIO-opslag en applicatiegeheimen.
  • prime-cli upgrade: Update Plane naar de nieuwste beschikbare versie van het officiële kanaal en voert database-migraties uit. Een volledige back-up wordt aanbevolen voorafgaand aan de uitvoering.
  • prime-cli repair: Herstelt en repareert afhankelijkheden of beschadigde images als het opstarten van de applicatie mislukt.
  • prime-cli update-cli: Update de beheertool prime-cli onafhankelijk.
  • prime-cli backup: Genereert een gecomprimeerd bestand .tar.gz of .zip met de lokale MySQL/Postgres-database, bijlagen van taken en de configuratie van het bestand .env. Standaard opgeslagen in /opt/plane/backups.
  • prime-cli restore: Overschrijft de huidige status door een eerder herstelpunt te laden.
  • prime-cli monitor: Toont de real-time logtrace-dump van alle services.
  • prime-cli healthcheck: Voert interne health checks uit en rapporteert de status van Redis/Valkey, Postgres, Backend en de frontend-microservices.

6. Oplossen van veelvoorkomende problemen

Sección titulada «6. Resolución de Problemas Comunes»
  • Oorzaak: De huidige consolegebruiker beschikt niet over de privileges voor de lokale socket /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. Controleer de status van de lokale containers: sudo prime-cli healthcheck.
  2. Controleer of de reverse proxy van de Plane-container reageert op de interne HTTP-poort die is toegewezen op de host.
  3. Zorg ervoor dat de richtlijnen van de netwerkfirewall (bijv. UFW) de interne communicatie niet blokkeren.