ddev: Docker für Webentwicklerddev xdebug false
Chris Wolf
Was ist ddev?
ddev ist nur ein Hilfsmittel für die Verwendung von Docker. Es vereinfacht die Interaktion und Konfiguration von Docker für die Webentwicklung auf wenige Befehle und eine Konfigurationsdatei.
tl:dr / Für wen ist es geeignet?
Wenn du bereits mit deinem Webentwicklungsprozess vertraut bist oder Docker bereits auf die eine oder andere Art und Weise verwendest, ist dieser Artikel vielleicht nicht von großem Nutzen.
Aber wenn du Docker noch nicht benutzt oder nicht weißt, wo du anfangen sollst, oder du ein bisschen frischen Wind gebrauchen kannst - read on!
Mit ddev konzentriert man sich mehr auf seinen Code und weniger auf Dev-Ops Tätigkeiten!
Zeit für eine Geschichte: Mein persönlicher Weg zu ddev
Früher habe ich meine Projekte direkt auf meinem Ubuntu-Rechner mit Apache v-hosts aufgesetzt. Ich hatte ein Bash-Skript im Einsatz, das ein neues Verzeichnis und ein Git-Repository anlegte und einen neuen Host hinzufügte.
Aber das hatte einige Schwachstellen und erforderte oft manuelle Schritte. Kurz gesagt, es wurde zeitaufwändig, das benutzerdefinierte Einrichtungsskript und alle Änderungen, die an meinem System vorgenommen wurden, zu pflegen... Mit immer mehr Projekten wurde meine Zeit knapp und ich zögerte, etwas für mich Neues wie Docker zu lernen.
Zu dieser Zeit bekamen wir von der Firma alle MacBooks für die Entwicklung, während ich persönlich eher ein Linux-Typ bin. Die Lösung an meinem Arbeitsplatz (MAMP) war für meine persönlichen Projekte nicht geeignet. Zum Glück wechselte ich zur richtigen Zeit den Arbeitgeber und lernte eine neue Art und Weise kennen, wie man an Webentwicklungsprojekten arbeiten kann: ddev.
Warum sollte man ddev und nicht einfach Docker verwenden?
Bei der Verwendung von Docker für die Webentwicklung muss man entwederein vorgefertigtes Image verwenden oder selbst eines erstellen. Wenn man keine speziellen Anforderungen hat und nur die üblichen Dinge wie php, apache und mysql benötigt, dann kann man sich Zeit sparen, indem man das Rad nicht neu erfindet und einfach ddev verwendet. Es liefert ein vorgefertigtes Image gleich mit.
Und es bietet noch mehr:
- Leichte Auswahl an Software und Versionen
- Mailhog zum Abfangen von Emails
- Lokale SSL-Unterstützung
- Redis-Unterstützung (optional)
- Elasticsearch-Unterstützung (optional)
- Ngrok-Unterstützung (optional)
Warum ddev und nicht Laravel Sail?
Obwohl ich meistens an Laravel-Projekten arbeite, bevorzuge ich ddev. Es ist nicht auf Laravel beschränkt sondern eher universell für die Webentwicklung einsetzbar. Man kann so gut wie alles damit laufen lassen. Manchmal muss ich z.B. ein Wordpress aufsetzen, was mit ddev ein Kinderspiel ist. Dass ich nur ein Tool lernen muss, anstatt zwei oder mehr, bestätigt meine Wahl bereits.
Wie man mit ddev beginnt
1. docker und ddev installieren
Wenn du Docker noch nicht installiert hast, musst du das nun nachholen.
Achtung: Nicht die post-install-steps von Docker vergessen!
Zum Schluss noch ddev installieren.
Wenn alles geklappt hat, sollte ddev dir seine Version mitteilen: ddev -v.
2. ddev zu einem (bestehenden) Projekt hinzufügen
Um ein beliebiges (bestehendes) Projekt mit ddev zu starten, navigierst du einfach ins Root-Verzeichnis des Projekts und gibst `ddev config` ein, wodurch der Initialisierungsprozess gestartet wird. Dabei werden einige Angaben abgefragt. Danach ist der Container startbereit: ddev start. Jetzt sollte das Projekt im Browser erreichbar sein.
Wie man xdebug für die Nutzung von ddev konfiguriert
Um xdebug mit ddev zu verwenden, muss es pro Projekt ein Mal konfiguriert werden. Jedes Mal, wenn man xDebug nutzen möchte, muss der Debug-Mode mit ddev xdebug gestartet werden. Der Debugmode kann das Projekt ein wenig verlangsamen. Wenn man fertig ist, am besten abschalten mit ddev xdebug false.
xdebug für ddev und PhpStorm konfigurieren
Um mit PhpStorm ein über ddev laufendes Projekt via xDebug zu debuggen, muss einmalig ein Path-Mapping definiert werden. Wenn das Projekt z.B. im Verzeichnis ~/Sites/laravel-tinker/ liegt, wird ein Path-Mapping zu /var/www/html benötigt.
Gehe dazu ins Menü Run > Edit Configurations und dann Add a new Configuration.
Hier ein Screenshot der Konfiguration:
xdebug für ddev und VSCode konfigurieren
Der Einrichtungsprozess für VSCode ist sehr einfach. In der ddev Dokumentation ist ein config snippet zu finden. Dieses wird dem Root-Verzeichnis des Projekts hinzugefügr - et voilà!
Falls Probleme auftreten oder die Debugsession nicht startet, prüfe unbedingt die ddev und xDebug Version. Mit ddev v1.19.0 wurde der Default xdebug Port auf 9003 geändert.
Der ddev Spickzettel: Die wichtigsten Commands
Für meine tägliche Arbeit habe ich diese Befehle als die am häufigsten verwendeten gefunden. Weitere Befehle können hier nachgelesen werden.
# ddev zu einem Projekt hinzufügen
ddev config
# Den Container des aktuellen Verzeichnisses starten
ddev start
# Öffnet die URL des Projekts
ddev launch
# Abrufen von Informationen über den Container, wie URLs und lokale Anmeldeinformationen
ddev describe
# Wenn die PHP- oder MySql-Version geändert werden soll, muss der Container neu aufgebaut werden.
# -O: Datenbank-Snapshot auslassen/überspringen
# -R: Gespeicherte Projektdaten entfernen (MySQL, Logs, etc.)
ddev stop -O -R && ddev start
# Startet eine Shell-Sitzung im Container.
# Erfordert eine Authentifizierung, wenn Ihr Schlüssel passwortgeschützt ist.
# Nützlich, wenn der Container auf entfernte Ressourcen zugreifen muss,
# z.B. wenn Sie ein Deployment durchführen.
ddev auth ssh
# (Nur Laravel) bietet direkten Zugriff auf die Laravel artisan CLI
ddev artisan <command>
# Start/stop xDebug
ddev xdebug
ddev xdebug false
# Führt einen beliebigen Befehl im Container aus, z.B.:
ddev exec <command>
ddev exec npm run devWie man einen eigenen Befehl definiert
ddev macht es leicht, eigene Befehle zu definieren. Für fast jedes Projekt, an dem ich arbeite, verwende ich einen benutzerdefinierten Befehl namens "provision". Darin sind alle Schritte gebündelt, die zur Einrichtung des Projekts erforderlich sind. Ein weiterer Anwendungsfall für einen benutzerdefinierten Befehl:
# .ddev/commands/web/codequality
#!/bin/bash
## #ddev-generated
## Description: Ensure code-quality
## Usage: codequality
## Example: "ddev codequality"
cd frontend
node_modules/.bin/eslint --ext .js,.vue --fix --ignore-path .gitignore --max-warnings 0 .
## run cs-fixer
vendor/bin/php-cs-fixer fix
## run tlinter
vendor/tightenco/tlint/bin/tlint
## run phpstan
vendor/bin/phpstan analyze -c phpstan.neon
composer outdated --ansi -D -m --strictProjekte miteinander verbinden
Bis hierhin war alles relativ einfach. Hier kommt noch ein sehr interessanter Punkt.
Wer an mehreren Projekten arbeitet die via API miteinander verbunden sind, kann das mit ddev ganz einfach erreichen. Mehr zu dieser Funktion in der ddev Dokumentation.
Man startet einfach beide Projekte mit ddev. Standardmäßig können die Projekte sich nicht "sehen".
Um das zu ermöglichen, erstellen wir einen Custom Service und definieren die Adresse unter der es erreichbar sein wird.
Um ein Projekt für andere Projekte erreichbar zu machen, wird eine yaml-Datei definiert:
# .ddev/docker-compose.router.yaml
version: '3.6'
services:
web:
external_links:
- ddev-router:taskdoc.local.ddev.siteQuellen, Links & ddev Alternativen
- Für MacOs: Laravel Valet
- Laravel Sail
- Laracast tutorial on how to set up docker
- Yannick Chenot's guide to docker for web development
- Titelbild von Fejuz