Ir al contenido

Master-Handbuch: Bereitstellung und Verwaltung von Plane (Prime Edition)

Umfassender technischer Leitfaden für die Bereitstellung von Plane Commercial/Prime Edition unter Linux, DNS-Konfiguration mit Cloudflare und Verwaltung mittels prime-cli.

0Lesungen

  1. Voraussetzungen und Vorbereitung der Umgebung
  2. Korrekte Installation von Docker Engine und Compose V2
  3. DNS- und SSL-Konfiguration (Cloudflare)
  4. Installation und Inbetriebnahme von Plane
  5. Referenzhandbuch des Prime CLI-Tools
  6. Fehlerbehebung bei häufigen Problemen

Um eine stabile und konfliktfreie Bereitstellung auf den Hauptports (80 und 443) zu gewährleisten, muss die Instanz auf einem sauberen Server initialisiert werden:

  • Empfohlenes Betriebssystem: Ubuntu Server 20.04 LTS, 22.04 LTS oder 24.04 LTS.
  • Empfohlene Mindestressourcen: 4 GB RAM und 2 vCPUs (für aktive Produktionsumgebungen werden 8 GB RAM empfohlen).
  • Dedizierte Domain: Ein DNS-Eintrag, der auf die öffentliche IP des Hosts verweist (z. B. plane.portelcore.com).

2. Korrekte Installation von Docker Engine und Compose V2

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

[!IMPORTANT] Es wird davon abgeraten, apt install docker.io direkt in grundlegenden Ubuntu-Repositorys zu verwenden, da es veraltete und mit der Plane-Backend-Inkompatibilität installierte Pakete gibt. Folgen Sie diesem standardisierten Verfahren, um den offiziellen Motor zu installieren.

2.1. Bereinigung von Versionskonflikten (Säuberung)

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. Konfiguration des offiziellen Docker-Repositorys

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

Fügen Sie die GPG-Schlüssel des sicheren offiziellen Docker-Repositorys hinzu:

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. Installation der Engine und des Compose-Plugins

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

Überprüfen Sie, ob der Orchestrierungsbefehl von Docker Compose V2 korrekt integriert ist:

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

Damit das Deployment unter dem Routing-Parameter --behind-proxy korrekt funktioniert, führen Sie die Konfiguration in Ihrem Cloudflare DNS-Administrationspanel durch:

  1. DNS-Eintrag (A): Erstellen Sie einen A Eintrag für Ihre Subdomain (plane), der auf die öffentliche IP-Adresse Ihres Servers verweist.
  2. Proxy-Status: Stellen Sie sicher, dass die orangefarbene Wolke aktiviert ist (Proxied).
  3. SSL/TLS-Verschlüsselung: Konfigurieren Sie den Verschlüsselungsmodus im Cloudflare-Panel auf Full oder Full (Strict).

4. Installation und Inbetriebnahme von Plane

Sección titulada «4. Instalación y Puesta en Marcha de Plane»
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. Ausführung des Installers im Proxy-Modus

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

Dieser Schritt ist entscheidend, um die Selbstverwaltung lokaler TLS-Zertifikate in Plane zu überspringen und SSL an unseren sicheren Proxy zu delegieren:

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

Das Skript lädt die Images der Basisdienste (Valkey, Postgres, MinIO, Core-Backend und Frontend) herunter und startet die Container im Hintergrund.


Die Plane Prime-Edition wird zentral über die Kommandozeilen-Schnittstelle prime-cli verwaltet, die auf /bin/prime-cli installiert ist.

Ausführungssyntax:

Ventana de terminal
sudo prime-cli [comando]
  • prime-cli start: Startet alle im Stack definierten Container. Nützlich, wenn der Host neu gestartet wurde.
  • prime-cli stop: Stoppt die Plane-Container geordnet. Muss immer vor Wartungsarbeiten am Host ausgeführt werden.
  • prime-cli restart: Führt bei Verlangsamungen einen vollständigen Neustart der laufenden Container durch.
  • prime-cli configure: Öffnet ein interaktives Konsolenmenü zur Verwaltung von Umgebungsvariablen wie SMTP, S3/MinIO-Unternehmensspeicher und Applikations-Secrets.
  • prime-cli upgrade: Aktualisiert Plane auf die neueste verfügbare Version des offiziellen Kanals durch Ausführung von Datenbankmigrationen. Es wird empfohlen, vor der Ausführung ein vollständiges Backup zu erstellen.
  • prime-cli repair: Setzt Abhängigkeiten oder beschädigte Images zurück und repariert sie, falls der Start der Anwendung fehlschlägt.
  • prime-cli update-cli: Aktualisiert das Management-Tool prime-cli unabhängig.
  • prime-cli backup: Erstellt eine komprimierte Datei .tar.gz oder .zip mit der lokalen MySQL/Postgres-Datenbank, Aufgabenanhängen und der Konfiguration der Datei .env. Standardmäßig gespeichert unter /opt/plane/backups.
  • prime-cli restore: Überschreibt den aktuellen Status durch Laden eines vorherigen Wiederherstellungspunkts.
  • prime-cli monitor: Zeigt den Echtzeit-Log-Trace-Dump aller Dienste an.
  • prime-cli healthcheck: Führt interne Health-Checks durch und meldet den Status von Redis/Valkey, Postgres, dem Backend und den Frontend-Microservices.

  • Ursache: Der aktuelle Konsolenbenutzer verfügt über keine Berechtigungen für den lokalen Socket /var/run/docker.sock.
  • Permanente Lösung: Füge deinen Benutzer zur Docker-Betriebsgruppe hinzu:
    Ventana de terminal
    sudo usermod -aG docker $USER
    newgrp docker
  1. Überprüfe den Status der lokalen Container: sudo prime-cli healthcheck.
  2. Stellen Sie sicher, dass der Reverse-Proxy des Plane-Containers auf dem zugewiesenen internen HTTP-Port des Hosts antwortet.
  3. Stellen Sie sicher, dass die Netzwerk-Firewall-Richtlinien (z. B. UFW) die interne Kommunikation nicht blockieren.