GDRCD Installer

[egodi99]

la modifica che vorrei proporre è molto ampia e andrebbe ad influire su più aspetti del software, perché quello che mi piacerebbe raggiungere è avere un sistema configurabile da chiunque anche da chi, di software non ne sa nulla, ma partiamo dal principio.
Sicuramente la prima cosa in cui si imbatte un neofita è cosa ci faccio con lo zip di GDRCD e dove lo devo mettere?
Per risolvere questo problema la cosa più semplice che mi è venuta in mente è quella di rendere all'utente finale l'installazione di GDRCD come un wizard di un qualsiasi altro software "fai due clic ed hai fatto", quindi quello che proporrei è l'aggiunta di questi due componenti, che ho già testato in locale attualmente solo per windows poi naturalmente sarebbe da integrare anche macOS e linux.
Il primo file che sarà START.bat

@echo off
setlocal

REM Avvia il bootstrapper PowerShell
powershell.exe -NoProfile -ExecutionPolicy Bypass -File "%~dp0START.ps1"

pause

che non farà altro che avviare il vero e proprio bootstrapper powershell: START.ps1

 $ErrorActionPreference = "Stop"

# ============================================================
# GDRCD BOOTSTRAPPER - WINDOWS
# ============================================================

$ProjectPath = Split-Path -Parent $MyInvocation.MyCommand.Path
$ComposeFile = Join-Path $ProjectPath "docker-compose.yml"

Write-Host ""
Write-Host "==========================================" -ForegroundColor Cyan
Write-Host "       GDRCD DEVELOPMENT BOOTSTRAPPER" -ForegroundColor Cyan
Write-Host "==========================================" -ForegroundColor Cyan
Write-Host ""

# ============================================================
# FUNZIONE: Verifica comando
# ============================================================

function Test-CommandExists {
    param (
        [string]$Command
    )

    return $null -ne (Get-Command $Command -ErrorAction SilentlyContinue)
}


# ============================================================
# VERIFICA DOCKER
# ============================================================

Write-Host "[1/4] Controllo installazione Docker..." -ForegroundColor Yellow

if (-not (Test-CommandExists "docker")) {

    Write-Host ""
    Write-Host "Docker non trovato." -ForegroundColor Red
    Write-Host ""

    $choice = Read-Host "Vuoi aprire la pagina per installare Docker Desktop? (S/N)"

    if ($choice -match "^[sS]$") {

        Write-Host ""
        Write-Host "Apertura pagina Docker Desktop..." -ForegroundColor Cyan

        Start-Process "https://www.docker.com/products/docker-desktop/"

        Write-Host ""
        Write-Host "Installa Docker Desktop e riavvia questo script." -ForegroundColor Yellow

    }

    exit 1
}

Write-Host "Docker trovato:" -ForegroundColor Green
docker --version


# ============================================================
# VERIFICA DOCKER COMPOSE
# ============================================================

Write-Host ""
Write-Host "[2/4] Controllo Docker Compose..." -ForegroundColor Yellow

try {

    docker compose version | Out-Null

}
catch {

    Write-Host "Docker Compose non disponibile." -ForegroundColor Red
    exit 1

}

Write-Host "Docker Compose trovato." -ForegroundColor Green


# ============================================================
# VERIFICA DOCKER DESKTOP / ENGINE
# ============================================================

Write-Host ""
Write-Host "[3/4] Controllo Docker Engine..." -ForegroundColor Yellow

try {

    docker info | Out-Null

}
catch {

    Write-Host ""
    Write-Host "Docker è installato ma il Docker Engine non è attivo." -ForegroundColor Red
    Write-Host ""
    Write-Host "Avvio Docker Desktop..." -ForegroundColor Yellow

    $DockerDesktop = "$env:ProgramFiles\Docker\Docker\Docker Desktop.exe"

    if (Test-Path $DockerDesktop) {

        Start-Process $DockerDesktop

        Write-Host "Attendo l'avvio di Docker..." -ForegroundColor Cyan

        $MaxAttempts = 30
        $Attempt = 0
        $DockerReady = $false

        while ($Attempt -lt $MaxAttempts) {

            Start-Sleep -Seconds 3

            try {

                docker info | Out-Null
                $DockerReady = $true
                break

            }
            catch {
                $Attempt++
                Write-Host "." -NoNewline
            }

        }

        Write-Host ""

        if (-not $DockerReady) {

            Write-Host "Docker non si è avviato correttamente." -ForegroundColor Red
            exit 1

        }

    }
    else {

        Write-Host "Impossibile trovare Docker Desktop." -ForegroundColor Red
        exit 1

    }

}

Write-Host "Docker Engine attivo." -ForegroundColor Green


# ============================================================
# VERIFICA docker-compose.yml
# ============================================================

if (-not (Test-Path $ComposeFile)) {

    Write-Host ""
    Write-Host "ERRORE: docker-compose.yml non trovato!" -ForegroundColor Red
    Write-Host "Percorso cercato: $ComposeFile"
    exit 1

}


