> ## Documentation Index
> Fetch the complete documentation index at: https://homelab.amylify.de/llms.txt
> Use this file to discover all available pages before exploring further.

# Astrellium

> A Cybersecurity Homelab Experience

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.

> [!NOTE]
>
> Jede Konfiguration, jede IP-Adresse, jede VM und jeder Dienst wird hier dokumentiert, bevor oder unmittelbar nachdem sie in Betrieb genommen werden.

***

## Bereiche

> [card] [Netzwerk](https://homelab.amylify.de/documentation/network/network-uebersicht.md)
>
> Physisches und virtuelles Netzwerk, Adressplan und Topologie.

> [card] [Sicherheit](https://homelab.amylify.de/documentation/security/security-uebersicht.md)
>
> Firewalls, Penetration-Testing und Vulnerable Clients.

> [card] [Dienste & Projekte](https://homelab.amylify.de/documentation/projects/projects-uebersicht.md)
>
> Selbst gehostete Dienste und Projekte, z. B. SQL Server und JTL Wawi.

> [card] [Code](https://homelab.amylify.de/documentation/code/code-uebersicht.md)
>
> Skripte und Programmierung rund um das Homelab.

> [card] [Referenzen](https://homelab.amylify.de/documentation/references/references-uebersicht.md)
>
> Befehle, Ports, Quellen und fertige Vorlagen zum Nachschlagen.

> [card] [Archiv](https://homelab.amylify.de/documentation/archive/archive-uebersicht.md)
>
> Außer Betrieb genommene Dienste und veraltete Seiten.

***

## Grundprinzipien

Drei verbindliche Regeln gelten für jede Seite:

> [card] Aktualität vor Vollständigkeit
>
> Eine veraltete Dokumentation ist gefährlicher als eine unvollständige. Änderungen werden sofort eingetragen, unfertige Seiten als Entwurf gekennzeichnet.

> [card] Eine Quelle, keine Duplikate
>
> IP-Adressen, Hostnamen und Ports stehen nur an **einer** Stelle. Alle anderen Seiten verweisen darauf.

> [card] Keine Zugangsdaten
>
> Passwörter, Schlüssel und Tokens werden nie gespeichert. Vermerkt wird nur, in welchem Passwortmanager der Eintrag liegt.

> [!WARNING]
>
> 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.

| Bereich | Nummernkreis | Übersichtsseite |
| :- | :- | :- |
| [Netzwerk](https://homelab.amylify.de/documentation/network/network-uebersicht.md) | `1.x.x` | 1.0.0 |
| [Sicherheit](https://homelab.amylify.de/documentation/security/security-uebersicht.md) | `2.x.x` | 2.0.0 |
| [Dienste & Projekte](https://homelab.amylify.de/documentation/projects/projects-uebersicht.md) | `3.x.x` | 3.0.0 |
| [Code](https://homelab.amylify.de/documentation/code/code-uebersicht.md) | `4.x.x` | 4.0.0 |
| [Referenzen](https://homelab.amylify.de/documentation/references/references-uebersicht.md) | `5.x.x` | 5.0.0 |
| [Archiv](https://homelab.amylify.de/documentation/archive/archive-uebersicht.md) | nicht nummeriert | Übersicht |

Ein Beispiel: `3.1.1` steht für Bereich 3 (Dienste & Projekte), Kapitel 1 (JTL), Seite 1 (SQL Server & JTL Wawi).

> [accordion] Ordnerstruktur im Repository
>
> **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.

| Status | Bedeutung |
| :- | :- |
| Entwurf | Seite ist in Bearbeitung, Inhalt unvollständig |
| Veraltet | Seite entspricht nicht mehr dem aktuellen Stand |
| Archiv | Dienst oder Komponente wurde deaktiviert, Seite bleibt zur Referenz |

> [!NOTE]
>
> 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

| Ereignis | Aktion |
| :- | :- |
| **Neue IP-Adresse vergeben** | Sofort im [physischen](https://homelab.amylify.de/documentation/network/physical-network.md) oder [virtuellen Netzwerk](https://homelab.amylify.de/documentation/network/virtual-network.md) eintragen |
| **Neue VM oder neuer Container** | Eintrag im [virtuellen Netzwerk](https://homelab.amylify.de/documentation/network/virtual-network.md) |
| **Dienst konfiguriert oder geändert** | Zugehörige Seite aktualisieren und die Änderungshistorie ergänzen |
| **Dienst deaktiviert** | Status auf Archiv setzen, nicht löschen |
| **Monatlicher Review** | Alle aktiven Seiten auf Korrektheit prüfen |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.