Setup Playbook¶
Dokumenttyp: Developer Playbook
Status: Draft v0.2
Stand: 2026-06-30
Prinzip: Allgemeine Anleitung mit Praxisbeispiel aus Immohai
Zweck¶
Dieser Bereich beschreibt die vollständige Einrichtung einer technischen Projektumgebung für moderne Webanwendungen.
Die Struktur folgt dem tatsächlichen Ablauf eines neuen Projekts:
- Server beschaffen.
- Server absichern und Benutzer einrichten.
- Versionsverwaltung mit Git und GitHub einrichten.
- Server-Basissoftware installieren.
- Entwicklungsrechner verbinden.
- Projekt sauber starten.
- App und Dokumentation veröffentlichen.
- Typische Fehler strukturiert beheben.
Warum Veröffentlichung Teil des Setups ist¶
Für kleine private und professionelle Webprojekte ist die erste Veröffentlichung meistens Teil der Grundeinrichtung.
Dazu gehören:
- Domain und DNS
- lokale Docker-Ports
- Nginx Reverse Proxy
- HTTPS mit Certbot
- öffentliche Erreichbarkeit von App und Dokumentation
Ein eigener Hauptbereich Deployment wird zunächst nicht verwendet. Deployment im Sinne von wiederholbaren Releases, CI/CD oder automatisierten Produktionsauslieferungen kann später ergänzt werden, wenn das Playbook diese Themen tatsächlich behandelt.
Praxisbeispiel: Immohai¶
Das Projekt Immohai dient als konkretes Referenzbeispiel. Immohai ist ein persönliches Werkzeug zur schnellen, transparenten und fundierten Bewertung von Immobilieninvestitionen.
Die technische Umgebung von Immohai besteht aktuell aus:
- Hetzner Cloud Server
- Ubuntu LTS
- Benutzer
fober - Git und GitHub
- Docker und Docker Compose
- Nginx als Host-Reverse-Proxy
- Certbot / Let's Encrypt
- MkDocs Material
- VS Code mit Remote SSH
- Windows-PC als Entwicklungsarbeitsplatz
Aktive öffentliche URLs:
https://immohai.ohaisoft.com
https://docs.immohai.ohaisoft.com
https://playbook.ohaisoft.com
Struktur¶
setup/
├── 01-server/
├── 02-versionierung/
├── 03-server-software/
├── 04-entwicklungsumgebung/
├── 05-projektstart/
├── 06-veroeffentlichung/
└── troubleshooting/
Dokumentationsstandard¶
Jede größere Datei folgt möglichst diesem Aufbau:
- Ziel
- Hintergrund
- Voraussetzungen
- Schritt-für-Schritt-Anleitung
- Best Practices
- Praxisbeispiel Immohai
- Typische Fehler
- Checkliste
Abgrenzung¶
Das Playbook dokumentiert projektübergreifende Vorgehensweisen.
Immohai wird als Praxisbeispiel verwendet, aber Immohai-spezifische Details bleiben zusätzlich in der Immohai-Projektdokumentation.
Sicherheitsregel¶
Keine Secrets, Tokens, Passwörter, Private Keys oder sensiblen Zugangsdaten dokumentieren.
Öffentliche Domains, öffentliche IP-Adressen, Ports und allgemeine technische Konfigurationen dürfen dokumentiert werden, sofern keine Zugangsdaten enthalten sind.