# ============================================================
# AVVIO STACK
# ============================================================

Write-Host ""
Write-Host "[4/4] Avvio stack GDRCD..." -ForegroundColor Yellow
Write-Host ""

Set-Location $ProjectPath

docker compose up -d --build

if ($LASTEXITCODE -ne 0) {

    Write-Host ""
    Write-Host "Errore durante l'avvio dello stack." -ForegroundColor Red
    exit 1

}

Write-Host ""
Write-Host "==========================================" -ForegroundColor Green
Write-Host "        STACK GDRCD AVVIATO!" -ForegroundColor Green
Write-Host "==========================================" -ForegroundColor Green
Write-Host ""

# ============================================================
# ATTESA WEB SERVER
# ============================================================

$Url = "http://localhost:8080"
$MaxAttempts = 30
$Attempt = 0
$ServerReady = $false

Write-Host "Attendo l'avvio del web server..." -ForegroundColor Yellow

while ($Attempt -lt $MaxAttempts) {

    try {

        $Response = Invoke-WebRequest `
            -Uri $Url `
            -UseBasicParsing `
            -TimeoutSec 3

        if ($Response.StatusCode -eq 200) {

            $ServerReady = $true
            break

        }

    }
    catch {
        Start-Sleep -Seconds 2
        $Attempt++
        Write-Host "." -NoNewline
    }

}

Write-Host ""

# ============================================================
# APERTURA WIZARD
# ============================================================

if ($ServerReady) {

    Write-Host ""
    Write-Host "GDRCD è pronto!" -ForegroundColor Green
    Write-Host ""
    Write-Host "Apertura Wizard..." -ForegroundColor Cyan

    Start-Process $Url

}
else {

    Write-Host ""
    Write-Host "Lo stack è stato avviato ma il server non risponde ancora." -ForegroundColor Yellow
    Write-Host ""
    Write-Host "Prova ad aprire manualmente:"
    Write-Host $Url -ForegroundColor Cyan

}

Write-Host ""

quest'ultimo controllerà la presenza o meno di docker desktop e se non fosse presente chiederà all'utente di installarlo, dopo di che procederà ad avviare lo stack, attualmente ho utilizzato quello che già avevo io ma si può riutilizzare quello già presente nel progetto.
docker-compose.yml

services:

  # ==========================================================
  # WEB SERVER + PHP
  # ==========================================================

  web:
    build:
      context: .
      dockerfile: Dockerfile

    container_name: gdrcd_web

    ports:
      - "8080:80"

    volumes:
      - ./:/var/www/html

    depends_on:
      - db

    environment:
      APACHE_DOCUMENT_ROOT: /var/www/html

    restart: unless-stopped


  # ==========================================================
  # DATABASE
  # ==========================================================

  db:
    image: mariadb:11.4

    container_name: gdrcd_db

    restart: unless-stopped

    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: gdrcd
      MYSQL_USER: gdrcd
      MYSQL_PASSWORD: gdrcd

    ports:
      - "3306:3306"

    volumes:
      - gdrcd_db_data:/var/lib/mysql
      - ./database:/docker-entrypoint-initdb.d


  # ==========================================================
  # PHPMYADMIN
  # ==========================================================

  phpmyadmin:
    image: phpmyadmin:latest

    container_name: gdrcd_phpmyadmin

    restart: unless-stopped

    depends_on:
      - db

    ports:
      - "8081:80"

    environment:
      PMA_HOST: db
      PMA_PORT: 3306
      UPLOAD_LIMIT: 128M


  # ==========================================================
  # MAILHOG
  # ==========================================================

  mailhog:
    image: mailhog/mailhog:latest

    container_name: gdrcd_mailhog

    restart: unless-stopped

    ports:
      - "1025:1025"
      - "8025:8025"


# ==========================================================
# VOLUMES
# ==========================================================

volumes:

  gdrcd_db_data:

Dockerfile

FROM php:8.3-apache

# ==========================================================
# SYSTEM DEPENDENCIES
# ==========================================================

RUN apt-get update && apt-get install -y \
    libzip-dev \
    zip \
    unzip \
    && rm -rf /var/lib/apt/lists/*


# ==========================================================
# PHP EXTENSIONS
# ==========================================================

RUN docker-php-ext-install \
    mysqli \
    pdo \
    pdo_mysql \
    zip


# ==========================================================
# APACHE MODULES
# ==========================================================

RUN a2enmod rewrite


# ==========================================================
# APACHE CONFIGURATION
# ==========================================================

ENV APACHE_DOCUMENT_ROOT=/var/www/html

RUN sed -ri \
    -e 's!/var/www/html!${APACHE_DOCUMENT_ROOT}!g' \
    /etc/apache2/sites-available/*.conf \
    /etc/apache2/apache2.conf \
    /etc/apache2/conf-available/*.conf

a questo punto con lo stack creato e avviato si può partire con la vera e propria configurazione, dove al posto di andare a mettere mano sul codice, per quanto riguarda tutto ciò che è presente in config.inc.php, io lo sposterei in una tabella del DB dedicata chiamata core_config_data che avrà le configurazioni essenziali già presenti più le configurazioni di FTP e DB del sito in cui verrà caricato effettivamente(altervista o chi per lui), per fare ciò naturalmente dovrà essere disponibile una tabella FE con elenco delle varie config e la possibilità di impostarle. al termine del wizard naturalmente dovrà essere possibile effettivamente pubblicare il risultato.
Ad ora mi fermerei qua, ma come dicevo all'inizio sarebbe bello riuscire a raggiungere un livello tale, in cui il tutto viene gestito da BE e non più con interventi lato codice, quindi anche tutto ciò che riguarda la grafica, renderla customizzabile tramite CMS, comunque ne parleremo in altra sede a tempo debito.

[blancks]

Innanzitutto grazie mille @egodi99 per il tempo che hai dedicato a questa proposta e grazie per la pazienza, sfortunatamente sono riuscito a trovare un momento per esaminarla a dovere soltanto adesso.

Sul codice specifico dello script non è necessario postarlo nella issue: qui analizziamo la proposta, valutiamo il da farsi e poi il codice necessario si può scrivere via fork dove sarà sottoposto a revisione una volta aperta la pull request.

Sugli scopi del progetto direi che ci siamo. GDRCD/Installer è nato proprio con lo stesso obiettivo di semplificare il setup locale di sviluppo su Windows e in generale le tue idee mi sembrano quella che sarebbe un evoluzione naturale di questo specifico progetto.

Lo script attuale già installa uno stack indipendente sul sistema host. Per il prossimo step del progetto l'obiettivo è quello di puntare si all'installazione di docker, ma anche di usare WSL2 per installare GDRCD/stack.

GDRCD/stack è un wrapper attorno a docker che standardizza i servizi locali necessari all'ambiente di sviluppo, già testato e funzionante per windows (sotto WSL2 appunto), linux e macos. Di conseguenza per noi sarebbe infinitamente più pratico semplificare il setup di questo strumento invece di continuare a mantenere una versione parallela, in questo modo a GDRCD/Installer spetterebbe solo il compito di diventare un wizard one-click mentre GDRCD/stack sarà responsabile della configurazione dello stack via docker.

Pertanto, quello che secondo me dovrebbe essere il workflow di installazione, dovrebbe assomigliare più a qualcosa di questo tipo:

• Verifica WSL2 e in caso abilitazione con Ubuntu come default
• Installazione automatica di docker sul sistema host se non presente (si può usare winget). Se già presente, skip.
• Download di GDRCD/stack, estrazione, configurazione con defaults e installazione nel filesystem interno di WSL2. Se già presente, skip.
• Chiedere all'utente se vuole scaricare GDRCD. In caso di risposta positiva, andrebbe scaricata l'ultima versione supportata dallo script di installazione, con successiva configurazione automatica dei parametri necessari per connettersi al db locale.
• A questo punto si procede facendo buildare a GDRCD/stack i containers.
• Aprire nel browser di sistema la url dove GDRCD sta girando localmente (se si è scelto il dowload automatico in precedenza)-
• Riepilogo di credenziali del database e della url locale su cui sta girando GDRCD
• Extra: pensavo che sarebbe comodo creare un icona su desktop che richiami uno script per avviare lo stack quando l'utente vuole avviare GDRCD in locale, che dovrebbe in sequenza avviare WSL2, docker, e aprire il browser di sistema verso GDRCD.

Per quanto riguarda la seconda parte della tua proposta.

Se ho capito bene stai suggerendo di integrare dentro GDRCD stesso gli strumenti necessari per il caricamento FTP su altervista, ma questa sinceramente è una strada che non mi piace perché inserirebbe nella codebase del progetto GDRCD una funzionalità unicamente necessaria per il deploy della piattaforma stessa. E' qualcosa che in genere si delega ad altri strumenti perché può comportare rischi importanti per la sicurezza.

Qui chiamo in ballo anche @Kasui92, ma a mio personale avviso la soluzione più pulita potrebbe essere quella di aggiungere un nuovo container su GDRCD/stack con questa specifica responsabilità. Possiamo magari creare, come hai suggerito, una paginetta php che si occupa di fare proprio la configurazione necessaria così che questo container per il deploy possa essere riconfigurato con semplicità in qualunque momento da browser anziché da terminale. Normalmente avrei detto di usare un plugin su vscode, ma abbiamo già tentato questo approccio provando a suggerirlo tramite un articolo che scrivemmo tempo addietro, ma temo risulti ancora troppo complesso per l'utilizzatore medio del progetto.

Per quanto riguarda lo spostamento delle configurazioni chiave a database, è qualcosa che abbiamo già integrato nella prossima versione in lavorazione e su cui progressivamente sposteremo le opzioni più comuni.