Support & Setup

Installation &
Ressourcen

Hier finden Sie alles, was Sie für die erfolgreiche Implementierung und den reibungslosen Betrieb von YADS benötigen.

YADS holen

YADS ist vollständig Open Source. Kein Download-Paket, keine private Registry, kein Lizenzschlüssel — einfach von GitHub klonen.

v1.20.0 Stable

MIT-LIZENZIERT

Reine Source-Distribution — die Container werden direkt aus den Repos gebaut. Keine vorgebauten Images, keine Registry, keine Anmeldung.

💻 Auf GitHub ansehen

Beta-Kanal

PREVIEW

Kein separater Beta-Kanal — folgt main auf GitHub für die aktuellsten Änderungen.

Changelog ansehen

Installationsanleitung

⚙️ Voraussetzungen

🐳 Docker Engine ≥ 24.0 (offizielle CE)

🔧 Docker Compose ≥ 2.20 (V2-Plugin)

🌐 git — jede aktuelle Version

📡 Internetzugang — zum Klonen von github.com und Ziehen der Basis-Images von Docker Hub

💾 RAM — min. 8 GB, 16 GB empfohlen

💿 Speicher — min. 20 GB frei

⚠️ Nutzt die offizielle Docker CE — nicht das Distributionspaket (apt install docker.io liefert Docker 20.x und funktioniert nicht). Installation über docs.docker.com. → Vollständige Installationsanleitung mit Copy-Paste-Befehlen

Repositories klonen

Das Deployment liegt in yads-infra, das die API-/Worker-Images aus einem sibling yads-Checkout baut — keine Registry, nichts vorgebaut.

                                git clone https://github.com/MrMarco74/yads.git

                                git clone https://github.com/MrMarco74/yads-infra.git

                                cd yads-infra

Konfigurieren

Die Beispiel-Umgebungsdatei kopieren und eigene Secrets eintragen.

                                cp .env.example .env

                                nano .env  # POSTGRES_PASSWORD, SECRET_KEY, etc. setzen

Stack starten

Die Microservices bauen und starten, dann die Oberfläche aufrufen.

docker compose -f docker-compose.server.yml up -d --build

➔ Öffnet http://localhost:8000 im Browser. Ihr werdet zum Setup-Wizard weitergeleitet.

Betrieb & Verwaltung

Reines Docker Compose — kein separates Control-Script, keine Magie. Alle Befehle aus yads-infra/ heraus ausführen.

docker compose -f docker-compose.server.yml up -d

YADS starten

docker compose -f docker-compose.server.yml down

Alle Container stoppen (Daten bleiben in Volumes erhalten)

docker compose -f docker-compose.server.yml restart

Alle Services neu starten

docker compose -f docker-compose.server.yml ps

Container-Status und Port-Bindings anzeigen

docker compose -f docker-compose.server.yml logs -f

Live-Logs aller Services (Strg+C zum Beenden)

git pull && docker compose -f docker-compose.server.yml up -d --build

Neuesten Source ziehen und Container neu bauen

Logs filtern

Für gezieltes Troubleshooting können einzelne Services gefiltert werden:

                        # Nur API-Logs (Requests, Fehler)

                        docker compose -f docker-compose.server.yml logs -f yads-api

                        # Nur Worker-Logs (Scan-Fortschritt)

                        docker compose -f docker-compose.server.yml logs -f yads-worker

Installer Wizard

Der grafische Setup-Wizard führt Sie Schritt für Schritt durch alle Konfigurationsseiten. Klicken Sie auf ein Bild für eine Vollansicht.

Wizard-Seiten im Überblick

Jede Seite deckt einen Konfigurationsbereich ab. Der Wizard validiert Ihre Eingaben, bevor er Sie zum nächsten Schritt lässt.

Willkommen

System-Check

Netzwerk

Datenbank

Identität

Monitoring

Admin-Konto

Verschlüsselung

Installation

Abschluss

Installationsmodus wählen

Schritt 10 des Wizards ermöglicht es, zwischen zwei Modi zu wählen — je nachdem, ob es sich um eine Erstinstallation, ein Upgrade oder eine Neuinstallation handelt.

Upgrade mit Backup Empfohlen für bestehende Installationen: Daten bleiben erhalten, automatisches Backup vor dem Upgrade.

Neuinstallation Für Erstinstallationen oder vollständige Resets: Alle bestehenden Daten werden überschrieben.

Hinweis: Das Admin-Passwort muss BSI TR-02102-1 entsprechen: mindestens 12 Zeichen, Groß-/Kleinbuchstaben, Ziffern und Sonderzeichen. Der Installer prüft dies in Echtzeit.

Zusätzliche Optionen

Verteilte Worker

Skalieren Sie Ihre Scan-Kapazitäten horizontal über mehrere Nodes hinweg mittels Docker Swarm.

SIEM Integration

Leiten Sie Audit-Logs in Echtzeit an Splunk oder ElasticStack weiter (MITRE ATT&CK konform).

One-Click Updates

Halten Sie Ihr System ohne Downtime auf dem neuesten Stand direkt über das Dashboard.

Installation & Ressourcen