diff --git a/README.md b/README.md index b13ee02..f217ca9 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,9 @@ Basisrouten nach dem Start: - `http://localhost:8080/hints.html` -> Hint Cheatsheet - `http://localhost:8080/solutions.html` -> Musterloesungen -## Voraussetzungen (Linux / macOS / Windows WSL) +## Voraussetzungen -1. Docker + Compose (`docker compose` oder `docker-compose`) -2. Optional fuer TLS-Challenges: `easy-rsa`, `openssl`, `wireshark` - -Docker muss in Linux installiert sein oder Docker Desktop mit WSL-Integration muss verfuegbar sein. - -### Installation - -#### Windows +### Windows (empfohlen) Installiere die erforderlichen Tools mit winget: @@ -47,43 +40,75 @@ winget install --id Git.Git -e winget install --id Docker.DockerDesktop -e ``` +Optional fuer TLS-Challenges: + +```powershell +winget install --id OpenSSL.OpenSSL -e +winget install --id WiresharkFoundation.Wireshark -e +``` + Nach der Installation von Docker Desktop aktiviere die WSL-Integration in den Einstellungen. -Plattformhinweise: +### Linux / macOS -- Linux: Docker Engine oder Docker Desktop -- macOS: Docker Desktop (falls `make` fehlt -> `xcode-select --install`) -- Windows: Docker Desktop mit aktivierter WSL-Integration +Docker Engine oder Docker Desktop installieren (falls `make` fehlt auf macOS: `xcode-select --install`). + +Optional fuer TLS-Challenges: + +#### Ubuntu/Debian (apt) + +```bash +sudo apt update +sudo apt install easy-rsa openssl wireshark +``` + +#### Fedora/RHEL (dnf) + +```bash +sudo dnf install easy-rsa openssl wireshark +``` ## Schnellstart +### Windows + +```powershell +./scripts/workshop.ps1 -Action bootstrap +``` + +Falls PowerShell das Script blockiert: + +```powershell +Set-ExecutionPolicy -Scope Process Bypass +``` + +Alternativ im WSL-Terminal: + +```bash +./scripts/bootstrap.sh +``` + ### Linux / macOS ```bash ./scripts/bootstrap.sh ``` -### Windows (WSL) +Das Skript: -Option A (im WSL-Terminal): +- prueft Docker + Compose +- erstellt `.env` aus `.env.example` (falls nicht vorhanden) +- startet den Stack -```bash -./scripts/bootstrap.sh -``` +Hinweis zu Skriptnamen: -Option B (PowerShell Wrapper): +- `scripts/bootstrap.sh` ist der empfohlene Einstieg +- intern nutzt es `scripts/bootstrap-unix.sh` +- `scripts/bootstrap-wsl.sh` existiert nur noch als Kompatibilitaets-Wrapper -```powershell -./scripts/workshop.ps1 -Action bootstrap -``` +## Neu deployen / resetten -Der PowerShell-Wrapper braucht kein `make` und ruft Linux-Skripte direkt in WSL auf. - -Falls PowerShell das Script blockiert: - -```powershell -Set-ExecutionPolicy -Scope Process Bypass -``` +### Windows Weitere Aktionen in PowerShell: @@ -101,19 +126,7 @@ Wenn mehrere Distros installiert sind: ./scripts/workshop.ps1 -Action bootstrap -Distro Ubuntu-24.04 ``` -Das Skript: - -- prueft Docker + Compose -- erstellt `.env` aus `.env.example` (falls nicht vorhanden) -- startet den Stack - -Hinweis zu Skriptnamen: - -- `scripts/bootstrap.sh` ist der empfohlene Einstieg -- intern nutzt es `scripts/bootstrap-unix.sh` -- `scripts/bootstrap-wsl.sh` existiert nur noch als Kompatibilitaets-Wrapper - -## Neu deployen / resetten +### Linux / macOS ```bash make redeploy