Ir al contenido

Manuel Maître : Déploiement et Gestion de Plane (Édition Prime)

Guide technique complet pour le déploiement de Plane Commercial/Prime Edition sur Linux, la configuration DNS avec Cloudflare et l'administration via prime-cli.

0vues

🗺️ Feuille de route du déploiement

Sección titulada «🗺️ Mapa de Ruta del Despliegue»
  1. Prérequis et Préparation de l'Environnement
  2. Installation Correcte de Docker Engine et Compose V2
  3. Configuration DNS et SSL (Cloudflare)
  4. Installation et Mise en Service de Plane
  5. Manuel de Référence de l'Outil Prime CLI
  6. Résolution des Problèmes Courants

1. Prérequis et préparation de l'environnement

Sección titulada «1. Requisitos Previos y Preparación del Entorno»

Pour garantir un déploiement stable et sans conflit sur les ports principaux (80 et 443), l'initialisation de l'instance sur un serveur propre est requise :

  • Système d'exploitation recommandé : Ubuntu Server 20.04 LTS, 22.04 LTS ou 24.04 LTS.
  • Ressources minimales recommandées : 4 Go de mémoire RAM et 2 vCPUs (il est suggéré 8 Go de RAM pour les environnements de production active).
  • Domaine dédié : Un enregistrement DNS pointant vers l'IP publique de l'hôte (ex. plane.portelcore.com).

2. Installation correcte de Docker Engine et Compose V2

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

[!IMPORTANT] Il est déconseillé d'utiliser directement apt install docker.io dans les dépôts de base d'Ubuntu, car cela installe des packages obsolètes et incompatibles avec le backend de Plane. Suivez cette procédure standardisée pour installer le moteur officiel.

2.1. Débogage des versions conflictuelles (Nettoyage)

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

Ajoutez les clés GPG du dépôt officiel sécurisé de 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

2.3. Installation du moteur et du plugin Compose

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

Vérifiez que la commande d'orchestration de Docker Compose V2 est correctement intégrée :

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

Pour que le déploiement fonctionne correctement sous le paramètre de routage --behind-proxy, effectuez la configuration dans votre panneau d'administration DNS Cloudflare :

  1. Enregistrement DNS (A) : Créez une entrée A pour votre sous-domaine (plane) résolvant vers l'adresse IP publique de votre serveur.
  2. État du proxy : Garantit que le nuage orange est actif (Proxied).
  3. Chiffrement SSL/TLS : Configurez le mode de chiffrement sur Full ou Full (Strict) dans le panneau 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

4.2. Exécution de l'installateur en mode Proxy

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

Cette étape est critique pour contourner l'autogestion des certificats TLS locaux dans Plane et déléguer le SSL à notre proxy sécurisé :

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

Le script téléchargera les images des services de base (valkey, postgres, minio, core backend et frontend) et démarrera les conteneurs en arrière-plan.


L'édition Plane Prime est administrée de manière centralisée via l'interface de ligne de commande prime-cli, installée sur /bin/prime-cli.

Syntaxe d'exécution :

Ventana de terminal
sudo prime-cli [comando]

A. Contrôle du cycle de vie de la stack

Sección titulada «A. Control del Ciclo de Vida del Stack»
  • prime-cli start : Démarre tous les conteneurs définis dans le stack. Utile si l'hôte a été redémarré.
  • prime-cli stop : Arrête proprement les conteneurs de Plane. Doit toujours être exécuté avant la maintenance de l'hôte.
  • prime-cli restart : Applique un redémarrage complet aux conteneurs opérationnels en cas de ralentissements.
  • prime-cli configure : Ouvre un menu interactif en console pour gérer les variables d'environnement telles que SMTP, le stockage S3/MinIO d'entreprise et les secrets de l'application.
  • prime-cli upgrade : Met à jour Plane vers la dernière version disponible du canal officiel en exécutant des migrations de base de données. Il est recommandé d'effectuer une sauvegarde complète avant l'exécution.
  • prime-cli repair : Rétablit et répare les dépendances ou les images corrompues si le démarrage de l'application échoue.
  • prime-cli update-cli : Met à jour de manière indépendante l'outil de gestion prime-cli.
  • prime-cli backup : Génère un fichier compressé .tar.gz ou .zip contenant la base de données MySQL/Postgres locale, les pièces jointes des tâches et la configuration du fichier .env. Stocké par défaut dans /opt/plane/backups.
  • prime-cli restore : Écrase l'état actuel en chargeant un point de restauration précédent.
  • prime-cli monitor : Affiche les traces de logs en temps réel de tous les services.
  • prime-cli healthcheck : Effectue des requêtes de santé internes et rapporte l'état de Redis/Valkey, Postgres, du Backend et des microservices frontend.

6. Résolution des problèmes courants

Sección titulada «6. Resolución de Problemas Comunes»

Erreur : « Permission Denied » dans le terminal Docker

Sección titulada «Error: “Permission Denied” en la Terminal de Docker»
  • Cause : L'utilisateur de console actuel ne dispose pas des privilèges nécessaires sur le socket local /var/run/docker.sock.
  • Solution Permanente : Ajoutez votre utilisateur au groupe opérationnel Docker :
    Ventana de terminal
    sudo usermod -aG docker $USER
    newgrp docker

Erreur : 502 Bad Gateway (Cloudflare Edge)

Sección titulada «Error: 502 Bad Gateway (Cloudflare Edge)»
  1. Inspectez l'état des conteneurs locaux : sudo prime-cli healthcheck.
  2. Vérifiez que le proxy inverse du conteneur Plane répond sur le port HTTP interne attribué sur l'hôte.
  3. Assurez-vous que les directives du pare-feu réseau (ex. UFW) ne bloquent pas la communication interne.