Ir al contenido

Podręcznik: wdrożenie i zarządzanie Plane (Edycja Prime)

Kompleksowy przewodnik techniczny dotyczący wdrożenia Plane Commercial/Prime Edition w systemie Linux, konfiguracji DNS z Cloudflare i administracji za pomocą prime-cli.

0odwiedzin

  1. Wymagania Wstępne i Przygotowanie Środowiska
  2. Poprawna Instalacja Silnika Docker i Compose V2
  3. Konfiguracja DNS i SSL (Cloudflare)
  4. Instalacja i Uruchomienie Plane
  5. Podręcznik Referencyjny Narzędzia Prime CLI
  6. Rozwiązywanie Powszechnych Problemów

1. Wymagania wstępne i przygotowanie środowiska

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

Aby zapewnić stabilne i wolne od konfliktów wdrażanie w głównych portach (80 i 443), wymagane jest zainicjowanie instancji na czystym serwerze:

  • Zalecany System Operacyjny: Ubuntu Server 20.04 LTS, 22.04 LTS lub 24.04 LTS.
  • Zalecane Minimalne Zasoby: 4 GB pamięci RAM i 2 vCPUs (zalecane 8 GB pamięci RAM dla aktywnych środowisk produkcyjnych).
  • Własny Domena: Rekord DNS wskazujący na publiczny adres IP hosta (np. plane.portelcore.com).

[!IMPORTANT] Odradza się bezpośrednie użycie apt install docker.io w podstawowych repozytoriach Ubuntu, ponieważ instaluje nieaktualne pakiety niezgodne z backendem Plane. Postępuj zgodnie z tym standardowym procedurą, aby zainstalować oficjalny silnik.

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

Dodaj klucze GPG bezpiecznego oficjalnego repozytorium 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

Sprawdź, czy polecenie orkiestracji Docker Compose V2 jest poprawnie zintegrowane:

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

Aby wdrożenie działało poprawnie pod parametrem routingu --behind-proxy, wykonaj konfigurację w panelu administracyjnym DNS Cloudflare:

  1. Rejestr DNS (A): Utwórz wpis A dla swojej subdomeny (plane) rozwiązując w kierunku publicznego adresu IP serwera.
  2. Stan proxy: Upewnij się, że chmura pomarańczowa jest aktywna (Przekierowana).
  3. Szyfrowanie SSL/TLS: Skonfiguruj tryb szyfrowania na Pełne lub Pełne (Ścisłe) w panelu 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. Uruchomienie instalatora w trybie proxy

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

Ten krok jest krytyczny, aby pominąć automatyczne zarządzanie certyfikatami TLS lokalnymi w Plane i delegować SSL do naszego bezpiecznego proxy:

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

Skrypt pobierze obrazy podstawowych usług (valkey, postgres, minio, backend i frontend) i uruchomi kontenery w tle.


Edycja Plane Prime jest zarządzana centralnie za pomocą interfejsu wiersza polecenia prime-cli, zainstalowanego w /bin/prime-cli.

Składnia wykonania:

Ventana de terminal
sudo prime-cli [comando]
  • prime-cli start: Uruchamia wszystkie zdefiniowane kontenery w stosie. Przydatne, jeśli host został ponownie uruchomiony.
  • prime-cli stop: Zatrzymuje kontenery Plane w sposób uporządkowany. Należy go uruchomić zawsze przed przeprowadzeniem konserwacji hosta.
  • prime-cli restart: Wykonuje pełne restartowanie kontenerów operacyjnych w przypadku spowolnienia.
  • prime-cli configure: Otwiera interaktywne menu w konsoli do zarządzania zmiennymi środowiskowymi, takimi jak SMTP, magazyn S3/MinIO dla firm i sekrety aplikacji.
  • prime-cli upgrade: Aktualizuje Plane do najnowszej wersji dostępnej w oficjalnym kanale, wykonując migracje bazy danych. Zalecane jest wykonanie pełnego kopii zapasowej przed jego uruchomieniem.
  • prime-cli repair: Przywraca i naprawia uszkodzone zależności lub obrazy, jeśli uruchomienie aplikacji nie powiedzie się.
  • prime-cli update-cli: Niezależnie aktualizuje narzędzie do zarządzania prime-cli.

C. Strategia tworzenia kopii zapasowych

Sección titulada «C. Estrategia de Respaldos»
  • prime-cli backup: Generuje skompresowany plik .tar.gz lub .zip z lokalną bazą danych MySQL/Postgres, plikami załączników zadań i konfiguracją pliku .env. Domyślnie zapisywany w /opt/plane/backups.
  • prime-cli restore: Nadpisuje bieżący stan, ładując poprzedni punkt przywracania.
  • prime-cli monitor: Wyświetla wydumpowane ślady logów w czasie rzeczywistym ze wszystkich usług.
  • prime-cli healthcheck: Wykonuje wewnętrzne żądania kondycji i raportuje stan Redis/Valkey, Postgres, Backend i mikrousług frontend.

  • Przyczyna: Bieżący użytkownik konsoli nie ma uprawnień do gniazda lokalnego /var/run/docker.sock.
  • Rozwiązanie stałe: Dodaj swojego użytkownika do grupy operacyjnej Docker:
    Ventana de terminal
    sudo usermod -aG docker $USER
    newgrp docker
  1. Sprawdź stan kontenerów lokalnych: sudo prime-cli healthcheck.
  2. Sprawdź, czy proxy zwrotne kontenera Plane odpowiada na wewnętrznym porcie HTTP przypisanym na hoście.
  3. Upewnij się, że reguły zapory sieciowej (np. UFW) nie blokują komunikacji wewnętrznej.