Skip to main content
Willkommen in der Dokumentation des Homelabs Astrellium. Sie ist die zentrale Wissensbasis und dient als Single Source of Truth (SSOT) für alle Systemkomponenten, Konfigurationen und Prozesse: vollständig, nachvollziehbar und jederzeit auf dem aktuellen Stand.
Jede Konfiguration, jede IP-Adresse, jede VM und jeder Dienst wird hier dokumentiert, bevor oder unmittelbar nachdem sie in Betrieb genommen werden.

​
Bereiche

Netzwerk

Physisches und virtuelles Netzwerk, Adressplan und Topologie.

Sicherheit

Firewalls, Penetration-Testing und Vulnerable Clients.

Dienste & Projekte

Selbst gehostete Dienste und Projekte, z. B. SQL Server und JTL Wawi.

Code

Skripte und Programmierung rund um das Homelab.

Referenzen

Befehle, Ports, Quellen und fertige Vorlagen zum Nachschlagen.

Archiv

Außer Betrieb genommene Dienste und veraltete Seiten.

​
Grundprinzipien

Drei verbindliche Regeln gelten für jede Seite:

Aktualität vor Vollständigkeit

Eine veraltete Dokumentation ist gefährlicher als eine unvollständige. Änderungen werden sofort eingetragen, unfertige Seiten als Entwurf gekennzeichnet.

Eine Quelle, keine Duplikate

IP-Adressen, Hostnamen und Ports stehen nur an einer Stelle. Alle anderen Seiten verweisen darauf.

Keine Zugangsdaten

Passwörter, Schlüssel und Tokens werden nie gespeichert. Vermerkt wird nur, in welchem Passwortmanager der Eintrag liegt.
Zugangsdaten gehören nicht in diese Dokumentation, auch nicht als Platzhalter oder Beispielwerte.

​
Aufbau

Alle Seiten tragen eine Nummer nach dem Schema Thema.Kapitel.Absatz, angelehnt an das Versionierungsformat Major.Minor.Patch. Die Übersichtsseite eines Bereichs trägt immer die Nummer x.0.0. Das Archiv ist ausgenommen und wird nicht nummeriert. Ein Beispiel: 3.1.1 steht für Bereich 3 (Dienste & Projekte), Kapitel 1 (JTL), Seite 1 (SQL Server & JTL Wawi).
documentation
network
security
projects
code
references
archive
images
docs.json
index.mdx
Neue Seiten werden zusätzlich in der Navigation in docs.json eingetragen, sonst erscheinen sie nicht im Menü.

​
Seitenstatus

Der Status einer Seite steht als Badge am Seitenanfang. Seiten ohne Hinweis sind aktuell und geprüft.
Veraltete Seiten werden nicht gelöscht, sondern als Veraltet oder Archiv markiert. So bleiben frühere Konfigurationen nachvollziehbar.

​
Dokumentation pflegen

Diese Dokumentation ist nur so wertvoll wie ihre Aktualität. Änderungen laufen immer über das Repository:
1

Änderung vorbereiten

Die Änderung entsteht auf einem eigenen Branch, nie direkt auf main.
2

Pull Request prüfen

Im Pull Request ist genau sichtbar, was sich ändert, bevor etwas veröffentlicht wird.
3

Mergen und veröffentlichen

Mit dem Merge auf main wird die Dokumentation automatisch veröffentlicht.

​
Was bei Änderungen zu tun ist