diff --git a/README.md b/README.md index e00fbfa..74252f0 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,31 @@ -# KMU Server Infrastructure +# KMU Server Infrastructure (On-Premise) Dieses Repository verwaltet die komplette Infrastruktur-Konfiguration und -Dokumentation für die KMU-Organisation. +Dieses Muster geht davon aus, dass ein **Headless-Server**, also ein (Mini-)PC ohne eigenen Bildschirm, Tastatur und Maus, in einem +*Home-Office-LAN* betrieben wird. Dies ist die zentrale Stütze für das **Unternehmen** (***KMU*** - **K**leine und **M**ittlere **U**nternehmen), das seinen Betrieb weitestgehend **autark** +und **On-Premise** betreibt. + +Weil es so gut passt, nutzen wir den Namen ***KMU***, bei den Namen in unserem Muster-Aufbau. + +Lediglich der unvermeidbare **Internet-Anschluss** schafft Abhängigkeit vom *Internet Service Provider* (**ISP**) und es wird üblicherweise +ein Router als Zugangspunkt verwendet. + +In den Mustern gehen wir von einer **AVM Fritz!Box** aus, die wir für den Übergang zum Internet nutzen. + +``` +⚠️ Wir sind im Aufbau. Also, ist diese Arbeit im Moment noch nicht als abgeschlossen zu betrachten. 🔄 +``` + ## 📋 Übersicht Das `server-infra` Repository dient als zentrale Verwaltungseinheit für: -- Server-Konfigurationsdateien -- Automatisierungs- und Deployment-Skripte -- Infrastruktur-Dokumentation -- Service-Konfigurationen -- Systemd-Units und Service-Definitionen + +* Server-Konfigurationsdateien +* Automatisierungs- und Deployment-Skripte +* Infrastruktur-Dokumentation +* Service-Konfigurationen +* Systemd-Units und Service-Definitionen ## 🏗️ Repository-Struktur @@ -28,7 +44,8 @@ server-infra/ │ └── maintenance/ # Wartungs-Skripte ├── configs/ # Service-Konfigurationen │ ├── gitea/ # Gitea-Konfiguration -│ ├── nginx/ # Nginx-Konfiguration +│ ├── caddy/ # Caddy-Konfiguration +│ ├── nginx/ # Nginx-Konfiguration (optional|alternativ) │ ├── postgresql/ # PostgreSQL-Konfiguration │ └── ssl/ # SSL/TLS-Zertifikate (ohne Private Keys) ├── systemd/ # Systemd-Service-Units @@ -43,35 +60,40 @@ server-infra/ ## 🚀 Erste Schritte ### 1. Repository klonen + ```bash git clone https://git.gitcover.de/KMU/server-infra.git cd server-infra ``` ### 2. Dokumentation lesen + Beginnen Sie mit der Dokumentation im `docs/` Verzeichnis: -- **architecture.md**: System-Übersicht und Komponenten -- **installation.md**: Schritt-für-Schritt Installationsanleitung -- **maintenance.md**: Wartungs- und Update-Prozeduren + +* **architecture.md**: System-Übersicht und Komponenten +* **installation.md**: Schritt-für-Schritt Installationsanleitung +* **maintenance.md**: Wartungs- und Update-Prozeduren ### 3. Skripte verwenden + Alle Automatisierungs-Skripte befinden sich im `scripts/` Verzeichnis und sind nach Kategorien organisiert. ## 🔧 Server-Spezifikationen -- **Betriebssystem**: Ubuntu Server LTS (neueste Version) -- **Git-Server**: Gitea -- **Webserver**: Nginx -- **Datenbank**: PostgreSQL -- **Backup-Strategie**: Automatisierte tägliche Backups +* **Betriebssystem**: Ubuntu Server LTS (neueste Version) +* **Git-Server**: Gitea +* **Webserver**: Nginx +* **Datenbank**: PostgreSQL +* **Backup-Strategie**: Automatisierte tägliche Backups ## ⚠️ Sicherheitshinweise **WICHTIG**: Dieses Repository enthält KEINE sensiblen Daten wie: -- Private SSH-Schlüssel -- Passwörter oder API-Keys -- Private SSL-Zertifikate -- Datenbank-Credentials + +* Private SSH-Schlüssel +* Passwörter oder API-Keys +* Private SSL-Zertifikate +* Datenbank-Credentials Sensible Daten werden über Umgebungsvariablen oder externe Secret-Management-Systeme verwaltet. @@ -87,11 +109,13 @@ Sensible Daten werden über Umgebungsvariablen oder externe Secret-Management-Sy ## 🔄 Workflow und Versionierung ### Branch-Strategie -- **main**: Produktive Konfiguration (nur getestete Änderungen) -- **development**: Entwicklungs- und Test-Konfigurationen -- **feature/[name]**: Feature-Branches für größere Änderungen + +* **main**: Produktive Konfiguration (nur getestete Änderungen) +* **development**: Entwicklungs- und Test-Konfigurationen +* **feature/\[name]**: Feature-Branches für größere Änderungen ### Commit-Konventionen + ``` [Typ]: Kurze Beschreibung @@ -112,9 +136,9 @@ Typen: ## 📞 Kontakt und Support -- **Repository**: https://git.gitcover.de/KMU/server-infra -- **Organisation**: KMU -- **Maintainer**: [Ihr Name] +* **Repository**: https://git.gitcover.de/KMU/server-infra +* **Organisation**: KMU +* **Maintainer**: \[Ihr Name] ## 📄 Lizenz @@ -124,4 +148,5 @@ Nicht für externe Verwendung bestimmt. --- **Letzte Aktualisierung**: $(date +"%Y-%m-%d") -**Version**: 1.0.0 \ No newline at end of file +**Version**: 0.1.0 +