Reihe 5: Sulu für Entwickler Kapitel 14 von 16

Ausliefern und aktualisieren

Entwicklung
Gilt für: jede Sulu-Website Stand: Sulu 3.0

Kurz zusammengefasst

Hier geht es um das Ausliefern einer Sulu-3-Website: Die offizielle Dokumentation beschreibt die Auslieferung per Git und Composer, das Leeren der Caches beider Kontexte und Migrationen mit doctrine:migrations:migrate. Die Beispiel-Website ergänzt git pull --ff-only in einem Klon, lokal gebautes und hochkopiertes public/build und APP_ENV nur in .env.local; nach jedem Deploy leert sie zusätzlich den HTTP-Cache mit fos:httpcache:clear.

Sulu schreibt keinen festen Weg zum Ausliefern vor: Zuerst steht, was die offizielle Dokumentation empfiehlt, danach folgt die Auslieferung von bertrams-media als Beispiel. Befehle mit app: gehören zu diesem Projekt; Zugangsdaten und Servernamen fehlen absichtlich.

Vorher hilfreich: 5.2 Ein Projekt aufsetzen und der Webspace

Was die offizielle Dokumentation empfiehlt

Die Dokumentation von Sulu beschreibt ein einfaches Vorgehen mit Git und Composer: Auf dem Server laufen Git, PHP und Composer, dazu MySQL, MariaDB oder PostgreSQL, und das Projekt wird geklont. Die Konfiguration steht in .env.local oder in echten Umgebungsvariablen, mindestens APP_ENV=prod und DATABASE_URL.

Bei jedem weiteren Deploy wird der neue Stand mit Git geholt, und hat sich die composer.lock geändert, folgt composer install --no-dev --optimize-autoloader --classmap-authoritative. Nach Änderungen an Services, Konfiguration oder Twig werden die Caches beider Kontexte mit bin/console cache:clear und bin/websiteconsole cache:clear geleert, eigene Datenbankänderungen kommen mit doctrine:migrations:migrate hinzu.

Der Webserver braucht Schreibrechte auf var und public/media, und für automatische Deploys nennt die Dokumentation das Werkzeug Deployer. Nach dem Deploy ist außerdem der OPCache von PHP zu leeren. Den HTTP-Cache und den Build der Assets erwähnt die Seite nicht, beides zeigt das Beispiel unten.

Beispiel: so liefert die Beispiel-Website aus

Die Website bertrams-media folgt diesem Weg und ergänzt drei Dinge: Sie baut die Assets lokal, leert nach jedem Deploy auch den HTTP-Cache und prüft den Server mit dem projekteigenen Befehl app:server:check.

Das Prinzip

Auf dem Server liegt ein Git-Klon des Branches sulu-3.x, die Domain zeigt auf dessen public/. Auf dem Hosting gibt es kein Node, deshalb wird public/build lokal gebaut und hochkopiert. Alles Server-Eigene steht in der .gitignore: .env*.local, var/, public/build, public/uploads und die JWT-Schlüssel unter config/jwt. Im Klon auf dem Server werden nie Dateien geändert: git status muss dort leer sein, sonst scheitert git pull --ff-only.

Erst-Einrichtung

  1. Klonen: git clone -b sulu-3.x <repository> .
  2. .env.local mit genau einer Zeile: APP_ENV=prod (auf dem Staging stage).
  3. .env.prod.local hochladen, ohne APP_ENV-Zeile. Neu zu setzen sind APP_SECRET (der Wert der committeten .env ist öffentlich), DATABASE_URL, MAILER_DSN, SITE_BASE_SCHEME und SITE_BASE_HOST, LOCK_DSN, CRON_SECRET, OAUTH_PASSPHRASE, OAUTH_ENCRYPTION_KEY und SULU_MCP_SERVER_URL.
  4. composer install --no-dev --optimize-autoloader --no-interaction
  5. JWT-Schlüssel für den MCP-Zugang erzeugen.
  6. Medien, Icon-Sets und public/build einmal hochladen, die Datenbank einspielen.
  7. Beide Caches leeren, den Suchindex neu bauen und den Servercheck der Beispiel-Website ausführen.
Zum Schluss der Erst-Einrichtung bash
php bin/adminconsole cache:clear && php bin/websiteconsole cache:clear
php bin/adminconsole cmsig:seal:reindex
php bin/adminconsole app:server:check

Ein Folge-Deploy

Lokal: committen, Tests, push. Haben sich Assets geändert, bauen Sie mit yarn build (bei Änderungen in assets/admin zusätzlich den Admin mit npm). Vorher holt app:css:content-classes die CSS-Klassen, die auf dem Server in Inhalte getippt wurden; sonst entfernt PurgeCSS deren Regeln.

Auf dem Server:

Folge-Deploy auf dem Server bash
git pull --ff-only
composer install --no-dev --optimize-autoloader --no-interaction
php bin/adminconsole doctrine:migrations:status   # nur bei "New > 0": Sicherung, dann doctrine:migrations:migrate

Danach kopieren Sie public/build hoch und leeren erst dann die Caches:

Nach dem Hochkopieren von public/build bash
php bin/adminconsole cache:clear && php bin/websiteconsole cache:clear
php bin/websiteconsole fos:httpcache:clear
php bin/adminconsole app:server:check

Migrationen

Zeigt doctrine:migrations:status neue Migrationen, sichern Sie die Datenbank vor doctrine:migrations:migrate. Einzelne Migrationen laufen mit doctrine:migrations:execute --up, so wie beim Anlegen der Artikelgruppe „Reihen“ (siehe „Artikel in Sulu 3“). Der Index muss nur neu gebaut werden, wenn sich Such-Schemas geändert haben: php bin/adminconsole cmsig:seal:reindex.

Der Weg zurück

Taggen Sie jeden Deploy (deploy-JJJJ-MM-TT) und heben Sie das letzte public/build lokal auf, dann ist der Weg zurück frei: git reset --hard <vorheriger Tag> im Klon auf dem Server, composer install, das alte public/build und beide Cache-Leerungen samt fos:httpcache:clear.

Prüfen, was live läuft

Der Stand einer laufenden Website wird am Server abgelesen, nicht aus Notizen: curl -sI https://<host>/ zeigt im Header X-Generator die Sulu-Version.

Mehr dazu

Offizielle Dokumentation